TSmtpCli

Main page -> ICS component reference -> TSmtpCli

Overview

• unit (OverbyteIcs)SmtpProt.pas
• 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 methods are non-blocking, a synchronously working counterpart is also available, see TSyncSmtpCli.

What's new in TSmtpCli V7?

Properties

Allow8BitChars		If set to FALSE enables internal encoding of header lines and MailMessage text
AuthType		Authentication type to be used with method Auth
AuthTypesSupported		A list of authentication types supported by the server available after SMTP command EHLO returned
CharSet		Character set of the mail message, default value is the preferred MIME name of current system charset
CodePage		The Windows code page identifier mapped to value of property CharSet (V7)
ConfirmReceipt		Request confirmation of receipt
Connected		Are we connected to the mail server?
ContentType		Either HTML or plain text (smtpHtml or smtpPlainText)
ConvertToCharset		Allow charset conversion (ignored by UNICODE compilers, new in V7)
CtrlSocket		The underlying instance of TWSocket handles the connection and raw data exchange.
DefaultEncoding		Default Transfer-Encoding
EmailFiles		List of files to be attached
ErrorMessage		Last SMTP error message
FoldHeaders		Fold header lines if their length exceed the limit
FromName		E-mail address 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		Interface to be bound to the socket, defaults to "0.0.0.0" = any interface
MailMessage		The mail message text.
MaxMessageSize		Indicates the maximum message size accepted by the server (V7)
MessageID		A unique ID created for each mail message, appears as mail header line (Message-ID)
MessageSize		Size of the e-mail (V7)
OwnHeaders		Set OwnHeaders to True in order to send your own, custom header lines.
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
SizeSupported		Indicates whether the server supports the RFC-1870 SIZE extension (V7)
State		Current component state
Username		SMTP login username
WrapMessageText		Tries to insert line breaks in unencoded MailMessage text if line length exceed value of property WrapMsgMaxLineLen
WrapMsgMaxLineLen		MailMessage maximum line length (V7)

Methods

Abort		Cancels any transactions in progress, closes server connection.
Auth		Sends SMTP command AUTH starting the authentication process.
CalcMsgSize		Calculates message size (V7)
CalcMsgSizeSync		Calculates message size synchronously (V7)
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
Mail		Executes methods MailFrom, RcptTo, and Data consecutively.
MailFrom		Sends SMTP command MAIL
MailFromSIZE		Same as MailFrom however appends the message size as argument (V7)
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		Triggered after the attempt to open a file to be attached.
OnAttachContentType		Triggered before the content-type header line of an attachment part header is formed.
OnAttachHeader		Triggered after all header lines of an attachment part header have been formed.
OnBeforeFileOpen		Triggered before the attempt to open a file to be attached.
OnCommand		Triggered on every command that is sent.
OnDisplay		Triggered on every command/response. Useful for debugging purposes.
OnGetData		Triggered when the component requests next data line, useful for sending custom data.
OnHeaderLine		Triggered on each mail header line.
OnMessageDataSent		Triggered whenever message data have been sent (V7).
OnProcessHeader		Triggered before the mail header lines are formed.
OnRcptToError		Triggered when one of the recipients are i.e. rejected by server for some reason.
OnRequestDone		Triggered when a request is completed.
OnResponse		Triggered on server's response.
OnSessionClosed		Triggered when the connection has been closed.
OnSessionConnected		Triggered when a connection has been established.

How to

question

See also

• What's new in TSmtpCli V7

---

ICS Components Reference