TSmtpCli
Main page -> ICS component reference -> TSmtpCli
Contents
Overview
- unit SmtpProt
- inheritance TCustomSmtpCli->TSmtpCli
Component TSmtpCli implements client-side of the Simple Mail Transfer Protocol as specified in RFC 2821, and MIME message format according to RFC 1521 and 2045. Currently supported SMTP Service Extensions for Authentication are AUTH LOGIN, AUTH PLAIN, AUTH CRAM-MD5 and AUTH CRAM-SHA1 (RFC 2554 as well as RFC 1734). The TSmtpCli is working non-blocking, a synchronously working counterpart is also available, see TSyncSmtpCli.
Properties
| AuthType | Authentication methode to be used with method Auth | |
| AuthTypesSupported | A list of authentication methods supported by the server available after SMTP command EHLO returned | |
| CharSet | The Character set, default value iso-8859-1 | |
| ConfirmReceipt | Request confirmation of receipt | |
| Connected | Are we connected to the mail server? | |
| ContentType | Either HTML or plain text (smtpHtml or smtpPlainText) | |
| CtrlSocket | The underlying instance of TWSocket handles the connection and raw data exchange. | |
| EmailFiles | File attachments | |
| ErrorMessage | Last SMTP error message | |
| FromName | E-mail address to be sent to the mail server with SMTP command MAIL | |
| Handle | Handle of the hidden window used internally by the component | |
| HdrCc | Value of mail header line CC | |
| HdrFrom | Value of mail header line From | |
| HdrPriority | Mail priority (creates a custom mail header line). | |
| HdrReplyTo | Value of mail header line Reply-To | |
| HdrReturnPath | Value of mail header line Return-Path | |
| HdrSender | Value of mail header line Sender | |
| HdrSubject | Value of mail header line Subject | |
| HdrTo | Value of mail header line To | |
| Host | Host name or IP Address of the SMTP server | |
| LastResponse | Last response from the mail server. | |
| LocalAddr | ||
| MailMessage | The mail message. | |
| MessageID | A unique ID created for each mail message, appears as mail header line (Message-ID) | |
| OwnHeaders | Set OwnHeaders to True in order to build your own, custom headers. | |
| Password | SMTP login password | |
| Port | Port number of the SMTP server, defaults to 25 | |
| RcptName | E-mail address to be sent to the mail server with SMTP command RCPT | |
| RequestType | Current request type | |
| ShareMode | ShareMode of the stream (file attachments). | |
| SignOn | Parameter sent with the SMTP commands HELO and EHLO | |
| State | Current component state | |
| Username | SMTP login username |
Methods
| Abort | Cancels any transactions in progress, closes server connection. | |
| Auth | Sends SMTP command AUTH starting the authentication process. | |
| Connect | Connects to the mail server. | |
| Create | Constructor | |
| Data | Sends SMTP command DATA. | |
| Destroy | Destructor | |
| Ehlo | Sends SMTP command EHLO. | |
| Helo | Sends SMTP command HELO. | |
| HighLevelAsync | Execute multiple commands consecutively | |
| Executes methods MailFrom, RcptTo, and Data consecutively. | ||
| MailFrom | Sends SMTP command MAIL | |
| Open | Executes methods Connect, Ehlo, and Auth consecutively. | |
| Quit | Sends SMTP command QUIT | |
| RcptNameAdd | Assigns recipients to the various recipient lists. | |
| RcptTo | Sends SMTP command RCPT, for each recipient in the lists. | |
| Rset | Sends SMTP command RSET. | |
| ThreadAttach | Attaches the component to current thread context. | |
| ThreadDetach | Detaches the component from current thread context. | |
| Vrfy | Sends SMTP command VRFY. |
Events
| OnAfterFileOpen | Align test | |
| OnAttachContentType | ||
| OnAttachHeader | ||
| OnBeforeFileOpen | ||
| OnCommand | ||
| OnDisplay | Triggered for every command/response. Is very useful to output for debug-purposes. | |
| OnGetData | ||
| OnHeaderLine | ||
| OnProcessHeader | ||
| OnRcptToError | ||
| OnRequestDone | Triggered when a request is completed. | |
| OnResponse | ||
| OnSessionClosed | ||
| OnSessionConnected |
How to
