Search: 
Available in: SSH | SSL
SMTPS Component [IP*Works! SSL V8]

Properties   Methods   Events   Configuration Settings  

The SMTPS component is used to send Internet mail using the SMTP protocol (the Internet mail standard).

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The SMTPS component is the SSL-enabled equivalent (RFC 2487) of the IP*Works! SMTP component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLProvider configuration setting chooses a security provider subsystem. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the event allow you to check the server identity and other security attributes. Finally, the event provides information about the SSL handshake.

The SMTPS 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 like , , , , , etc. that map directly to the internet mail message headers with the same name (RFC 822). The message text is set in and/or . Messages are sent by calling the method.

The component supports message delivery to multiple recipients through the , , and 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 property.

A number of events provide feedback during the operation of the component. The event is fired during message delivery to show the number of bytes delivered. The 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.

AllowExtensionsA switch allowing the component to use ESMTP features (SMTP extensions).
AuthMechanismThe authentication mechanism to be used when connecting to the mail server.
BCcA comma separated list of addresses for blind carbon copies (optional).
CcA comma separated list of addresses for carbon copies (optional).
CommandCan be used to send additional commands directly to the server.
ConnectedShows whether the component is connected.
DeliveryNotificationToEmail address to send a delivery notification to.
FirewallA set of properties related to firewall access.
FromThe email address of the sender (required).
IdleThe current status of the component.
ImportanceImportance of the mail message (optional).
LastReplyThe last reply from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPortThe server port for SMTP (default 25).
MailServerThe name or address of a mail server (mail relay).
MessageDateThe Date of the mail message (optional).
MessageHeadersCollection of RFC822-encoded headers of the message.
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdThe MessageId for the message.
MessageRecipientsThe collection of recipients of the message.
MessageTextThe full text of the message to send (without headers).
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
PasswordA login password to login with in the MailServer .
PriorityPriority of the mail message (optional).
ReadReceiptToEmail address to send a read receipt to.
ReplyToA mail address to reply to (optional).
ReturnPathSets the Return-Path to be used for sending email.
SendToA comma separated list of addresses for destinations (required).
SensitivitySensitivity of the mail message (optional).
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during ssl negotiation.
SSLServerCertThe server certificate for the last established connection.
SSLStartModeDetermines how the component starts the SSL negotiation.
SubjectThe subject of the mail message (optional).
TimeoutA timeout for the component.
UserA user id to login as in the MailServer .

Method List


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

ConfigSets or retrieves a configuration setting.
ConnectConnects to the mail relay and sends the SMTP HELO command.
DisconnectDisconnect from the SMTP server.
DoEventsProcesses events from the internal message queue.
ExpandAsks the MailServer to expand a name or mailing list.
InterruptInterrupt the current method.
ProcessQueueSends the messages which have previously been queued into QueueDir .
QueueQueues the message into QueueDir .
ResetHeadersResets all the message headers to empty.
SendSend the current message.
SendToTerminalAndEmailSend to terminal and email.
SendToTerminalOnlySend to terminal only.
SendToTerminalOrEmailSend to terminal or email.
SetMessageStreamSets the stream to be uploaded to the server as part of the message.
VerifySend a Verify request to the SMTP server.

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.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the message text completes transferring.
ErrorInformation about errors during data delivery.
ExpandFired for every email address returned by the server when the Expand method is called.
PITrailTraces the commands sent to the mail server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when the message text starts transferring.
TransferFired while the message text gets transferred to MailServer .

Configuration Settings


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

HelloThe argument for HELO (herald) command to the server (defaults to local host name)
KeepQueueIf set to True, queued files are not deleted after a successful send.
MaxHeaderLengthMaximum length for headers to avoid line folding (default 80)
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ReturnPathSets the Return-Path to be used for sending email..
StopOnBccErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the BCCs
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets
AcceptAnyServerCertIf set the component will accept any certificate presented by the server
SSLProviderThe name of the security provider to use.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLSecurityFlagsFlags that control certificate verification
ReuseSSLSessionDetermines if the SSL session is reused.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator(PRNG).
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCADirThe path to a directory containing CA certificates.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only).

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.