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

FileMailer Control

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

FileMailer

Remarks

The control 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 control with short descriptions. Click on the links for further details.

AttachmentCountThe number of records in the Attachment arrays.
AttachmentFileThis property contains the path of a file on your system that you would like to send as an attachment with your message.
AttachmentNameThis property contains the name of the attachment to be sent.
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.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
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).
MessageDateDate of the mail message (optional).
MessageIdThe Message Identifier for the message.
MessageRecipientCountThe number of records in the MessageRecipient arrays.
MessageRecipientAddressThis property contains the email address of the recipient.
MessageRecipientNameThis property contains name of the recipient.
MessageRecipientOptionsThis property contains the recipient sending options (used only by SMTP).
MessageRecipientTypeThis property contains the recipient type: To, Cc, or BCc.
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).
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 control 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.
DisconnectDisconnects 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.
SendSends the current message and MIME encoded attachment.

Event List


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

CharsetWhen set, the charset Content-Type attribute will be added using the specified value.
MessageTextEncodingWhen set, the MessageText value will be encoded using the specified encoding.
AttachmentEncoding[index]Content-Transfer-Encoding for attached file (at index).
AttachmentType[index]Content-type for attached file (at index).
AttachmentText[index]Add the text into the attachment at the specified index.
OverrideFilenameIf set to true, the AttachmentName property value will be used to set the MIME part Filename attribute.
TempFilePathIf set, the temporary files created during message creation will be put in the path specified.
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