SHTMLMailer Class

Properties   Methods   Events   Config Settings   Errors  

The SHTMLMailer Class is used to send HTML emails, including embedded images.

Syntax

ipworkssmime.SHTMLMailer

Remarks

The SHTMLMailer Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2487). When connecting over Secure Sockets Layer/Transport Layer Security (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 through the Config method.

The class 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 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 by 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.

Method List

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

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.

Config Settings

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

Attachments Property (SHTMLMailer Class)

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

Syntax

public FileAttachmentList getAttachments();
public void setAttachments(FileAttachmentList attachments);

Remarks

This property contains the path of a file on your system to be sent as an attachment with your message. The class 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 size -1.

This property is not available at design time.

AuthMechanism Property (SHTMLMailer Class)

This property is used when connecting to the mail server.

Syntax

public int getAuthMechanism();
public void setAuthMechanism(int authMechanism);

Enumerated values:
  public final static int amUserPassword = 0;
  public final static int amCRAMMD5 = 1;
  public final static int amNTLM = 2;
  public final static int amAPOP = 3;
  public final static int amSASLPlain = 4;
  public final static int amSASLDigestMD5 = 5;
  public final static int amKerberos = 6;
  public final static int amXOAUTH2 = 7;

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 (SHTMLMailer Class)

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

Syntax

public String getBCc();
public void setBCc(String BCc);

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 class 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 (SHTMLMailer Class)

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

Syntax

public String getCc();
public void setCc(String cc);

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 class 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.

Certificate Property (SHTMLMailer Class)

This property includes the current selected certificate.

Syntax

public Certificate getCertificate();
public void setCertificate(Certificate certificate);

Remarks

This property is populated when a specified certificate is found or loaded by the class. This property is used to specify private keys. Set this property to a valid Certificate object to perform different operations, such as Sign, Decrypt, SignAndEncrypt, or DecryptAndVerifySignature.

Connected Property (SHTMLMailer Class)

Whether the class is connected.

Syntax

public boolean isConnected();

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

DeliveryNotificationTo Property (SHTMLMailer Class)

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

Syntax

public String getDeliveryNotificationTo();
public void setDeliveryNotificationTo(String deliveryNotificationTo);

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.

EncryptingAlgorithm Property (SHTMLMailer Class)

The property includes textual description of the encrypting algorithm.

Syntax

public String getEncryptingAlgorithm();
public void setEncryptingAlgorithm(String encryptingAlgorithm);

Default Value

"3DES"

Remarks

This property contains either the name of the algorithm (such as 3DES or AES), or an object identifier (OID) string representing the algorithm.

Possible values are as follows:

• "3DES"
• "DES"
• "RC2CBC40"
• "RC2CBC64"
• "RC2CBC128" or "RC2"
• "AESCBC128" or "AES"
• "AESCBC192"
• "AESCBC256"
• "AESGCM128" or "AESGCM"
• "AESGCM192"
• "AESGCM256"

Firewall Property (SHTMLMailer Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();
public void setFirewall(Firewall firewall);

Remarks

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

From Property (SHTMLMailer Class)

This property includes the email address of the sender (required).

Syntax

public String getFrom();
public void setFrom(String from);

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 as follows: "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 (SHTMLMailer Class)

This property includes the path to a local HTML file.

Syntax

public String getHTMLFile();
public void setHTMLFile(String HTMLFile);

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 (SHTMLMailer Class)

The current status of the class.

Syntax

public boolean isIdle();

Default Value

True

Remarks

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

This property is read-only.

Images Property (SHTMLMailer Class)

This property includes the embedded images in the HTML message.

Syntax

public HTMLImageList getImages();
public void setImages(HTMLImageList images);

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 size -1.

Importance Property (SHTMLMailer Class)

This property indicates the importance of the mail message (optional).

Syntax

public int getImportance();
public void setImportance(int importance);

Enumerated values:
  public final static int miUnspecified = 0;
  public final static int miHigh = 1;
  public final static int miNormal = 2;
  public final static int miLow = 3;

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 the level of importance of the message. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).

IncludeCertificate Property (SHTMLMailer Class)

This property specifies whether to include the signer's certificate with the signed message.

Syntax

public boolean isIncludeCertificate();
public void setIncludeCertificate(boolean includeCertificate);

Default Value

True

Remarks

If this property is set to True, the certificate used to sign the message will be encoded and included in a message signature when calling Sign or SignAndEncrypt.

Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.

IncludeChain Property (SHTMLMailer Class)

This property specifies whether to include the signer's certificate chain with the signed message.

Syntax

public boolean isIncludeChain();
public void setIncludeChain(boolean includeChain);

Default Value

False

Remarks

If this property is set to True, the entire certificate's chain that was used to sign the message will be encoded and included in the message signature when calling Sign or SignAndEncrypt.

Note: To include the chain, the IncludeCertificate property must also be set to true.

LastReply Property (SHTMLMailer Class)

This property indicates the last reply received from the server.

Syntax

public String getLastReply();

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 also can be retrieved through the PITrail event.

This property is read-only.

LocalHost Property (SHTMLMailer Class)

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

Syntax

public String getLocalHost();
public void setLocalHost(String localHost);

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class 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 multihomed 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 (SHTMLMailer Class)

This property includes the server port for SMTP (default 25).

Syntax

public int getMailPort();
public void setMailPort(int mailPort);

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 an implicit Secure Sockets Layer (SSL), use port 465 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

MailServer Property (SHTMLMailer Class)

This property includes the name or address of a mail server (mail relay).

Syntax

public String getMailServer();
public void setMailServer(String mailServer);

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 class 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 (e.g., a UNIX host), 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. 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 class 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 (SHTMLMailer Class)

This property includes the date of the mail message (optional).

Syntax

public String getMessageDate();
public void setMessageDate(String messageDate);

Default Value

"*"

Remarks

If this property contains a nonempty 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 class

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 (SHTMLMailer Class)

This property includes the HTML version of the message.

Syntax

public String getMessageHTML();
public void setMessageHTML(String messageHTML);

Default Value

""

Remarks

This property contains the HTML version of the message.

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

Example. Setting MessageHTML:

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

MessageId Property (SHTMLMailer Class)

This property includes the message identifier for the message.

Syntax

public String getMessageId();
public void setMessageId(String messageId);

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 (SHTMLMailer Class)

This property includes the collection of recipients of the message.

Syntax

public MessageRecipientList getMessageRecipients();
public void setMessageRecipients(MessageRecipientList messageRecipients);

Remarks

This property contains a collection that 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 size -1.

MessageText Property (SHTMLMailer Class)

This property includes the plaintext version of the message.

Syntax

public String getMessageText();
public void setMessageText(String messageText);

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 class 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 (SHTMLMailer Class)

This property includes an RFC 822-compliant string consisting of extra headers.

Syntax

public String getOtherHeaders();
public void setOtherHeaders(String otherHeaders);

Default Value

""

Remarks

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

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 class. 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. Sending an Email with an 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 (SHTMLMailer Class)

This property controls the behavior of the MessageHTML property.

Syntax

public boolean isParseHTML();
public void setParseHTML(boolean parseHTML);

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 (SHTMLMailer Class)

This property includes a password for logon to the MailServer .

Syntax

public String getPassword();
public void setPassword(String password);

Default Value

""

Remarks

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

This property is not available at design time.

Priority Property (SHTMLMailer Class)

This property includes the priority of the mail message (optional).

Syntax

public int getPriority();
public void setPriority(int priority);

Enumerated values:
  public final static int epUnspecified = 0;
  public final static int epNormal = 1;
  public final static int epUrgent = 2;
  public final static int epNonUrgent = 3;

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 (SHTMLMailer Class)

This property includes the email address to send a read-receipt to.

Syntax

public String getReadReceiptTo();
public void setReadReceiptTo(String readReceiptTo);

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 that should receive the read-receipt.

ReplyTo Property (SHTMLMailer Class)

This property includes a mail address to which to reply (optional).

Syntax

public String getReplyTo();
public void setReplyTo(String replyTo);

Default Value

""

Remarks

If this property contains a nonempty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies, which is 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 (SHTMLMailer Class)

This property includes a comma-separated list of addresses for destinations (required).

Syntax

public String getSendTo();
public void setSendTo(String sendTo);

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 as follows: "Friendly Name" <address@company.com> or address@company.com

The class 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 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.

Sensitivity Property (SHTMLMailer Class)

This property indicates the sensitivity of the mail message (optional).

Syntax

public int getSensitivity();
public void setSensitivity(int sensitivity);

Enumerated values:
  public final static int esUnspecified = 0;
  public final static int esPersonal = 1;
  public final static int esPrivate = 2;
  public final static int esCompanyConfidential = 3;

Default Value

0

Remarks

This property provides 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 as follows: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

SigningAlgorithm Property (SHTMLMailer Class)

This property includes a textual description of the signature hash algorithm.

Syntax

public String getSigningAlgorithm();
public void setSigningAlgorithm(String signingAlgorithm);

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm used to prepare the message digest for signature.

This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:

• sha1
• md5
• sha-256 (default)
• sha-384
• sha-512
• sha-224

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

SSLAcceptServerCert Property (SHTMLMailer Class)

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

Syntax

public Certificate getSSLAcceptServerCert();
public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class 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.

Note: This functionality is provided only for cases in which 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 (SHTMLMailer Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);

Remarks

This property includes the digital certificate that the class 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.

SSLEnabled Property (SHTMLMailer Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

public boolean isSSLEnabled();
public void setSSLEnabled(boolean SSLEnabled);

Default Value

False

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

SSLProvider Property (SHTMLMailer Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

public int getSSLProvider();
public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

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 class 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 as follows:

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

SSLServerCert Property (SHTMLMailer Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

This property 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 (SHTMLMailer Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Syntax

public int getSSLStartMode();
public void setSSLStartMode(int SSLStartMode);

Enumerated values:
  public final static int sslAutomatic = 0;
  public final static int sslImplicit = 1;
  public final static int sslExplicit = 2;
  public final static int sslNone = 3;

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Subject Property (SHTMLMailer Class)

This property includes the subject of the mail message (optional).

Syntax

public String getSubject();
public void setSubject(String subject);

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 (SHTMLMailer Class)

The timeout for the class.

Syntax

public int getTimeout();
public void setTimeout(int timeout);

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 class will wait for the operation to complete before returning control.

The class 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 class throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, 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 (SHTMLMailer Class)

This property includes the user identifier needed to log in as in the MailServer .

Syntax

public String getUser();
public void setUser(String user);

Default Value

""

Remarks

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

This property is not available at design time.

AddAttachment Method (SHTMLMailer Class)

This adds FileName as an attachment.

Syntax

public void addAttachment(String fileName);

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"));

AddRecipientCert Method (SHTMLMailer Class)

This method is used to add recipient certificates used to encrypt messages.

Syntax

public void addRecipientCert(byte[] certEncoded);

Remarks

This method is used to add recipient certificates to the internal MessageRecipients collection used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.

The CertMgr class may be used to retrieve the appropriate certificate from the system.

CalcMessageText Method (SHTMLMailer Class)

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

Syntax

public void calcMessageText();

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 class 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 (SHTMLMailer Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (SHTMLMailer Class)

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

Syntax

public void connect();

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 (SHTMLMailer Class)

This method disconnects from the SMTP server.

Syntax

public void disconnect();

Remarks

This method disconnects from the mail relay.

DoEvents Method (SHTMLMailer Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

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

Encrypt Method (SHTMLMailer Class)

This method encrypts the message.

Syntax

public void encrypt();

Remarks

This method encrypts the input message in a Public Key Cryptography Standards (PKCS)-encoded envelope with all of the recipient certificates specified in the MessageRecipients collection.

Note: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.

Interrupt Method (SHTMLMailer Class)

This method interrupts the current method.

Syntax

public void interrupt();

Remarks

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

ProcessQueue Method (SHTMLMailer Class)

This method sends the messages that previously have been queued into QueueDir .

Syntax

public void processQueue(String queueDir);

Remarks

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

This method looks in the directory for files with the 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 (SHTMLMailer Class)

This method queues the message into QueueDir .

Syntax

public String queue(String queueDir);

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.

This 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 (SHTMLMailer Class)

This method will reset the class.

Syntax

public void reset();

Remarks

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

ResetHeaders Method (SHTMLMailer Class)

This method resets all the message headers to empty.

Syntax

public void resetHeaders();

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 (SHTMLMailer Class)

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

Syntax

public void send();

Remarks

This method sends the current message and MIME-encoded attachment. If the class 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 class 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 (SHTMLMailer Class)

This method sends the exact command directly to the server.

Syntax

public void sendCommand(String command);

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 or monitor the PITrail event to obtain the server's response.

SetMessageHTMLStream Method (SHTMLMailer Class)

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

Syntax

public void setMessageHTMLStream(java.io.InputStream messageStream);

Remarks

This method sets the stream from which the class will read the HTML version of the message. Once set, the class 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 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.

Sign Method (SHTMLMailer Class)

This method signs the current message.

Syntax

public void sign();

Remarks

This method digitally signs the input data with the certificate provided. Certificates are provided by specifying the Certificate property. The IncludeCertificate property allows you to specify whether to include the certificate when signing the message.

SignAndEncrypt Method (SHTMLMailer Class)

This method signs and encrypts the current message.

Syntax

public void signAndEncrypt();

Remarks

This method both signs and encrypts the input message into a single PKCS-encoded envelope.

Note: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity, and providing other headers for the S/MIME wrapper.

ConnectionStatus Event (SHTMLMailer Class)

Fired to indicate changes in the connection state.

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void connectionStatus(SHTMLMailerConnectionStatusEvent e) {}
  ...
}

public class SHTMLMailerConnectionStatusEvent {
  public String connectionEvent;
  public int statusCode;
  public String description;
}

Remarks

This 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 (SHTMLMailer Class)

This event is fired when the message text completes transferring.

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void endTransfer(SHTMLMailerEndTransferEvent e) {}
  ...
}

public class SHTMLMailerEndTransferEvent {
  public int direction;
}

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 (SHTMLMailer Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void error(SHTMLMailerErrorEvent e) {}
  ...
}

public class SHTMLMailerErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 (SHTMLMailer Class)

This event traces the commands sent to the mail server, and the respective replies.

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void PITrail(SHTMLMailerPITrailEvent e) {}
  ...
}

public class SHTMLMailerPITrailEvent {
  public int direction;
  public String message;
}

Remarks

The PITrail event is useful for debugging purposes. It shows all of 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 (SHTMLMailer Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void SSLServerAuthentication(SHTMLMailerSSLServerAuthenticationEvent e) {}
  ...
}

public class SHTMLMailerSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

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 (SHTMLMailer Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void SSLStatus(SHTMLMailerSSLStatusEvent e) {}
  ...
}

public class SHTMLMailerSSLStatusEvent {
  public String message;
}

Remarks

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

StartTransfer Event (SHTMLMailer Class)

This event is fired when the message text starts transferring.

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void startTransfer(SHTMLMailerStartTransferEvent e) {}
  ...
}

public class SHTMLMailerStartTransferEvent {
  public int direction;
}

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 (SHTMLMailer Class)

This event is fired when the message text is transferred to MailServer .

Syntax

public class DefaultSHTMLMailerEventListener implements SHTMLMailerEventListener {
  ...
  public void transfer(SHTMLMailerTransferEvent e) {}
  ...
}

public class SHTMLMailerTransferEvent {
  public int direction;
  public long bytesTransferred;
  public int percentDone;
  public byte[] text;
}

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 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

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

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

public FileAttachment();

public FileAttachment( fileName);

public FileAttachment( name,  fileName);

public FileAttachment( name,  inputStream);

public FileAttachment( name,  inputStream,  encoding);

Firewall Type

The firewall the class 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

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

public HTMLImage();

public HTMLImage( file);

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 class is sending the message.

Fields

Constructors

public MessageRecipient();

public MessageRecipient( address);

public MessageRecipient( address,  recipientType);

Config Settings (SHTMLMailer Class)

HTMLMailer Config Settings

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (SHTMLMailer Class)

HTMLMailer Errors

MIME Errors

SMTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors