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

Properties   Methods   Events   Configuration Settings  

The FileMailer Component is used to send emails with file attachments.

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 component sends a message (provided in MessageText) and one or more file attachments specified in the Attachments properties .

The recipients are specified by the SendTo, Cc, and BCc properties, and the message subject by the Subject property.

Once all the appropriate properties have been set call the Send method and your message will be sent to its intended recipient(s).

Other SMTP headers may be specified through the OtherHeaders property. Information about interaction with the server is provided via the PITrail event.

Property List


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

AttachmentsThe paths of files to attach to the message.
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).
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 password for logon to the MailServer.
PriorityPriority of the mail message (optional).
ReadReceiptToEmail address to send a read receipt to.
ReplyToA mail address to reply to (optional).
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 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.

AddAttachmentAdds FileName as an attachment.
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.
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 and MIME encoded attachment.
SetMessageStreamSets the stream to be uploaded to the server as part of the message.

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.
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 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
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
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 (Windows/COM only)

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