HTMLMailer Component

Properties   Methods   Events   Config Settings   Errors  

The HTMLMailer Component is used to send HTML emails, including embedded images.

Syntax

nsoftware.IPWorksSSL.Htmlmailer

Remarks

The HTMLMailer Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (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 that are automatically embedded into the message.

The MessageHTML property contains the HTML version of the message. The corresponding plaintext version is provided in 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 by 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.

Method List

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

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.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Attachments Property (HTMLMailer Component)

This property contains paths of the files to attach to the message.

Syntax

• C#
• VB.NET

public FileAttachmentList Attachments { get; }

Public Property Attachments As FileAttachmentList

Remarks

This property contains the path of a file on your system to be sent as an attachment with your message. The component will open the file and encode its contents in MIME format.

Example 1: Adding an Attachment

component.AddAttachment("C:\file1.zip"); component.AddAttachment("C:\file2.zip"); component.Send(); Example 2: Using an Attachments Collection

component.Attachments.Add(new nsoftware.IPWorks.FileAttachment("name", "C:\file.txt"));

This collection is indexed from 0 to count -1.

This property is not available at design time.

AuthMechanism Property (HTMLMailer Component)

This property is used when connecting to the mail server.

Syntax

• C#
• VB.NET

public HtmlmailerAuthMechanisms AuthMechanism { get; set; }

enum HtmlmailerAuthMechanisms {
  amUserPassword,
  amCRAMMD5,
  amNTLM,
  amAPOP,
  amSASLPlain,
  amSASLDigestMD5,
  amKerberos,
  amXOAUTH2
}

Public Property AuthMechanism As HtmlmailerAuthMechanisms

Enum HtmlmailerAuthMechanisms
  amUserPassword
  amCRAMMD5
  amNTLM
  amAPOP
  amSASLPlain
  amSASLDigestMD5
  amKerberos
  amXOAUTH2
End Enum

Default Value

0

Remarks

This is the authentication mechanism property to be used when connecting to the mail server.

By default, this property is amUserPassword (0), and if the User and Password properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.

If this property is set to amNTLM (2), NTLM authentication will be used.

If this property is set to amKerberos (6), Kerberos authentication will be used.

Note: This functionality is available only in Windows.

When set to amXOAUTH2 (7), set User to the username and AuthorizationIdentity to the OAuth token. See AuthorizationIdentity for details.

BCc Property (HTMLMailer Component)

This property includes a comma-separated list of addresses for blind carbon copies (optional).

Syntax

• C#
• VB.NET

public string BCc { get; set; }

Public Property BCc As String

Default Value

""

Remarks

This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no BCc SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.

The component will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in this property.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients collection before setting this property to remove previous recipients.

Cc Property (HTMLMailer Component)

This property includes a comma-separated list of addresses for carbon copies (optional).

Syntax

• C#
• VB.NET

public string Cc { get; set; }

Public Property Cc As String

Default Value

""

Remarks

This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc).

The component will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Note: You must clear the MessageRecipients collection before setting this property to remove previous recipients.

Command Property (HTMLMailer Component)

This property is used to send additional commands directly to the server.

Syntax

• C#
• VB.NET

public string Command { set; }

Public WriteOnly Property Command As String

Default Value

""

Remarks

This property can be used to send additional commands directly to the server. Check the LastReply property or trap the PITrail events coming from the server to get the response.

This property is write-only and not available at design time.

Connected Property (HTMLMailer Component)

This shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; set; }

Public Property Connected As Boolean

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

DeliveryNotificationTo Property (HTMLMailer Component)

This property includes the email address to which to send a delivery notification.

Syntax

• C#
• VB.NET

public string DeliveryNotificationTo { get; set; }

Public Property DeliveryNotificationTo As String

Default Value

""

Remarks

This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.

Firewall Property (HTMLMailer Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

From Property (HTMLMailer Component)

The email address of the sender (required).

Syntax

• C#
• VB.NET

public string From { get; set; }

Public Property From As String

Default Value

""

Remarks

This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

HTMLFile Property (HTMLMailer Component)

This property includes the path to a local HTML file.

Syntax

• C#
• VB.NET

public string HTMLFile { get; set; }

Public Property HTMLFile As String

Default Value

""

Remarks

This property may contain the path to the local HTML file. If this property is not empty, the contents of the file with that name will be appended to the text in MessageHTML.

Note: This means that if MessageHTML is empty, HTMLFile is what will be sent to the server.

This property is not available at design time.

Idle Property (HTMLMailer Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Images Property (HTMLMailer Component)

This property includes the embedded images in the HTML message.

Syntax

• C#
• VB.NET

public HTMLImageList Images { get; }

Public Property Images As HTMLImageList

Remarks

This property contains the names of the image files embedded into the HTML message. The collection is updated every time MessageHTML is set. You may change the file names before sending (e.g., if they don't point to valid files).

This collection is indexed from 0 to count -1.

Importance Property (HTMLMailer Component)

Importance of the mail message (optional).

Syntax

• C#
• VB.NET

public HtmlmailerImportances Importance { get; set; }

enum HtmlmailerImportances {
  miUnspecified,
  miHigh,
  miNormal,
  miLow
}

Public Property Importance As HtmlmailerImportances

Enum HtmlmailerImportances
  miUnspecified
  miHigh
  miNormal
  miLow
End Enum

Default Value

0

Remarks

This property indicates the importance of the mail message (optional). When set, an Importance header will be added to the message.

Importance is an indication to the recipient(s) about how important the message is. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

LastReply Property (HTMLMailer Component)

The last reply from the server.

Syntax

• C#
• VB.NET

public string LastReply { get; }

Public ReadOnly Property LastReply As String

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.

This property is read-only.

LocalHost Property (HTMLMailer Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

MailPort Property (HTMLMailer Component)

The server port for SMTP (default 25).

Syntax

• C#
• VB.NET

public int MailPort { get; set; }

Public Property MailPort As Integer

Default Value

25

Remarks

This property contains the server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For implicit SSL, use port 465 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

MailServer Property (HTMLMailer Component)

The name or address of a mail server (mail relay).

Syntax

• C#
• VB.NET

public string MailServer { get; set; }

Public Property MailServer As String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.

The current version of the component does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (a UNIX host for example), but it is preferable to select a MailServer that is close to the machine sending mail.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

MessageDate Property (HTMLMailer Component)

Date of the mail message (optional).

Syntax

• C#
• VB.NET

public string MessageDate { get; set; }

Public Property MessageDate As String

Default Value

"*"

Remarks

If this property contains a non-empty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.

Special case: if this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders is computed and the message is sent. This is the default behavior of the component

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".

This property is not available at design time.

MessageHTML Property (HTMLMailer Component)

This property includes the HTML version of the message.

Syntax

• C#
• VB.NET

public string MessageHTML { get; set; }

Public Property MessageHTML As String

Default Value

""

Remarks

This property contains the HTML version of the message.

When this property 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.

Example. Setting MessageHTML:

component.MessageHTML = "<b>Hello</b>, my name is <i>Tom</i>";

MessageId Property (HTMLMailer Component)

The Message Identifier for the message.

Syntax

• C#
• VB.NET

public string MessageId { get; set; }

Public Property MessageId As String

Default Value

"*"

Remarks

This property contains the Message Identifier for the message. When set, the value of MessageId is used as the Message-ID header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.

This property is not available at design time.

MessageRecipients Property (HTMLMailer Component)

The collection of recipients of the message.

Syntax

• C#
• VB.NET

public MessageRecipientList MessageRecipients { get; }

Public Property MessageRecipients As MessageRecipientList

Remarks

This property contains a collection which describes to whom the message is being sent. You may include all recipients in this property, even Cc's and BCc's, which are specified by the type field.

This collection is indexed from 0 to count -1.

MessageText Property (HTMLMailer Component)

This property includes the plaintext version of the message.

Syntax

• C#
• VB.NET

public string MessageText { get; set; }

Public Property MessageText As String

Default Value

""

Remarks

This property is a plaintext version of the HTML message. This is necessary for recipients with legacy mail readers that do not support HTML.

The MessageHTML property contains the HTML version of the message. When MessageHTML is set, the component automatically computes a plaintext version of the text and puts it into this property. You may choose to override this default text with your own version.

OtherHeaders Property (HTMLMailer Component)

An RFC 822 compliant string consisting of extra headers.

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, etc.

The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, message delivery might not be successful.

This property is useful for extending the functionality of the component. A good example is delivery of MIME encoded messages.

SPECIAL CASE: if this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.

Example (Send an Email With Additional Header)

component.MailServer = "MyServer"; component.From = "me@server.com"; component.SendTo = "recipient@server.com"; component.Subject = "My Subject"; component.MessageText = "This is the message body."; component.OtherHeaders = "HeaderName: HeaderValue"; component.Send();

This property is not available at design time.

ParseHTML Property (HTMLMailer Component)

This property controls the behavior of the MessageHTML property.

Syntax

• C#
• VB.NET

public bool ParseHTML { get; set; }

Public Property ParseHTML As Boolean

Default Value

True

Remarks

This property controls the behavior of the MessageHTML property. If ParseHTML is set to False, you must provide valid values in MessageHTML, MessageText, and Images.

Password Property (HTMLMailer Component)

A password for logon to the MailServer .

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

If this property is set to a non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent in order to provide authentication information for the user.

This property is not available at design time.

Priority Property (HTMLMailer Component)

Priority of the mail message (optional).

Syntax

• C#
• VB.NET

public HtmlmailerPriorities Priority { get; set; }

enum HtmlmailerPriorities {
  epUnspecified,
  epNormal,
  epUrgent,
  epNonUrgent
}

Public Property Priority As HtmlmailerPriorities

Enum HtmlmailerPriorities
  epUnspecified
  epNormal
  epUrgent
  epNonUrgent
End Enum

Default Value

0

Remarks

When this property is set, a Priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.

ReadReceiptTo Property (HTMLMailer Component)

Email address to send a read receipt to.

Syntax

• C#
• VB.NET

public string ReadReceiptTo { get; set; }

Public Property ReadReceiptTo As String

Default Value

""

Remarks

When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address which should receive the read-receipt.

ReplyTo Property (HTMLMailer Component)

A mail address to which to reply (optional).

Syntax

• C#
• VB.NET

public string ReplyTo { get; set; }

Public Property ReplyTo As String

Default Value

""

Remarks

If this property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (useful if this address is different from the one in From).

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

SendTo Property (HTMLMailer Component)

A comma separated list of addresses for destinations (required).

Syntax

• C#
• VB.NET

public string SendTo { get; set; }

Public Property SendTo As String

Default Value

""

Remarks

This property specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

The component will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same happens with an email address specified in BCc.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

NOTE: You must clear the MessageRecipients collection before setting this property to remove previous recipients.

Sensitivity Property (HTMLMailer Component)

Sensitivity of the mail message (optional).

Syntax

• C#
• VB.NET

public HtmlmailerSensitivities Sensitivity { get; set; }

enum HtmlmailerSensitivities {
  esUnspecified,
  esPersonal,
  esPrivate,
  esCompanyConfidential
}

Public Property Sensitivity As HtmlmailerSensitivities

Enum HtmlmailerSensitivities
  esUnspecified
  esPersonal
  esPrivate
  esCompanyConfidential
End Enum

Default Value

0

Remarks

This property is an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

SSLAcceptServerCert Property (HTMLMailer Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (HTMLMailer Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (HTMLMailer Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public HtmlmailerSSLProviders SSLProvider { get; set; }

enum HtmlmailerSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As HtmlmailerSSLProviders

Enum HtmlmailerSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (HTMLMailer Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (HTMLMailer Component)

Determines how the component starts the SSL negotiation.

Syntax

• C#
• VB.NET

public HtmlmailerSSLStartModes SSLStartMode { get; set; }

enum HtmlmailerSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit
}

Public Property SSLStartMode As HtmlmailerSSLStartModes

Enum HtmlmailerSSLStartModes
  sslAutomatic
  sslImplicit
  sslExplicit
End Enum

Default Value

0

Remarks

The SSLStartMode property may have one of the following values:

Subject Property (HTMLMailer Component)

The subject of the mail message (optional).

Syntax

• C#
• VB.NET

public string Subject { get; set; }

Public Property Subject As String

Default Value

""

Remarks

The string in this property is sent with a Subject SMTP header to the mail recipient.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.

Timeout Property (HTMLMailer Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

User Property (HTMLMailer Component)

A user identifier to login as in the MailServer .

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

If this property is set to a non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent in order to provide authentication information for the user.

This property is not available at design time.

AddAttachment Method (HTMLMailer Component)

This adds FileName as an attachment.

Syntax

• C#
• VB.NET

public void AddAttachment(string fileName);

Async Version
public async Task AddAttachment(string fileName);
public async Task AddAttachment(string fileName, CancellationToken cancellationToken);

Public Sub AddAttachment(ByVal FileName As String)

Async Version
Public Sub AddAttachment(ByVal FileName As String) As Task
Public Sub AddAttachment(ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

This method adds the file name as an attachment. The full list of attachments is contained in the Attachments property.

Example 1: Adding an Attachment

component.AddAttachment("C:\file1.zip"); component.AddAttachment("C:\file2.zip"); component.Send(); Example 2: Using an Attachments Collection

component.Attachments.Add(new nsoftware.IPWorks.FileAttachment("name", "C:\file.txt"));

CalcMessageText Method (HTMLMailer Component)

This method populates MessageText with the plaintext version of the message.

Syntax

• C#
• VB.NET

public void CalcMessageText();

Async Version
public async Task CalcMessageText();
public async Task CalcMessageText(CancellationToken cancellationToken);

Public Sub CalcMessageText()

Async Version
Public Sub CalcMessageText() As Task
Public Sub CalcMessageText(cancellationToken As CancellationToken) As Task

Remarks

This method parses MessageHTML or HTMLFile and calculates a plaintext version of the message. The plaintext version is stored in the MessageText property.

Calling this method is optional. When the Send method is called, the component will automatically calculate a plaintext version of the message. This may be called in cases in which the plaintext version will be set explicitly. For instance:

component.MessageHTML="<html><body><b>Test Message</b></body></html>"; component.CalcMessageText(); component.MessageText = "A new custom plaintext message";

Config Method (HTMLMailer Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (HTMLMailer Component)

This method connects to the mail relay and sends the SMTP HELO command.

Syntax

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

Remarks

This method connects to the mail relay and sends the SMTP HELO command, thus preparing to send messages. Any number of messages can later be sent using the Send method.

Example. Connecting and Sending an Email:

control.MailServer = "MyServer" control.From = "me@server.com" control.SendTo = "recipient@server.com" control.Subject = "My Subject" control.MessageText = "This is the message body" control.Connect() control.Send() control.Disconnect()

Disconnect Method (HTMLMailer Component)

This method disconnects from the SMTP server.

Syntax

• C#
• VB.NET

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);

Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

Remarks

This method disconnects from the mail relay.

DoEvents Method (HTMLMailer Component)

Processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (HTMLMailer Component)

Interrupt the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ProcessQueue Method (HTMLMailer Component)

Sends the messages which have previously been queued into QueueDir .

Syntax

• C#
• VB.NET

public void ProcessQueue(string queueDir);

Async Version
public async Task ProcessQueue(string queueDir);
public async Task ProcessQueue(string queueDir, CancellationToken cancellationToken);

Public Sub ProcessQueue(ByVal QueueDir As String)

Async Version
Public Sub ProcessQueue(ByVal QueueDir As String) As Task
Public Sub ProcessQueue(ByVal QueueDir As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends the messages which have previously been queued into QueueDir. The PITrail event shows the interaction with the server as messages as are processed.

This method looks in the directory for files with extension ".queued" and starts processing them.

When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".

If the file is successfully sent, the file is normally deleted, unless the KeepQueue configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.

Queue Method (HTMLMailer Component)

Queues the message into QueueDir .

Syntax

• C#
• VB.NET

public string Queue(string queueDir);

Async Version
public async Task<string> Queue(string queueDir);
public async Task<string> Queue(string queueDir, CancellationToken cancellationToken);

Public Function Queue(ByVal QueueDir As String) As String

Async Version
Public Function Queue(ByVal QueueDir As String) As Task(Of String)
Public Function Queue(ByVal QueueDir As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method queues the message into QueueDir. The message is queued into a unique file into the directory QueueDir for future processing.

QueueDir must already exist, or an error will be generated. Alternatively, QueueDir may be set to "*" to return the result as a string instead of writing it to a file.

The method returns the name of the unique queue file created in QueueDir. The file extension is ".queued".

Please refer to the ProcessQueue method for more information on email queue processing.

Reset Method (HTMLMailer Component)

Reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

ResetHeaders Method (HTMLMailer Component)

Resets all the message headers to empty.

Syntax

• C#
• VB.NET

public void ResetHeaders();

Async Version
public async Task ResetHeaders();
public async Task ResetHeaders(CancellationToken cancellationToken);

Public Sub ResetHeaders()

Async Version
Public Sub ResetHeaders() As Task
Public Sub ResetHeaders(cancellationToken As CancellationToken) As Task

Remarks

This method resets all the message headers to "" (empty string). Use this method before creating a new message, so that headers from the previous message are not carried over to the next one.

Send Method (HTMLMailer Component)

This method sends the current message and MIME-encoded attachment.

Syntax

• C#
• VB.NET

public void Send();

Async Version
public async Task Send();
public async Task Send(CancellationToken cancellationToken);

Public Sub Send()

Async Version
Public Sub Send() As Task
Public Sub Send(cancellationToken As CancellationToken) As Task

Remarks

This method sends the current message and MIME-encoded attachment. If the component is not connected to the mail relay, a connection is created, the message is sent, and then the connection is closed unless an error occurs.

If the component is already connected (by use of the Connect method), the connection will remain open after the message is sent. To disconnect, call the Disconnect method.

Example. Send an HTML Email:

HTMLMailerControl.MailServer = "myserver" HTMLMailerControl.SendTo = "recipient@myserver.com" HTMLMailerControl.From = "me@myserver.com" HTMLMailerControl.Subject = "My Subject" HTMLMailerControl.MessageHTML = "<b>Hello</b>, my name is <i>Tom</i>" HTMLMailerControl.Send

SendCommand Method (HTMLMailer Component)

Sends the exact command directly to the server.

Syntax

• C#
• VB.NET

public void SendCommand(string command);

Async Version
public async Task SendCommand(string command);
public async Task SendCommand(string command, CancellationToken cancellationToken);

Public Sub SendCommand(ByVal Command As String)

Async Version
Public Sub SendCommand(ByVal Command As String) As Task
Public Sub SendCommand(ByVal Command As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method check the LastReply property and/or monitor the PITrail event to obtain the server's response.

SetMessageHTMLStream Method (HTMLMailer Component)

This method sets the stream from which the component will read the HTML version of the message.

Syntax

• C#
• VB.NET

public void SetMessageHTMLStream(System.IO.Stream messageStream);

Async Version
public async Task SetMessageHTMLStream(System.IO.Stream messageStream);
public async Task SetMessageHTMLStream(System.IO.Stream messageStream, CancellationToken cancellationToken);

Public Sub SetMessageHTMLStream(ByVal MessageStream As System.IO.Stream)

Async Version
Public Sub SetMessageHTMLStream(ByVal MessageStream As System.IO.Stream) As Task
Public Sub SetMessageHTMLStream(ByVal MessageStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream from which the component will read the HTML version of the message. Once set, the component reads the content of the stream and populates the MessageHTML property with the HTML version of the message. The corresponding plaintext version is provided in the MessageText property.

When this property is called, 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.

ConnectionStatus Event (HTMLMailer Component)

This event is fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, HtmlmailerConnectionStatusEventArgs e);

public class HtmlmailerConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As HtmlmailerConnectionStatusEventArgs)

Public Class HtmlmailerConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

EndTransfer Event (HTMLMailer Component)

This event is fired when the message text completes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, HtmlmailerEndTransferEventArgs e);

public class HtmlmailerEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As HtmlmailerEndTransferEventArgs)

Public Class HtmlmailerEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

If MessageText is not empty, the EndTransfer event is fired when the MessageText finishes transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText via the AttachedFile property, then EndTransfer fires again when the file finishes transferring. For more information, go to the description of the AttachedFile property.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (HTMLMailer Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, HtmlmailerErrorEventArgs e);

public class HtmlmailerErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As HtmlmailerErrorEventArgs)

Public Class HtmlmailerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

PITrail Event (HTMLMailer Component)

Traces the commands sent to the mail server, and the respective replies.

Syntax

• C#
• VB.NET

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, HtmlmailerPITrailEventArgs e);

public class HtmlmailerPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Message { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As HtmlmailerPITrailEventArgs)

Public Class HtmlmailerPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Message As String
End Class

Remarks

The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

SSLServerAuthentication Event (HTMLMailer Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, HtmlmailerSSLServerAuthenticationEventArgs e);

public class HtmlmailerSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As HtmlmailerSSLServerAuthenticationEventArgs)

Public Class HtmlmailerSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (HTMLMailer Component)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, HtmlmailerSSLStatusEventArgs e);

public class HtmlmailerSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As HtmlmailerSSLStatusEventArgs)

Public Class HtmlmailerSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (HTMLMailer Component)

Fired when the message text starts transferring.

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, HtmlmailerStartTransferEventArgs e);

public class HtmlmailerStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As HtmlmailerStartTransferEventArgs)

Public Class HtmlmailerStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

If MessageText is not empty, the StartTransfer event is fired when the MessageText starts transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.

If a file is attached to the MessageText via the AttachedFile property, then StartTransfer fires again when the file starts transferring. Please go to the description of the AttachedFile property for more information.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (HTMLMailer Component)

Fired while the message text gets transferred to MailServer .

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, HtmlmailerTransferEventArgs e);

public class HtmlmailerTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As HtmlmailerTransferEventArgs)

Public Class HtmlmailerTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

One or more Transfer events are fired during message delivery. Messages consist of MessageText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of MessageText and/or AttachedFile.

Text contains the current portion of the message being sent.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

FileAttachment Type

This describes the file being attached.

Remarks

This contains information about the location of the file that is being attached to the message.

Fields

Constructors

• C#
• VB.NET

public FileAttachment();

Public FileAttachment()

• C#
• VB.NET

public FileAttachment(string file);

Public FileAttachment(ByVal File As String)

• C#
• VB.NET

public FileAttachment(string name, string file);

Public FileAttachment(ByVal Name As String, ByVal File As String)

• C#
• VB.NET

public FileAttachment(string name, System.IO.Stream inputStream);

Public FileAttachment(ByVal Name As String, ByVal InputStream As System.IO.Stream)

• C#
• VB.NET

public FileAttachment(string name, System.IO.Stream inputStream, string encoding);

Public FileAttachment(ByVal Name As String, ByVal InputStream As System.IO.Stream, ByVal Encoding As String)

Firewall Type

This is the firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

HTMLImage Type

This type describes an HTML-embedded image.

Remarks

Each image in the HTML message gets set when the MessageHTML property is set. You may, however, make changes to the fields for each HTMLImage before the message is sent.

Fields

Constructors

• C#
• VB.NET

public HTMLImage();

Public HTMLImage()

• C#
• VB.NET

public HTMLImage(string file);

Public HTMLImage(ByVal File As String)

MessageRecipient Type

This types describes the message recipient.

Remarks

This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the component is sending the message.

Fields

Constructors

• C#
• VB.NET

public MessageRecipient();

Public MessageRecipient()

• C#
• VB.NET

public MessageRecipient(string address);

Public MessageRecipient(ByVal Address As String)

• C#
• VB.NET

public MessageRecipient(string address, int recipientType);

Public MessageRecipient(ByVal Address As String, ByVal RecipientType As Integer)

Config Settings (HTMLMailer Component)

HTMLMailer Config Settings

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (HTMLMailer Component)

HTMLMailer Errors

The component may also return one of the following error codes, which are inherited from other components.

MIME Errors

SMTP Errors

The component may also return one of the following error codes, which are inherited from other components.

SSLClient Errors

SSL Errors

TCP/IP Errors