IPWorks S/MIME 2020 .NET Edition

Questions / Feedback?

SHTMLMailer Component

Properties   Methods   Events   Configuration Settings   Errors  

The SHTMLMailer Component is used to send HTML email including embedded images.




The SHTMLMailer Component 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 handshake. Additional SSL related settings are also supported via the Config method.

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

AttachmentsThe paths of files to attach to the message.
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).
CertificateThe current selected certificate.
CommandUsed to send additional commands directly to the server.
ConnectedShows whether the component is connected.
DeliveryNotificationToEmail address to which to send a delivery notification.
EncryptingAlgorithmTextual description of the encrypting algorithm.
FirewallA set of properties related to firewall access.
FromThe email address of the sender (required).
HTMLFileThe path to a local HTML file.
IdleThe current status of the component.
ImagesThe embedded images in the HTML message.
ImportanceImportance of the mail message (optional).
IncludeCertificateSpecifies whether to include the signer's certificate with the signed message.
IncludeChainSpecifies whether to include the signer's certificate chain with the signed message.
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).
MessageHTMLThe HTML version of the message.
MessageIdThe Message Identifier for the message.
MessageRecipientsThe collection of recipients of the message.
MessageTextThe plain text version of the message.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ParseHTMLControls the behavior of the MessageHTML property.
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).
SigningAlgorithmTextual description of the signature hash algorithm.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLEnabledWhether TLS/SSL is enabled.
SSLServerCertThe server certificate for the last established connection.
SSLStartModeDetermines how the component starts the SSL negotiation.
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 component with short descriptions. Click on the links for further details.

AddAttachmentAdds FileName as an attachment.
AddRecipientCertUsed to add recipient certificates used to encrypt messages.
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.
EncryptEncrypts the message.
InterruptInterrupt the current method.
ProcessQueueSends the messages which have previously been queued into QueueDir .
QueueQueues the message into QueueDir .
ResetReset the component.
ResetHeadersResets all the message headers to empty.
SendSends the current message and MIME encoded attachment.
SetMessageHTMLStreamSets the stream from which the component will read the HTML version of the message.
SignSigns the current message.
SignAndEncryptSigns and encrypts the current 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.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
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.

AttachmentEncoding[index]Content-Transfer-Encoding for attached file (at index).
AttachmentType[index]Content-type for attached file (at index).
CharsetWhen set, the charset Content-Type attribute will be added using the specified value.
MessageTextEncodingWhen set, the MessageHTML and MessageText values will be encoded using the specified encoding.
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.
UseTempFileDetermines if temporary files are used during message creation.
UseTempFileIf set, the component uses temporary files when generating messages.
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.
FoldHeadersTells the component whether to fold the headers.
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).
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdAlgorithmDetermines the algorithm used to hash the random MessageId.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ReturnPathSets the Return-Path to be used for sending email.
SendRSETWhether to send RSET command.
StopOnBccErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the BCCs.
StopOnCcErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the CCs.
StopOnToErrorsInstructs the component to stop sending the message if the server does not acknowledge any of the TOs.
TransferTextThe current portion of the message being sent.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
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).
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;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 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.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 .NET Edition - Version 20.0 [Build 8161]