Difference between revisions of "Unit SMTP"

From Ultibo.org
Jump to: navigation, search
 
(10 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
−
''To be documented''
+
'''Ultibo SMTP Interface unit'''
  
 
=== Constants ===
 
=== Constants ===
Line 28: Line 28:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
−
<div style="font-size: 14px; padding-left: 12px;">'''SMTP status constants''' <code> SMTP_STATUS_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''SMTP status''' <code> SMTP_STATUS_* </code></div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 65: Line 65:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
−
<div style="font-size: 14px; padding-left: 12px;">'''SMTP command constants''' <code> SMTP_COMMAND_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''SMTP command''' <code> SMTP_COMMAND_* </code></div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 109: Line 109:
 
<br />  
 
<br />  
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
−
<div style="font-size: 14px; padding-left: 12px;">'''SMTP sub command constants''' <code> SMTP_SUB_COMMAND_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''SMTP sub command''' <code> SMTP_SUB_COMMAND_* </code></div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 123: Line 123:
 
<br />  
 
<br />  
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
−
<div style="font-size: 14px; padding-left: 12px;">'''SMTP string constants''' <code> SMTP_STRING_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''SMTP string''' <code> SMTP_STRING_* </code></div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 292: Line 292:
 
<br />  
 
<br />  
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
−
<div style="font-size: 14px; padding-left: 12px;">'''SMTP logging constants''' <code> SMTP_LOG_* </code></div>
+
<div style="font-size: 14px; padding-left: 12px;">'''SMTP logging''' <code> SMTP_LOG_* </code></div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 300: Line 300:
 
|-
 
|-
 
| <code>SMTP_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| <code>SMTP_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
−
| SMTP informational messages,
+
| SMTP informational messages
 +
|-
 +
| <code>SMTP_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code>
 +
| SMTP warning messages
 
|-
 
|-
 
| <code>SMTP_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 
| <code>SMTP_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
Line 315: Line 318:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''SMTP client notify event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSMTPClientNotifyEvent = procedure(const ARequest:String) of Object;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''SMTP host event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSMTPHostEvent = function(AConnection:TSMTPConnection):Boolean of Object;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''SMTP count event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSMTPCountEvent = function(AConnection:TSMTPConnection):Boolean of Object;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''SMTP notify event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSMTPNotifyEvent = procedure(AConnection:TSMTPConnection; const ARequest:String) of Object;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''SMTP request event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSMTPRequestEvent = function(AConnection:TSMTPConnection; const ARequest:String; var AReply:String):Boolean of Object;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''SMTP authenticate event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSMTPAuthenticateEvent = function(AConnection:TSMTPConnection; const AMethod,AUsername,APassword:String; var AReply:String):Boolean of Object;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''SMTP connection event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSMTPConnectionEvent = procedure(AConnection:TSMTPConnection) of Object; </code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
<br />
 +
 
 +
=== Class definitions ===
 +
----
 +
 
 +
 
 +
'''SMTP helper classes'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TSMTPBuffer|<code>TSMTPBuffer = class(TObject)</code>]]
 +
|-
 +
|}
 +
 
 +
'''SMTP client classes'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TSMTPClient|<code>TSMTPClient = class(TWinsock2TCPClient)</code>]]
 +
|-
 +
|}
 +
 
 +
'''SMTP server classes'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TSMTPConnection|<code>TSMTPConnection = class(TListObject)</code>]]
 +
|-
 +
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TSMTPListener|<code>TSMTPListener = class(TWinsock2TCPListener)</code>]]
 +
|-
 +
|}
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===
 
----
 
----
  
−
''To be documented''
+
 
 +
'''SMTP logging'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>SMTP_DEFAULT_LOG_LEVEL:LongWord = SMTP_LOG_LEVEL_DEBUG;</code>
 +
| style="width: 40%;"|Minimum level for SMTP messages. Only messages with level greater than or equal to this will be printed.
 +
|-
 +
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>SMTP_LOG_ENABLED:Boolean;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
<br />
  
 
=== Function declarations ===
 
=== Function declarations ===
Line 334: Line 449:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 349: Line 464:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! 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;">procedure SMTPLogInfo(const AText:String); inline;</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
 
| None documented
 
|-
 
|-
Line 356: Line 483:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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;">procedure SMTPLogInfo(const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure SMTPLogWarn(const AText:String); inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<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;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 368: Line 495:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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;">procedure SMTPLogError(const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure SMTPLogError(const AText:String); inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<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;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 380: Line 507:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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;">procedure SMTPLogDebug(const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure SMTPLogDebug(const AText:String); inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<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;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-

Latest revision as of 05:31, 31 August 2021

Return to Unit Reference


Description

Ultibo SMTP Interface unit

Constants


SMTP specific constants SMTP_*
SMTP_LINE_END = Chr(13) + Chr(10); CR LF
 
SMTP_BUFFER_SIZE = SIZE_4K;  


SMTP status SMTP_STATUS_*
SMTP_STATUS_NONE = 0;  
SMTP_STATUS_CONN = 1;  
SMTP_STATUS_HELO = 2;  
SMTP_STATUS_AUTH = 3;  
SMTP_STATUS_MAIL = 4;  
SMTP_STATUS_RCPT = 5;  
SMTP_STATUS_DATA = 6;  
SMTP_STATUS_QUIT = 7;  
 
SMTP_MAX_STATUS = 7;  


SMTP command SMTP_COMMAND_*
SMTP_COMMAND_HELO = 'HELO';  
SMTP_COMMAND_EHLO = 'EHLO';  
SMTP_COMMAND_TIME = 'TIME';  
SMTP_COMMAND_NOOP = 'NOOP';  
SMTP_COMMAND_AUTH = 'AUTH';  
SMTP_COMMAND_MAIL = 'MAIL';  
SMTP_COMMAND_RCPT = 'RCPT';  
SMTP_COMMAND_VRFY = 'VRFY';  
SMTP_COMMAND_BEGIN_DATA = 'DATA';  
SMTP_COMMAND_END_DATA = '.';  
SMTP_COMMAND_RSET = 'RSET';  
SMTP_COMMAND_QUIT = 'QUIT';  


SMTP sub command SMTP_SUB_COMMAND_*
SMTP_SUB_COMMAND_MAIL_FROM = 'FROM:';  
SMTP_SUB_COMMAND_RCPT_TO = 'TO:';  


SMTP string SMTP_STRING_*
SMTP_STRING_CONTINUE = '-';  
 
SMTP_STRING_CONN_SUCCESS = '220 ';  
SMTP_STRING_QUIT_SUCCESS = '221 ';  
SMTP_STRING_HELO_SUCCESS = '250 ';  
SMTP_STRING_EHLO_SUCCESS = '250 ';  
SMTP_STRING_TIME_SUCCESS = '250 ';  
SMTP_STRING_NOOP_SUCCESS = '250 ';  
SMTP_STRING_CONT_SUCCESS = '250-';  
SMTP_STRING_AUTH_SUCCESS = '235 ';  
SMTP_STRING_AUTH_CHALLENGE = '334 ';  
SMTP_STRING_MAIL_SUCCESS = '250 ';  
SMTP_STRING_RCPT_SUCCESS = '250 ';  
SMTP_STRING_VRFY_SUCCESS = '250 ';  
SMTP_STRING_BEGIN_DATA_SUCCESS = '354 ';  
SMTP_STRING_END_DATA_SUCCESS = '250 ';  
SMTP_STRING_RSET_SUCCESS = '250 ';  
 
SMTP_STRING_WRITE_FAILURE = '451 ';  
SMTP_STRING_COMMAND_FAILURE = '500 ';  
SMTP_STRING_SYNTAX_FAILURE = '501 ';  
SMTP_STRING_LOGON_FAILURE = '501 ';  
SMTP_STRING_SEQUENCE_FAILURE = '503 ';  
SMTP_STRING_AUTH_FAILURE = '504 ';  
SMTP_STRING_RCPT_FAILURE = '553 ';  
SMTP_STRING_VRFY_FAILURE = '550 ';  
SMTP_STRING_SIZE_FAILURE = '552 ';  
SMTP_STRING_FORWARD_FAILURE = '551 ';  
SMTP_STRING_PERMISSION_FAILURE = '571 ';  
 
SMTP_STRING_CONN_OK = 'Ultibo SMTP server (version ' + ULTIBO_RELEASE_VERSION + ')';  
SMTP_STRING_HELO_OK = 'Ultibo SMTP server - Hello, ';  
SMTP_STRING_EHLO_HEAD_OK = 'Ultibo SMTP server - Hello ';  
SMTP_STRING_EHLO_TAIL_OK = '; ESMTPs are: ';  
SMTP_STRING_AUTH_OK = 'Authenticated OK';  
SMTP_STRING_MAIL_OK = 'Sender OK - send RCPTs';  
SMTP_STRING_MAIL_SIZE_HEAD_OK = 'Sender and size (';  
SMTP_STRING_MAIL_SIZE_TAIL_OK = ') OK - send RCPTs';  
SMTP_STRING_RCPT_OK = 'Recipient OK - send RCPT or DATA';  
SMTP_STRING_VRFY_OK = 'OK - ';  
SMTP_STRING_BEGIN_DATA_OK = 'OK, send data, end with CRLF.CRLF';  
SMTP_STRING_END_DATA_OK = 'Data received OK';  
SMTP_STRING_RSET_OK = 'Command processed OK';  
SMTP_STRING_QUIT_OK = 'Ultibo SMTP server closing connection';  
SMTP_STRING_TIME_OK = 'Time is ';  
SMTP_STRING_NOOP_OK = 'OK';  
 
SMTP_STRING_BAD_COMMAND = 'Command unrecognized';  
SMTP_STRING_BAD_SYNTAX = 'Bad syntax in command';  
SMTP_STRING_BAD_SEQUENCE = 'Bad sequence of commands';  
SMTP_STRING_BAD_AUTH = 'Unrecognized authentication type';  
SMTP_STRING_BAD_LOGON = 'Authentication failed';  
SMTP_STRING_BAD_MAIL = 'Unknown sender';  
SMTP_STRING_BAD_RCPT = 'Unknown recipient';  
SMTP_STRING_BAD_VRFY = 'Mailbox not found';  


SMTP logging SMTP_LOG_*
SMTP_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG; SMTP debugging messages
SMTP_LOG_LEVEL_INFO = LOG_LEVEL_INFO; SMTP informational messages
SMTP_LOG_LEVEL_WARN = LOG_LEVEL_WARN; SMTP warning messages
SMTP_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR; SMTP error messages
SMTP_LOG_LEVEL_NONE = LOG_LEVEL_NONE; No SMTP messages


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 helper classes

TSMTPBuffer = class(TObject)

SMTP client classes

TSMTPClient = class(TWinsock2TCPClient)

SMTP server classes

TSMTPConnection = class(TListObject)
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 

procedure SMTPInit;
Description: To be documented
Note None documented


SMTP helper functions 

procedure SMTPLog(Level:LongWord; const AText:String);
Description: To be documented
Note None documented 


procedure SMTPLogInfo(const AText:String); inline;
Description: To be documented
Note None documented 


procedure SMTPLogWarn(const AText:String); inline;
Description: To be documented
Note None documented 


procedure SMTPLogError(const AText:String); inline;
Description: To be documented
Note None documented 


procedure SMTPLogDebug(const AText:String); inline;
Description: To be documented
Note None documented


Return to Unit Reference

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