Difference between revisions of "Unit SMTP"

From Ultibo.org
Jump to: navigation, search
Line 385: Line 385:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''SMTP buffer'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TSMTPBuffer = class(TObject)</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(ASize:LongWord);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>destructor Destroy; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FLock:TCriticalSectionHandle;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FData:Pointer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FSize:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FStart:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AcquireLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ReleaseLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Count:LongWord read GetCount;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function ReadData:Char;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function WriteData(AChar:Char):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function WriteLock(var ASize:LongWord):Pointer;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function WriteUnlock(ACount:LongWord):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''SMTP client'''
 +
 
 +
<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%;"|&nbsp;
 +
|-
 +
| <code>destructor Destroy; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FOnRequest:TSMTPClientNotifyEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnReply:TSMTPClientNotifyEvent;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FOnRequestStart:TNotifyEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnRequestEnd:TNotifyEvent;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FAuthenticated:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <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>
 +
| &nbsp;
 +
|-
 +
| <code>function SendRequest(const ARequest:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property OnRequest:TSMTPClientNotifyEvent read FOnRequest write FOnRequest;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnReply:TSMTPClientNotifyEvent read FOnReply write FOnReply;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property OnRequestStart:TNotifyEvent read FOnRequestStart write FOnRequestStart;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnRequestEnd:TNotifyEvent read FOnRequestEnd write FOnRequestEnd;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property Authenticated:Boolean read FAuthenticated;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Buffer:TSMTPBuffer read FBuffer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function DoConn(const AHost,APort:String; var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoHelo(const AHost:String; var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoEhlo(const AHost:String; var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoAuth(const AProtocol,AUsername,APassword:String; var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoMail(const ASender:String; var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoRcpt(const AReceiver:String; var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoVrfy(const AAddress:String; var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoBeginData(var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoSendData(const AData:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoEndData(var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoQuit(var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoRset(var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoTime(var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoNoop(var AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
 
 +
'''SMTP connection'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TSMTPConnection = class(TListObject)</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%;"|&nbsp;
 +
|-
 +
| <code>destructor Destroy; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FLock:TCriticalSectionHandle;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FHandle:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FRxByteCount:Int64;</code>
 +
| Bytes Recv Count from Connection
 +
|-
 +
| <code>FTxByteCount:Int64;</code>
 +
| Bytes Sent Count to Connection
 +
|-
 +
| <code>FRequestCount:Int64;</code>
 +
| Requests Recv Count from Connection
 +
|-
 +
| <code>FReplyCount:Int64;</code>
 +
| Replies Sent Count to Connection
 +
|-
 +
| <code>FRequestTime:TDateTime;</code>
 +
| Last Request Time
 +
|-
 +
| <code>FReplyTime:TDateTime;</code>
 +
| Last Reply Time
 +
|-
 +
| <code>FRemoteAddress:String;</code>
 +
| Address of Remote Client
 +
|-
 +
| <code>FStatus:LongWord;</code>
 +
| None,Conn,Auth,Helo,Mail,Rcpt,Data etc
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FAuthenticated:Boolean;</code>
 +
| Current authentication state
 +
|-
 +
| <code>FUsername:String;</code>
 +
| Current Username
 +
|-
 +
| <code>FPassword:String;</code>
 +
| Current Password
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FThread:TThread;</code>
 +
| TWinsock2TCPServerThread
 +
|-
 +
| <code>FBuffer:TSMTPBuffer;</code>
 +
| Buffer for received data
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function AcquireLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function ReleaseLock:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetHandle(AHandle:LongWord);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetRxByteCount:Int64;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetRxByteCount(const ARxByteCount:Int64);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetTxByteCount:Int64;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetTxByteCount(const ATxByteCount:Int64);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetRequestCount:Int64;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetRequestCount(const ARequestCount:Int64);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetReplyCount:Int64;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetReplyCount(const AReplyCount:Int64);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetRequestTime:TDateTime;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetRequestTime(const ARequestTime:TDateTime);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetReplyTime:TDateTime;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetReplyTime(const AReplyTime:TDateTime);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetRemoteAddress:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetRemoteAddress(const ARemoteAddress:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetStatus(AStatus:LongWord);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetAuthenticated(AAuthenticated:Boolean);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetUsername:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetUsername(const AUsername:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetPassword:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure SetPassword(const APassword:String);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure SetThread(AThread:TThread);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property Handle:LongWord read FHandle write SetHandle;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property RxByteCount:Int64 read GetRxByteCount write SetRxByteCount;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property TxByteCount:Int64 read GetTxByteCount write SetTxByteCount;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property RequestCount:Int64 read GetRequestCount write SetRequestCount;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property ReplyCount:Int64 read GetReplyCount write SetReplyCount;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property RequestTime:TDateTime read GetRequestTime write SetRequestTime;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property ReplyTime:TDateTime read GetReplyTime write SetReplyTime;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property RemoteAddress:String read GetRemoteAddress write SetRemoteAddress;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Status:LongWord read FStatus write SetStatus;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property Authenticated:Boolean read FAuthenticated write SetAuthenticated;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Username:String read GetUsername write SetUsername;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Password:String read GetPassword write SetPassword;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property Thread:TThread read FThread  write SetThread;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Buffer:TSMTPBuffer read FBuffer;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure IncrementRxByteCount(const ARxByteCount:Int64);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure IncrementTxByteCount(const ATxByteCount:Int64);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure IncrementRequestCount;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure IncrementReplyCount;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''SMTP listener'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TSMTPListener = class(TWinsock2TCPListener)</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%;"|&nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
 +
|-
 +
| <code>FOnConnected:TSMTPConnectionEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnDisconnected:TSMTPConnectionEvent;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FOnCheckHost:TSMTPHostEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnCheckCount:TSMTPCountEvent;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FOnRequest:TSMTPNotifyEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnReply:TSMTPNotifyEvent;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>FOnConn:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnHelo:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnEhlo:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnAuth:TSMTPAuthenticateEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnMail:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnRcpt:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnVrfy:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnBeginData:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnData:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnEndData:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnQuit:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnRset:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnTime:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FOnNoop:TSMTPRequestEvent;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
 +
|-
 +
| <code>procedure DoConnect(AThread:TWinsock2TCPServerThread); override;</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoDisconnect(AThread:TWinsock2TCPServerThread); override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function DoCheckHost(AThread:TWinsock2TCPServerThread):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function DoCheckCount(AThread:TWinsock2TCPServerThread):Boolean; virtual;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function DoExecute(AThread:TWinsock2TCPServerThread):Boolean; override;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>procedure DoConn(AThread:TWinsock2TCPServerThread);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoHelo(AThread:TWinsock2TCPServerThread; const AHost:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoEhlo(AThread:TWinsock2TCPServerThread; const AHost:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoAuth(AThread:TWinsock2TCPServerThread; const AParams:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoMail(AThread:TWinsock2TCPServerThread; const ASender:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoRcpt(AThread:TWinsock2TCPServerThread; const ARecipient:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoVrfy(AThread:TWinsock2TCPServerThread; const AAddress:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoBeginData(AThread:TWinsock2TCPServerThread);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoData(AThread:TWinsock2TCPServerThread; const AData:String);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoEndData(AThread:TWinsock2TCPServerThread);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoQuit(AThread:TWinsock2TCPServerThread);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoRset(AThread:TWinsock2TCPServerThread);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoTime(AThread:TWinsock2TCPServerThread);</code>
 +
| &nbsp;
 +
|-
 +
| <code>procedure DoNoop(AThread:TWinsock2TCPServerThread);</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetRequest(AThread:TWinsock2TCPServerThread;var ARequest:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function SendReply(AThread:TWinsock2TCPServerThread;const AReply:String):Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
 +
|-
 +
| <code>property OnConnected:TSMTPConnectionEvent read FOnConnected write FOnConnected;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnDisconnected:TSMTPConnectionEvent read FOnDisconnected write FOnDisconnected;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property OnCheckHost:TSMTPHostEvent read FOnCheckHost write FOnCheckHost;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnCheckCount:TSMTPCountEvent read FOnCheckCount write FOnCheckCount;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property OnRequest:TSMTPNotifyEvent read FOnRequest write FOnRequest;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnReply:TSMTPNotifyEvent read FOnReply write FOnReply;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property OnConn:TSMTPRequestEvent read FOnConn write FOnConn;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnHelo:TSMTPRequestEvent read FOnHelo write FOnHelo;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnEhlo:TSMTPRequestEvent read FOnEhlo write FOnEhlo;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnAuth:TSMTPAuthenticateEvent read FOnAuth write FOnAuth;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnMail:TSMTPRequestEvent read FOnMail write FOnMail;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnRcpt:TSMTPRequestEvent read FOnRcpt write FOnRcpt;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnVrfy:TSMTPRequestEvent read FOnVrfy write FOnVrfy;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnBeginData:TSMTPRequestEvent read FOnBeginData write FOnBeginData;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnData:TSMTPRequestEvent read FOnData write FOnData;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnEndData:TSMTPRequestEvent read FOnEndData write FOnEndData;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnQuit:TSMTPRequestEvent read FOnQuit write FOnQuit;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnRset:TSMTPRequestEvent read FOnRset write FOnRset;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnTime:TSMTPRequestEvent read FOnTime write FOnTime;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property OnNoop:TSMTPRequestEvent read FOnNoop write FOnNoop;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 06:24, 21 March 2017

Return to Unit Reference


Description

Ultibo SMTP interface unit

To be documented

Constants


[Expand]
SMTP specific constants SMTP_*


[Expand]
SMTP status constants SMTP_STATUS_*


[Expand]
SMTP command constants SMTP_COMMAND_*


[Expand]
SMTP sub command constants SMTP_SUB_COMMAND_*


[Expand]
SMTP string constants SMTP_STRING_*


[Expand]
SMTP logging constants SMTP_LOG_*


Type definitions


SMTP client notify event

TSMTPClientNotifyEvent = procedure(const ARequest:String) of Object;

SMTP host event

TSMTPHostEvent = function(AConnection:TSMTPConnection):Boolean of Object;

SMTP count event

TSMTPCountEvent = function(AConnection:TSMTPConnection):Boolean of Object;

SMTP notify event

TSMTPNotifyEvent = procedure(AConnection:TSMTPConnection; const ARequest:String) of Object;

SMTP request event

TSMTPRequestEvent = function(AConnection:TSMTPConnection; const ARequest:String; var AReply:String):Boolean of Object;

SMTP authenticate event

TSMTPAuthenticateEvent = function(AConnection:TSMTPConnection; const AMethod,AUsername,APassword:String; var AReply:String):Boolean of Object;

SMTP connection event

TSMTPConnectionEvent = procedure(AConnection:TSMTPConnection) of Object;


Class definitions


SMTP buffer

[Expand]

TSMTPBuffer = class(TObject)

SMTP client

[Expand]

TSMTPClient = class(TWinsock2TCPClient)

SMTP connection

[Expand]

TSMTPConnection = class(TListObject)

SMTP listener

[Expand]

TSMTPListener = class(TWinsock2TCPListener)


Public variables


SMTP logging

SMTP_DEFAULT_LOG_LEVEL:LongWord = SMTP_LOG_LEVEL_DEBUG; Minimum level for SMTP messages. Only messages with level greater than or equal to this will be printed.
SMTP_LOG_ENABLED:Boolean;


Function declarations


Initialization functions

[Expand] 
procedure SMTPInit;
Description: To be documented


SMTP helper functions

[Expand] 
procedure SMTPLog(Level:LongWord; const AText:String);
Description: To be documented


[Expand] 
procedure SMTPLogInfo(const AText:String);
Description: To be documented


[Expand] 
procedure SMTPLogError(const AText:String);
Description: To be documented


[Expand] 
procedure SMTPLogDebug(const AText:String);
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_SMTP&oldid=2637"