Search: 
Available in: IP*WORKS! | SSH | SSL
Smtp Class
SMTP Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

The SMTP 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 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 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 and/or AttachedFile. 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 complete descriptions.

AllowExtensions A switch allowing the component to use ESMTP features (SMTP extensions).
AuthMechanism The authentication mechanism to be used when connecting to the mail server.
BCc A comma separated list of addresses for blind carbon copies (optional).
Cc A comma separated list of addresses for carbon copies (optional).
Command Can be used to send additional commands directly to the server.
Connected Shows whether the component is connected.
DeliveryNotificationTo Email address to send a delivery notification to.
Firewall A set of properties related to firewall access.
From The email address of the sender (required).
Idle The current status of the component.
Importance Importance of the mail message (optional).
LastReply The last reply from the server.
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPort The server port for SMTP (default 25).
MailServer The name or address of a mail server (mail relay).
MessageDate The Date of the mail message (optional).
MessageHeaders Collection of RFC822-encoded headers of the message.
MessageHeadersString String representation of RFC822-encoded headers of the message.
MessageId The MessageId for the message.
MessageRecipients The collection of recipients of the message.
MessageText The full text of the message to send (without headers).
OtherHeaders An RFC 822 compliant string consisting of extra headers.
Password A login password to login with in the MailServer.
Priority Priority of the mail message (optional).
ReadReceiptTo Email address to send a read receipt to.
ReplyTo A mail address to reply to (optional).
ReturnPath Sets the Return-Path to be used for sending email.
SendTo A comma separated list of addresses for destinations (required).
Sensitivity Sensitivity of the mail message (optional).
Subject The subject of the mail message (optional).
Timeout A timeout for the component.
User A 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 complete descriptions.

Config Sets or retrieves a component configuration setting.
Connect Connects to the mail relay and sends the SMTP HELO command.
Disconnect Disconnect from the SMTP server.
DoEvents Processes events from the internal message queue.
Expand Asks the MailServer to expand a name or mailing list.
Interrupt Interrupt the current method.
ProcessQueue Sends the messages which have previously been queued into QueueDir.
Queue Queues the message into QueueDir.
ResetHeaders Resets all the message headers to empty.
Send Send the current message.
SendToTerminalAndEmail Send to terminal and email.
SendToTerminalOnly Send to terminal only.
SendToTerminalOrEmail Send to terminal or email.
SetMessageStream Sets the stream to be uploaded to the server as part of the message.
Verify Send 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 complete descriptions.

ConnectionStatus Fired to indicate changes in connection state.
EndTransfer Fired when the message text completes transferring.
Error Information about errors during data delivery.
Expand Fired for every email address returned by the server when the method is called.
PITrail Traces the commands sent to the mail server, and the respective replies.
StartTransfer Fired when the message text starts transferring.
Transfer Fired while the message text gets transferred to .

Configuration Settings


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

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
Hello The argument for HELO (herald) command to the server (defaults to local host name)
InBufferSize The size in bytes of the incoming queue of the socket.
KeepQueue If set to True, queued files are not deleted after a successful send.
MaxHeaderLength Maximum length for headers to avoid line folding (default 80)
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OtherHeaders An RFC 822 compliant string consisting of extra headers.
OutBufferSize The size in bytes of the outgoing queue of the socket.
ReturnPath Sets the Return-Path to be used for sending email..
StopOnBccErrors Instructs the component to stop sending the message if the server does not acknowledge any of the BCCs
TcpNoDelay Whether or not to delay when sending packets

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