TSMTPClient - Revision history

Ultibo: Created page with "Return to Unit SMTP TOC === Description === ---- ''To be documented'' === Class definitions === ----

2018-05-29T06:40:32Z

Created page with "Return to Unit SMTP TOC === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collapse..."

New page
Return to [[Unit_SMTP|Unit SMTP]]

TOC

=== Description ===
----

''To be documented''

=== Class definitions ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TSMTPClient = class(TWinsock2TCPClient)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>constructor Create;</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FOnRequest:TSMTPClientNotifyEvent;</code>
|  
|-
| <code>FOnReply:TSMTPClientNotifyEvent;</code>
|  
|-
|colspan="2"| 
|-
| <code>FOnRequestStart:TNotifyEvent;</code>
|  
|-
| <code>FOnRequestEnd:TNotifyEvent;</code>
|  
|-
|colspan="2"| 
|-
| <code>FAuthenticated:Boolean;</code>
|  
|-
| <code>FBuffer:TSMTPBuffer;</code>
| Buffer for received data
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>function GetReply(var AReply:String):Boolean;</code>
|  
|-
| <code>function SendRequest(const ARequest:String):Boolean;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property OnRequest:TSMTPClientNotifyEvent read FOnRequest write FOnRequest;</code>
|  
|-
| <code>property OnReply:TSMTPClientNotifyEvent read FOnReply write FOnReply;</code>
|  
|-
|colspan="2"| 
|-
| <code>property OnRequestStart:TNotifyEvent read FOnRequestStart write FOnRequestStart;</code>
|  
|-
| <code>property OnRequestEnd:TNotifyEvent read FOnRequestEnd write FOnRequestEnd;</code>
|  
|-
|colspan="2"| 
|-
| <code>property Authenticated:Boolean read FAuthenticated;</code>
|  
|-
| <code>property Buffer:TSMTPBuffer read FBuffer;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DoConn(const AHost,APort:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoHelo(const AHost:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoEhlo(const AHost:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoAuth(const AProtocol,AUsername,APassword:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoMail(const ASender:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoRcpt(const AReceiver:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoVrfy(const AAddress:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoBeginData(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoSendData(const AData:String):Boolean;</code>
|  
|-
| <code>function DoEndData(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoQuit(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoRset(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoTime(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoNoop(var AReply:String):Boolean;</code>
|  
|-
|}
</div></div>
<br />

=== Function declarations ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">constructor TSMTPClient.Create;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">destructor TSMTPClient.Destroy;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.GetReply(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.SendRequest(const ARequest:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoConn(const AHost,APort:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 220 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoHelo(const AHost:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoEhlo(const AHost:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoAuth(const AProtocol,AUsername,APassword:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 235 for success and other for failure (334 for challenge during handshake)
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoMail(const ASender:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoRcpt(const AReceiver:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoVrfy(const AAddress:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoBeginData(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 354 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoSendData(const AData:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will not return anything while until data end
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoEndData(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoQuit(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 221 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoRset(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoTime(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TSMTPClient.DoNoop(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| SMTP server will normally return 250 for success and other for failure
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]