HTMLMailer Class
Properties Methods Events Configuration Settings Errors
The HTMLMailer Component is used to send HTML email including embedded images.
Syntax
ipworks.htmlmailer()
Remarks
The HTMLMailer Class supports both plaintext and SSL/TLS connections(RFC 2487). When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handhsake. Additional SSL related settings are also supported via the Config method.
The class sends a message (provided in MessageHTML and MessageText). The HTML message may contain references to images which are automatically embedded into the message.
The MessageHTML property contains the HTML version of the message. The corresponding plain text version is provided into the MessageText property.
When MessageHTML is set, the class automatically computes a plaintext version of the text and puts it into MessageText. You may choose to override this default text with your own version.
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 class with short descriptions. Click on the links for further details.
AttachmentCount | The number of records in the Attachment arrays. |
AttachmentFile | This property contains the path of a file on your system that you would like to send as an attachment with your message. |
AttachmentName | This property contains the name of the attachment to be sent. |
AuthMechanism | 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 | Used to send additional commands directly to the server. |
Connected | Shows whether the component is connected. |
DeliveryNotificationTo | Email address to send to which to send a delivery notification. |
FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
From | The email address of the sender (required). |
HTMLFile | The path to a local HTML file. |
Idle | The current status of the component. |
ImageCount | The number of records in the Image arrays. |
ImageData | This property optionally specifies the image data. |
ImageFile | This property contains the name of the image files embedded into the HTML message. |
ImageId | This property contains the content identifier for embedded images. |
ImageType | This property contains the content type for embedded images. |
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 | Date of the mail message (optional). |
MessageHTML | The HTML version of the message. |
MessageId | The Message Identifier for the message. |
MessageRecipientCount | The number of records in the MessageRecipient arrays. |
MessageRecipientAddress | This property contains the email address of the recipient. |
MessageRecipientName | This property contains name of the recipient. |
MessageRecipientOptions | This property contains the recipient sending options (used only by SMTP). |
MessageRecipientType | This property contains the recipient type: To, Cc, or BCc. |
MessageText | The plain text version of the message. |
OtherHeaders | An RFC 822 compliant string consisting of extra headers. |
ParseHTML | Controls the behavior of the MessageHTML property. |
Password | A password for logon to the MailServer . |
Priority | Priority of the mail message (optional). |
ReadReceiptTo | Email address to send a read receipt to. |
ReplyTo | A mail address to which to reply (optional). |
SendTo | A comma separated list of addresses for destinations (required). |
Sensitivity | Sensitivity of the mail message (optional). |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLEnabled | Whether TLS/SSL is enabled. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLStartMode | Determines how the component starts the SSL negotiation. |
Subject | The subject of the mail message (optional). |
Timeout | A timeout for the component. |
User | A user identifier to login as in the MailServer . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddAttachment | Adds FileName as an attachment. |
Config | Sets or retrieves a configuration setting . |
Connect | Connects to the mail relay and sends the SMTP HELO command. |
Disconnect | Disconnects from the SMTP server. |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupt the current method. |
ProcessQueue | Sends the messages which have previously been queued into QueueDir . |
Queue | Queues the message into QueueDir . |
Reset | Reset the component. |
ResetHeaders | Resets all the message headers to empty. |
Send | Sends the current message and MIME encoded attachment. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
ConnectionStatus | Fired to indicate changes in connection state. |
EndTransfer | Fired when the message text completes transferring. |
Error | Information about errors during data delivery. |
PITrail | Traces the commands sent to the mail server, and the respective replies. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when the message text starts transferring. |
Transfer | Fired while the message text gets transferred to MailServer . |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
Charset | When set, the charset Content-Type attribute will be added using the specified value. |
MessageTextEncoding | When set, the MessageHTML and MessageText values 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. |
OverrideFilename | If set to true, the AttachmentName property value will be used to set the MIME part Filename attribute. |
TempFilePath | If set, the temporary files created during message creation will be put in the path specified. |
AllowEmptyTo | If set to True, then the SendTo property is not required. |
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
Charset | When set, the message headers will be encoded using the specified Charset. |
Hello | The argument for HELO (herald) command to the server (defaults to local host name). |
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). |
MessageHeadersString | String representation of RFC822-encoded headers of the message. |
MessageIdAlgorithm | Determines the algorithm used to hash the random MessageId. |
OtherHeaders | An RFC 822 compliant string consisting of extra headers. |
ReturnPath | Sets the Return-Path to be used for sending email. |
SendRSET | Whether to send RSET command. |
StopOnToErrors | Instructs the component to stop sending the message if the server does not acknowledge any of the TOs. |
StopOnCcErrors | Instructs the component to stop sending the message if the server does not acknowledge any of the CCs. |
StopOnBccErrors | Instructs the component to stop sending the message if the server does not acknowledge any of the BCCs. |
TransferText | The current portion of the message being sent. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
SelectWaitMillis | The length of time in milliseconds the component will wait when DoEvents is called if there are no events to process. |
CodePage | The system code page used for Unicode to Multibyte translations. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |