IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

SMTP Bean

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

IPWorks.Smtp

Remarks

The SMTP Bean 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 SendTo, Subject, From, Cc, BCc, etc. 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 bean 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 bean 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 bean. 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 bean with short descriptions. Click on the links for further details.

AllowExtensionsA switch allowing the component to use ESMTP features (SMTP extensions).
AuthMechanismUsed 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).
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the component is connected.
DeliveryNotificationToEmail address to send to which to send a delivery notification.
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).
MessageProvides a way to set the raw message content.
MessageDateDate of the mail message (optional).
MessageHeadersCollection of RFC822-encoded headers of the message.
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdThe Message Identifier 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 password for logon to the MailServer .
PriorityPriority of the mail message (optional).
ReadReceiptToEmail address to send a read receipt to.
ReplyToA mail address to which to reply (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).
SubjectThe subject of the mail message (optional).
TimeoutA timeout for the component.
UserA user identifier to login as in the MailServer .

Method List


The following is the full list of the methods of the bean 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.
disconnectDisconnects 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.
sendSends the current message.
sendToTerminalAndEmailSends to terminal and email.
sendToTerminalOnlySends to terminal only.
sendToTerminalOrEmailSends to terminal or email.
setMessageStreamSets the stream to be uploaded to the server as part of the message.
verifySends a Verification request to the SMTP server.

Event List


The following is the full list of the events fired by the bean 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.
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 bean with short descriptions. Click on the links for further details.

AllowEmptyToIf set to True, then the SendTo property is not required.
AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
CharsetWhen set, the message headers will be encoded using the specified Charset.
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.
SendRSETWhether to send RSET command.
StopOnToErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the TOs.
StopOnCcErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the CCs.
StopOnBccErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the BCCs.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0