SMTP Component

Properties   Methods   Events   Config Settings   Errors  

The SMTP Component is used to send internet mail using the SMTP protocol (the internet mail standard).

Syntax

TipsSMTP

Remarks

The SMTP Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2487). When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The SMTP Component implements a standard SMTP client as specified in RFC 821. It has a simple plug-and-play interface. It contains a number of properties, such as SendTo, Subject, From, Cc, and BCc, that map directly to the internet mail message headers with the same name (RFC 822). The message text is set in MessageText. Messages are sent by calling the Send method.

The component supports message delivery to multiple recipients through the SendTo, Cc, and BCc properties. Simply specify the destination email addresses separated by commas.

The interface of the component is open-ended. New features, including MIME attachments, can be supported by using the OtherHeaders property.

A number of events provide feedback during the operation of the component. The Transfer event is fired during message delivery to show the number of bytes delivered. The PITrail event traces the commands that are sent to the server and the respective replies.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AllowExtensions Property (SMTP Component)

This property is a switch allowing the component to use ESMTP features (Extended SMTP).

Syntax

property AllowExtensions: Boolean read get_AllowExtensions write set_AllowExtensions;

Default Value

true

Remarks

This property is a switch allowing the component to use ESMTP features (Extended SMTP). If this property is True, the component will first send the EHLO greeting (Extended Hello) to the server and, if that fails, the standard HELO command will be sent.

This property is True by default but may be disabled if it is known in advance that the MailServer does not support SMTP extensions.

This property is not available at design time.

AuthMechanism Property (SMTP Component)

This property is used when connecting to the mail server.

Syntax

property AuthMechanism: TipsTAuthMechanisms read get_AuthMechanism write set_AuthMechanism;

TipsTAuthMechanisms = (
  amUserPassword,
  amCRAMMD5,
  amNTLM,
  amAPOP,
  amSASLPlain,
  amSASLDigestMD5,
  amKerberos,
  amXOAUTH2
);

Default Value

amUserPassword

Remarks

This is the authentication mechanism property to be used when connecting to the mail server.

By default, this property is amUserPassword (0), and if the User and Password properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.

If this property is set to amNTLM (2), NTLM authentication will be used.

If this property is set to amKerberos (6), Kerberos authentication will be used.

Note: This functionality is available only in Windows.

When set to amXOAUTH2 (7), set User to the username and AuthorizationIdentity to the OAuth token. See AuthorizationIdentity for details.

BCc Property (SMTP Component)

This property includes a comma-separated list of addresses for blind carbon copies (optional).

Syntax

property BCc: String read get_BCc write set_BCc;

Default Value

''

Remarks

This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no BCc SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.

The component will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in this property.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Cc Property (SMTP Component)

This property includes a comma-separated list of addresses for carbon copies (optional).

Syntax

property Cc: String read get_Cc write set_Cc;

Default Value

''

Remarks

This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc).

The component will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Connected Property (SMTP Component)

Whether the component is connected.

Syntax

property Connected: Boolean read get_Connected;

Default Value

false

Remarks

This property is used to determine whether or not the component is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

DeliveryNotificationTo Property (SMTP Component)

This property includes the email address to which to send a delivery notification.

Syntax

property DeliveryNotificationTo: String read get_DeliveryNotificationTo write set_DeliveryNotificationTo;

Default Value

''

Remarks

This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.

Firewall Property (SMTP Component)

A set of properties related to firewall access.

Syntax

property Firewall: TipsFirewall read get_Firewall write set_Firewall;

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

From Property (SMTP Component)

This property includes the email address of the sender (required).

Syntax

property From: String read get_From write set_From;

Default Value

''

Remarks

This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Idle Property (SMTP Component)

The current status of the component.

Syntax

property Idle: Boolean read get_Idle;

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Importance Property (SMTP Component)

This property indicates the importance of the mail message (optional).

Syntax

property Importance: TipsTImportances read get_Importance write set_Importance;

TipsTImportances = (
  miUnspecified,
  miHigh,
  miNormal,
  miLow
);

Default Value

miUnspecified

Remarks

This property indicates the importance of the mail message (optional). When set, an Importance header will be added to the message.

Importance is an indication to the recipient(s) about the level of importance of the message. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

LastReply Property (SMTP Component)

This property indicates the last reply received from the server.

Syntax

property LastReply: String read get_LastReply;

Default Value

''

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.

This property is read-only.

LocalHost Property (SMTP Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

property LocalHost: String read get_LocalHost write set_LocalHost;

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

MailPort Property (SMTP Component)

This property includes the server port for SMTP (default 25).

Syntax

property MailPort: Integer read get_MailPort write set_MailPort;

Default Value

25

Remarks

This property contains the server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For an implicit Secure Sockets Layer (SSL), use port 465 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

MailServer Property (SMTP Component)

This property includes the name or address of a mail server (mail relay).

Syntax

property MailServer: String read get_MailServer write set_MailServer;

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or domain name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.

The current version of the component does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (e.g., a UNIX host), but it is preferable to select a MailServer that is close to the machine sending mail.

If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Message Property (SMTP Component)

This property provides a way to set the raw message content.

Syntax

property Message: String read get_Message write set_Message;
property MessageB: TBytes read get_MessageB write set_MessageB;

Default Value

''

Remarks

This property may be set instead of MessageText. This value will not be modified in any way by the component and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.

This property is not available at design time.

MessageDate Property (SMTP Component)

This property includes the date of the mail message (optional).

Syntax

property MessageDate: String read get_MessageDate write set_MessageDate;

Default Value

'*'

Remarks

If this property contains a nonempty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.

Special case: If this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders is computed and the message is sent. This is the default behavior of the component

RFC 822 contains detailed date format specifications. An example of a valid date is 'Fri, 1 Mar 96 21:24:52 EST'.

This property is not available at design time.

MessageHeaders Property (SMTP Component)

This property includes a collection of RFC 822-encoded headers of the message.

Syntax

property MessageHeaders: TipsHeaderList read get_MessageHeaders;

Remarks

This property holds the full headers of the message in RFC 822 format.

This property is read-only and not available at design time.

MessageHeadersString Property (SMTP Component)

This property includes the string representation of RFC 822-encoded headers of the message.

Syntax

property MessageHeadersString: String read get_MessageHeadersString;

Default Value

''

Remarks

This property holds the full headers of the message in RFC 822 format.

This property is read-only.

MessageId Property (SMTP Component)

This property includes the message identifier for the message.

Syntax

property MessageId: String read get_MessageId write set_MessageId;

Default Value

'*'

Remarks

This property contains the message identifier for the message. When set, the value of MessageId is used as the Message-Id header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.

This property is not available at design time.

MessageRecipients Property (SMTP Component)

This property includes the collection of recipients of the message.

Syntax

property MessageRecipients: TipsMessageRecipientList read get_MessageRecipients write set_MessageRecipients;

Remarks

This property contains a collection that describes to whom the message is being sent. You may include all recipients in this property, even Cc's and BCc's, which are specified by the type field.

MessageText Property (SMTP Component)

This property includes the full text of the message to send (without headers).

Syntax

property MessageText: String read get_MessageText write set_MessageText;

Default Value

''

Remarks

This property contains the full text of the message.

The text contained in this property should be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ('#13#10') . The text in the message lines must contain 7-bit characters so that the message can successfully pass through the multitude of mail systems on the Internet.

The component automatically escapes lines that start with a '.' by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.

OtherHeaders Property (SMTP Component)

This property includes an RFC 822-compliant string consisting of extra headers.

Syntax

property OtherHeaders: String read get_OtherHeaders write set_OtherHeaders;

Default Value

''

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, and so on.

The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ('#13#10') .

Use this property with caution. If this property contains invalid headers, message delivery might not be successful.

This property is useful for extending the functionality of the component. A good example is delivery of MIME-encoded messages.

Special case: If this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.

Example. Sending an Email with an Additional Header:

component.MailServer = "MyServer"; component.From = "me@server.com"; component.SendTo = "recipient@server.com"; component.Subject = "My Subject"; component.MessageText = "This is the message body."; component.OtherHeaders = "HeaderName: HeaderValue"; component.Send();

This property is not available at design time.

Password Property (SMTP Component)

This property includes a password for logon to the MailServer .

Syntax

property Password: String read get_Password write set_Password;

Default Value

''

Remarks

If this property is set to a nonempty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent to provide authentication information for the user.

This property is not available at design time.

Priority Property (SMTP Component)

This property includes the priority of the mail message (optional).

Syntax

property Priority: TipsTPriorities read get_Priority write set_Priority;

TipsTPriorities = (
  epUnspecified,
  epNormal,
  epUrgent,
  epNonUrgent
);

Default Value

epUnspecified

Remarks

When this property is set, a priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.

ReadReceiptTo Property (SMTP Component)

This property includes the email address to send a read-receipt to.

Syntax

property ReadReceiptTo: String read get_ReadReceiptTo write set_ReadReceiptTo;

Default Value

''

Remarks

When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address that should receive the read-receipt.

ReplyTo Property (SMTP Component)

This property includes a mail address to which to reply (optional).

Syntax

property ReplyTo: String read get_ReplyTo write set_ReplyTo;

Default Value

''

Remarks

If this property contains a nonempty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies, which is useful if this address is different from the one in From.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

ReturnPath Property (SMTP Component)

This property sets the Return-Path to be used for sending email.

Syntax

property ReturnPath: String read get_ReturnPath write set_ReturnPath;

Default Value

''

Remarks

Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in the From property is used.

SendTo Property (SMTP Component)

This property includes a comma-separated list of addresses for destinations (required).

Syntax

property SendTo: String read get_SendTo write set_SendTo;

Default Value

''

Remarks

This property specifies a comma-separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com

The component will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same thing happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.

Sensitivity Property (SMTP Component)

This property indicates the sensitivity of the mail message (optional).

Syntax

property Sensitivity: TipsTSensitivities read get_Sensitivity write set_Sensitivity;

TipsTSensitivities = (
  esUnspecified,
  esPersonal,
  esPrivate,
  esCompanyConfidential
);

Default Value

esUnspecified

Remarks

This property provides an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are as follows: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

SSLAcceptServerCert Property (SMTP Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

property SSLAcceptServerCert: TipsCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert;

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (SMTP Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

property SSLCert: TipsCertificate read get_SSLCert write set_SSLCert;

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (SMTP Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

property SSLProvider: TipsTSSLProviders read get_SSLProvider write set_SSLProvider;

TipsTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

SSLServerCert Property (SMTP Component)

The server certificate for the last established connection.

Syntax

property SSLServerCert: TipsCertificate read get_SSLServerCert;

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (SMTP Component)

This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.

Syntax

property SSLStartMode: TipsTSSLStartModes read get_SSLStartMode write set_SSLStartMode;

TipsTSSLStartModes = (
  sslAutomatic,
  sslImplicit,
  sslExplicit
);

Default Value

sslAutomatic

Remarks

The SSLStartMode property may have one of the following values:

Subject Property (SMTP Component)

This property includes the subject of the mail message (optional).

Syntax

property Subject: String read get_Subject write set_Subject;

Default Value

''

Remarks

The string in this property is sent with a Subject SMTP header to the mail recipient.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Timeout Property (SMTP Component)

The timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

User Property (SMTP Component)

This property includes the user identifier needed to log in as in the MailServer .

Syntax

property User: String read get_User write set_User;

Default Value

''

Remarks

If this property is set to a nonempty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent to provide authentication information for the user.

This property is not available at design time.

Config Method (SMTP Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SMTP Component)

This method connects to the mail relay and sends the SMTP HELO command.

Syntax

procedure Connect();

Remarks

This method connects to the mail relay and sends the SMTP HELO command, thus preparing to send messages. Any number of messages can later be sent using the Send method.

Example. Connecting and Sending an Email:

control.MailServer = "MyServer" control.From = "me@server.com" control.SendTo = "recipient@server.com" control.Subject = "My Subject" control.MessageText = "This is the message body" control.Connect() control.Send() control.Disconnect()

Disconnect Method (SMTP Component)

This method disconnects from the SMTP server.

Syntax

procedure Disconnect();

Remarks

This method disconnects from the mail relay.

DoEvents Method (SMTP Component)

This method processes events from the internal message queue.

Syntax

procedure DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Expand Method (SMTP Component)

This method asks the MailServer to expand a name or mailing list.

Syntax

procedure Expand(EmailAddress: String);

Remarks

This method asks the MailServer to expand a name or mailing list. The resulting response is provided in one or more Expand events (one for each address). The component will try to connect to the mail relay if it is not already connected.

Interrupt Method (SMTP Component)

This method interrupts the current method.

Syntax

procedure Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ProcessQueue Method (SMTP Component)

This method sends the messages that previously have been queued into QueueDir .

Syntax

procedure ProcessQueue(QueueDir: String);

Remarks

This method sends the messages that previously have been queued into QueueDir. The PITrail event shows the interaction with the server as messages are processed.

This method looks in the directory for files with the extension ".queued" and starts processing them.

When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".

If the file is successfully sent, the file is normally deleted, unless the KeepQueue configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.

Queue Method (SMTP Component)

This method queues the message into QueueDir .

Syntax

function Queue(QueueDir: String): String;

Remarks

This method queues the message into QueueDir. The message is queued into a unique file into the directory QueueDir for future processing.

QueueDir must already exist, or an error will be generated. Alternatively, QueueDir may be set to "*" to return the result as a string instead of writing it to a file.

This method returns the name of the unique queue file created in QueueDir. The file extension is ".queued".

Please refer to the ProcessQueue method for more information on email queue processing.

Reset Method (SMTP Component)

This method will reset the component.

Syntax

procedure Reset();

Remarks

This method will reset the component's properties to their default values.

ResetHeaders Method (SMTP Component)

This method resets all the message headers to empty.

Syntax

procedure ResetHeaders();

Remarks

This method resets all the message headers to '' (empty string). Use this method before creating a new message, so that headers from the previous message are not carried over to the next one.

Send Method (SMTP Component)

This method sends the current message.

Syntax

procedure Send();

Remarks

This method sends the current message. If the component is not connected to the mail relay, a connection is created, the message is sent, and then the connection is closed unless an error occurs.

If the component is already connected (by use of the Connect method), the connection will remain open after the message is sent. To disconnect, call the Disconnect method.

Example. Send an Email:

SMTPControl.MailServer = "MyServer" SMTPControl.From = "me@server.com" SMTPControl.SendTo = "recipient@server.com" SMTPControl.Subject = "My Subject" SMTPControl.MessageText = "This is the message body" SMTPControl.Send()

SendCommand Method (SMTP Component)

This method sends the exact command directly to the server.

Syntax

procedure SendCommand(Command: String);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.

SendToTerminalAndEmail Method (SMTP Component)

This method sends to terminal and email.

Syntax

procedure SendToTerminalAndEmail();

Remarks

This method is similar to Send but requests also that the message is sent to the terminal of the users as well, if they are logged on and accept terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SendToTerminalOnly Method (SMTP Component)

This method sends to terminal only.

Syntax

procedure SendToTerminalOnly();

Remarks

This method is similar to Send but requests instead that the message is sent to the user's terminal. An exception with the server's response is raised if the user is not logged in or does not accept terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SendToTerminalOrEmail Method (SMTP Component)

This method sends to terminal or email.

Syntax

procedure SendToTerminalOrEmail();

Remarks

This method is similar to Send but requests instead that the message is first sent to the user's terminal. If the user is not logged in or does not accept terminal messages, the message is sent to his or her mailbox. This method requires that AllowExtensions is set to True and is not supported by all mail relays.

SetMessageStream Method (SMTP Component)

This method sets the stream to be uploaded to the server as part of the message.

Syntax

procedure SetMessageStream(MessageStream: TStream);

Remarks

This method sets the stream to be uploaded to the server as part of the message. If an upload stream is set before the Send method is called, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0. The component will automatically close this stream if CloseStreamAfterTransfer is set to True (default). If the stream is closed, you will need to call this method again before calling Send again. The content of the stream will be read from the current position all the way to the end.

Note: This method and LocalFile will reset the other.

Verify Method (SMTP Component)

This method sends a verification request to the SMTP server.

Syntax

procedure Verify(EmailAddress: String);

Remarks

This method asks the MailServer to verify the email address provided in the 'EmailAddress' parameter.

ConnectionStatus Event (SMTP Component)

Fired to indicate changes in the connection state.

Syntax

type TConnectionStatusEvent = procedure (
  Sender: TObject;
  const ConnectionEvent: String;
  StatusCode: Integer;
  const Description: String
) of Object;

property OnConnectionStatus: TConnectionStatusEvent read FOnConnectionStatus write FOnConnectionStatus;

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

EndTransfer Event (SMTP Component)

This event is fired when the message text completes transferring.

Syntax

type TEndTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer;

Remarks

If MessageText is not empty, the EndTransfer event is fired when the MessageText finishes transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText via the AttachedFile property, then EndTransfer fires again when the file finishes transferring. For more information, go to the description of the AttachedFile property.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (SMTP Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Expand Event (SMTP Component)

This event is fired for every email address returned by the server when the Expand method is called.

Syntax

type TExpandEvent = procedure (
  Sender: TObject;
  const Address: String
) of Object;

property OnExpand: TExpandEvent read FOnExpand write FOnExpand;

Remarks

This event is fired for every email address as returned by the mail server when the Expand method is called.

The Address parameter may contain a name and an email address, or just an email address, suitable for any of the addressing properties.

PITrail Event (SMTP Component)

This event traces the commands sent to the mail server, and the respective replies.

Syntax

type TPITrailEvent = procedure (
  Sender: TObject;
  Direction: Integer;
  const Message: String
) of Object;

property OnPITrail: TPITrailEvent read FOnPITrail write FOnPITrail;

Remarks

The PITrail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

SSLServerAuthentication Event (SMTP Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  const CertEncoded: String;
  const CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (SMTP Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (SMTP Component)

This event is fired when the message text starts transferring.

Syntax

type TStartTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer;

Remarks

If MessageText is not empty, the StartTransfer event is fired when the MessageText starts transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText via the AttachedFile property, then StartTransfer fires again when the file starts transferring. Please go to the description of the AttachedFile property for more information.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (SMTP Component)

This event is fired when the message text is transferred to MailServer .

Syntax

type TTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer;
  BytesTransferred: Int64;
  PercentDone: Integer;
  const Text: String;
  const TextB: TBytes
) of Object;

property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer;

Remarks

One or more Transfer events are fired during message delivery. Messages consist of MessageText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of MessageText or AttachedFile.

Text contains the current portion of the message being sent.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

>

constructor Create();

constructor Create(valEncoded: TBytes);

constructor Create(valStoreType: TipsCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

constructor Create(valStoreType: TipsCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

constructor Create();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

constructor Create();

constructor Create(valField: String; valValue: String);

MessageRecipient Type

This types describes the message recipient.

Remarks

This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the component is sending the message.

Fields

Constructors

constructor Create();

constructor Create(valAddress: String);

Config Settings (SMTP Component)

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (SMTP Component)

SMTP Errors

The component may also return one of the following error codes, which are inherited from other components.

SSLClient Errors

SSL Errors

TCP/IP Errors