SHTMLMailer Module

Properties   Methods   Events   Config Settings   Errors  

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

AttachmentsThis property contains paths of the files to attach to the message.
AuthMechanismThis property is used when connecting to the mail server.
BCcThis property includes a comma-separated list of addresses for blind carbon copies (optional).
CcThis property includes a comma-separated list of addresses for carbon copies (optional).
CertificateThis property includes the current selected certificate.
ConnectedWhether the module is connected.
DeliveryNotificationToThis property includes the email address to which to send a delivery notification.
EncryptingAlgorithmThe property includes textual description of the encrypting algorithm.
FirewallA set of properties related to firewall access.
FromThis property includes the email address of the sender (required).
HTMLFileThis property includes the path to a local HTML file.
IdleThe current status of the module.
ImagesThis property includes the embedded images in the HTML message.
ImportanceThis property indicates the importance of the mail message (optional).
IncludeCertificateThis property specifies whether to include the signer's certificate with the signed message.
IncludeChainThis property specifies whether to include the signer's certificate chain with the signed message.
LastReplyThis property indicates the last reply received from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPortThis property includes the server port for SMTP (default 25).
MailServerThis property includes the name or address of a mail server (mail relay).
MessageDateThis property includes the date of the mail message (optional).
MessageHTMLThis property includes the HTML version of the message.
MessageIdThis property includes the message identifier for the message.
MessageRecipientsThis property includes the collection of recipients of the message.
MessageTextThis property includes the plaintext version of the message.
OtherHeadersThis property includes an RFC 822-compliant string consisting of extra headers.
ParseHTMLThis property controls the behavior of the MessageHTML property.
PasswordThis property includes a password for logon to the MailServer .
PriorityThis property includes the priority of the mail message (optional).
ReadReceiptToThis property includes the email address to send a read-receipt to.
ReplyToThis property includes a mail address to which to reply (optional).
SendToThis property includes a comma-separated list of addresses for destinations (required).
SensitivityThis property indicates the sensitivity of the mail message (optional).
SigningAlgorithmThis property includes a textual description of the signature hash algorithm.
SSLAcceptServerCertInstructs the module to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLEnabledThis property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
SSLProviderThe Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCertThe server certificate for the last established connection.
SSLStartModeThis property determines how the module starts the Secure Sockets Layer (SSL) negotiation.
SubjectThis property includes the subject of the mail message (optional).
TimeoutThe timeout for the module.
UserThis property includes the user identifier needed to log in as in the MailServer .

Method List

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

AddAttachmentThis adds FileName as an attachment.
AddRecipientCertThis method is used to add recipient certificates used to encrypt messages.
CalcMessageTextThis method populates MessageText with the plaintext version of the message.
ConfigSets or retrieves a configuration setting.
ConnectThis method connects to the mail relay and sends the SMTP HELO command.
DisconnectThis method disconnects from the SMTP server.
DoEventsThis method processes events from the internal message queue.
EncryptThis method encrypts the message.
InterruptThis method interrupts the current method.
ProcessQueueThis method sends the messages that previously have been queued into QueueDir .
QueueThis method queues the message into QueueDir .
ResetThis method will reset the module.
ResetHeadersThis method resets all the message headers to empty.
SendThis method sends the current message and MIME-encoded attachment.
SendCommandThis method sends the exact command directly to the server.
SignThis method signs the current message.
SignAndEncryptThis method signs and encrypts the current message.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

ConnectionStatusFired to indicate changes in the connection state.
EndTransferThis event is fired when the message text completes transferring.
ErrorFired when information is available about errors during data delivery.
PITrailThis event traces the commands sent to the mail server, and the respective replies.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StartTransferThis event is fired when the message text starts transferring.
TransferThis event is fired when the message text is transferred to MailServer .

Config Settings

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

AttachmentEncoding[index]Content-Transfer-Encoding for attached file (at index).
AttachmentText[index]Add the text into the attachment at the specified index.
AttachmentType[index]Content-type for attached file (at index).
CharsetWhen set, the charset Content-Type attribute will be added using the specified value.
ExcludeTagsSpecifies tags that will be excluded when calculating MessageText.
MessageTextEncodingWhen set, the MessageHTML and MessageText values will be encoded using the specified encoding.
OverrideFileNameIf set to true, the AttachmentName property value will be used to set the MIME part FileName attribute.
TempFilePathIf set, the temporary files created during message creation will be put in the path specified.
UseTempFileDetermines if temporary files are used during message creation.
UseTempFileIf set, the module uses temporary files when generating messages.
AllowEmptyToIf set to True, then the SendTo property is not required.
AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
CharsetWhen set, the message headers will be encoded using the specified Charset.
HelloThe argument for HELO (herald) command to the server (defaults to local host name).
KeepQueueIf set to True, queued files are not deleted after a successful send.
MaxHeaderLengthMaximum length for headers to avoid line folding (default 80).
MessageHeadersStringString representation of RFC822-encoded headers of the message.
MessageIdAlgorithmDetermines the algorithm used to hash the random MessageId.
OtherHeadersAn RFC 822 compliant string consisting of extra headers.
ReturnPathSets the Return-Path to be used for sending email.
SendRSETWhether to send RSET command.
StopOnBccErrorsInstructs the module to stop sending the message if the server does not acknowledge any of the BCCs.
StopOnCcErrorsInstructs the module to stop sending the message if the server does not acknowledge any of the CCs.
StopOnToErrorsInstructs the module to stop sending the message if the server does not acknowledge any of the TOs.
TransferTextString representation of RFC822-encoded body of the message.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the module binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLClientCACertsA newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Attachments Property (SHTMLMailer Module)

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

Syntax

public var attachments: Array<FileAttachment> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=attachmentCount,setter=setAttachmentCount:) int attachmentCount;

- (int)attachmentCount;
- (void)setAttachmentCount :(int)newAttachmentCount;

- (NSString*)attachmentData:(int)attachmentIndex;
- (void)setAttachmentData:(int)attachmentIndex :(NSString*)newAttachmentData;

- (NSData*)attachmentDataB:(int)attachmentIndex;
- (void)setAttachmentDataB:(int)attachmentIndex :(NSData*)newAttachmentData;
- (NSString*)attachmentFileName:(int)attachmentIndex;
- (void)setAttachmentFileName:(int)attachmentIndex :(NSString*)newAttachmentFileName;

- (NSString*)attachmentName:(int)attachmentIndex;
- (void)setAttachmentName:(int)attachmentIndex :(NSString*)newAttachmentName;

Default Value

""

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 3: Using an Attachments Array

component.AttachmentCount = 1; component.AttachmentName(0) = "name"; component.AttachmentFile(0) = "C:\file.txt";

AuthMechanism Property (SHTMLMailer Module)

This property is used when connecting to the mail server.

Syntax

public var authMechanism: SHTMLMailerAuthMechanisms {
  get {...}
  set {...}
}

public enum SHTMLMailerAuthMechanisms: Int32 {
  case amUserPassword = 0
  case amCRAMMD5 = 1
  case amNTLM = 2
  case amAPOP = 3
  case amSASLPlain = 4
  case amSASLDigestMD5 = 5
  case amKerberos = 6
  case amXOAUTH2 = 7
}


@property (nonatomic,readwrite,assign,getter=authMechanism,setter=setAuthMechanism:) int authMechanism;

- (int)authMechanism;
- (void)setAuthMechanism :(int)newAuthMechanism;

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

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

Syntax

public var bcc: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=BCc,setter=setBCc:) NSString* BCc;

- (NSString*)BCc;
- (void)setBCc :(NSString*)newBCc;

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 properties before setting this property to remove previous recipients.

Cc Property (SHTMLMailer Module)

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

Syntax

public var cc: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=cc,setter=setCc:) NSString* cc;

- (NSString*)cc;
- (void)setCc :(NSString*)newCc;

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 properties before setting this property to remove previous recipients.

Certificate Property (SHTMLMailer Module)

This property includes the current selected certificate.

Syntax

public var certificate: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=certEffectiveDate) NSString* certEffectiveDate;

- (NSString*)certEffectiveDate;

@property (nonatomic,readonly,assign,getter=certExpirationDate) NSString* certExpirationDate;

- (NSString*)certExpirationDate;

@property (nonatomic,readonly,assign,getter=certExtendedKeyUsage) NSString* certExtendedKeyUsage;

- (NSString*)certExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=certFingerprint) NSString* certFingerprint;

- (NSString*)certFingerprint;

@property (nonatomic,readonly,assign,getter=certFingerprintSHA1) NSString* certFingerprintSHA1;

- (NSString*)certFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=certFingerprintSHA256) NSString* certFingerprintSHA256;

- (NSString*)certFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=certIssuer) NSString* certIssuer;

- (NSString*)certIssuer;

@property (nonatomic,readonly,assign,getter=certPrivateKey) NSString* certPrivateKey;

- (NSString*)certPrivateKey;

@property (nonatomic,readonly,assign,getter=certPrivateKeyAvailable) BOOL certPrivateKeyAvailable;

- (BOOL)certPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=certPrivateKeyContainer) NSString* certPrivateKeyContainer;

- (NSString*)certPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=certPublicKey) NSString* certPublicKey;

- (NSString*)certPublicKey;

@property (nonatomic,readonly,assign,getter=certPublicKeyAlgorithm) NSString* certPublicKeyAlgorithm;

- (NSString*)certPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=certPublicKeyLength) int certPublicKeyLength;

- (int)certPublicKeyLength;

@property (nonatomic,readonly,assign,getter=certSerialNumber) NSString* certSerialNumber;

- (NSString*)certSerialNumber;

@property (nonatomic,readonly,assign,getter=certSignatureAlgorithm) NSString* certSignatureAlgorithm;

- (NSString*)certSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=certStore,setter=setCertStore:) NSString* certStore;

- (NSString*)certStore;
- (void)setCertStore :(NSString*)newCertStore;

@property (nonatomic,readwrite,assign,getter=certStoreB,setter=setCertStoreB:) NSData* certStoreB;

- (NSData*)certStoreB;
- (void)setCertStoreB :(NSData*)newCertStore;
@property (nonatomic,readwrite,assign,getter=certStorePassword,setter=setCertStorePassword:) NSString* certStorePassword;

- (NSString*)certStorePassword;
- (void)setCertStorePassword :(NSString*)newCertStorePassword;

@property (nonatomic,readwrite,assign,getter=certStoreType,setter=setCertStoreType:) int certStoreType;

- (int)certStoreType;
- (void)setCertStoreType :(int)newCertStoreType;

@property (nonatomic,readonly,assign,getter=certSubjectAltNames) NSString* certSubjectAltNames;

- (NSString*)certSubjectAltNames;

@property (nonatomic,readonly,assign,getter=certThumbprintMD5) NSString* certThumbprintMD5;

- (NSString*)certThumbprintMD5;

@property (nonatomic,readonly,assign,getter=certThumbprintSHA1) NSString* certThumbprintSHA1;

- (NSString*)certThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=certThumbprintSHA256) NSString* certThumbprintSHA256;

- (NSString*)certThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=certUsage) NSString* certUsage;

- (NSString*)certUsage;

@property (nonatomic,readonly,assign,getter=certUsageFlags) int certUsageFlags;

- (int)certUsageFlags;

@property (nonatomic,readonly,assign,getter=certVersion) NSString* certVersion;

- (NSString*)certVersion;

@property (nonatomic,readwrite,assign,getter=certSubject,setter=setCertSubject:) NSString* certSubject;

- (NSString*)certSubject;
- (void)setCertSubject :(NSString*)newCertSubject;

@property (nonatomic,readwrite,assign,getter=certEncoded,setter=setCertEncoded:) NSString* certEncoded;

- (NSString*)certEncoded;
- (void)setCertEncoded :(NSString*)newCertEncoded;

@property (nonatomic,readwrite,assign,getter=certEncodedB,setter=setCertEncodedB:) NSData* certEncodedB;

- (NSData*)certEncodedB;
- (void)setCertEncodedB :(NSData*)newCertEncoded;

Default Value

""

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

Whether the module is connected.

Syntax

public var connected: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=connected) BOOL connected;

- (BOOL)connected;

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.

DeliveryNotificationTo Property (SHTMLMailer Module)

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

Syntax

public var deliveryNotificationTo: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=deliveryNotificationTo,setter=setDeliveryNotificationTo:) NSString* deliveryNotificationTo;

- (NSString*)deliveryNotificationTo;
- (void)setDeliveryNotificationTo :(NSString*)newDeliveryNotificationTo;

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

The property includes textual description of the encrypting algorithm.

Syntax

public var encryptingAlgorithm: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=encryptingAlgorithm,setter=setEncryptingAlgorithm:) NSString* encryptingAlgorithm;

- (NSString*)encryptingAlgorithm;
- (void)setEncryptingAlgorithm :(NSString*)newEncryptingAlgorithm;

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

A set of properties related to firewall access.

Syntax

public var firewall: Firewall {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

Default Value

""

Remarks

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

From Property (SHTMLMailer Module)

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

Syntax

public var from: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=from,setter=setFrom:) NSString* from;

- (NSString*)from;
- (void)setFrom :(NSString*)newFrom;

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

This property includes the path to a local HTML file.

Syntax

public var htmlFile: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=HTMLFile,setter=setHTMLFile:) NSString* HTMLFile;

- (NSString*)HTMLFile;
- (void)setHTMLFile :(NSString*)newHTMLFile;

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.

Idle Property (SHTMLMailer Module)

The current status of the module.

Syntax

public var idle: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

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

This property includes the embedded images in the HTML message.

Syntax

public var images: Array<HTMLImage> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=imageCount,setter=setImageCount:) int imageCount;

- (int)imageCount;
- (void)setImageCount :(int)newImageCount;

- (NSString*)imageData:(int)imageIndex;
- (void)setImageData:(int)imageIndex :(NSString*)newImageData;

- (NSData*)imageDataB:(int)imageIndex;
- (void)setImageDataB:(int)imageIndex :(NSData*)newImageData;
- (NSString*)imageFile:(int)imageIndex;
- (void)setImageFile:(int)imageIndex :(NSString*)newImageFile;

- (NSString*)imageId:(int)imageIndex;
- (void)setImageId:(int)imageIndex :(NSString*)newImageId;

- (NSString*)imageType:(int)imageIndex;
- (void)setImageType:(int)imageIndex :(NSString*)newImageType;

Default Value

""

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

Importance Property (SHTMLMailer Module)

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

Syntax

public var importance: SHTMLMailerImportances {
  get {...}
  set {...}
}

public enum SHTMLMailerImportances: Int32 {
  case miUnspecified = 0
  case miHigh = 1
  case miNormal = 2
  case miLow = 3
}


@property (nonatomic,readwrite,assign,getter=importance,setter=setImportance:) int importance;

- (int)importance;
- (void)setImportance :(int)newImportance;

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

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

Syntax

public var includeCertificate: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=includeCertificate,setter=setIncludeCertificate:) BOOL includeCertificate;

- (BOOL)includeCertificate;
- (void)setIncludeCertificate :(BOOL)newIncludeCertificate;

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

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

Syntax

public var includeChain: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=includeChain,setter=setIncludeChain:) BOOL includeChain;

- (BOOL)includeChain;
- (void)setIncludeChain :(BOOL)newIncludeChain;

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

This property indicates the last reply received from the server.

Syntax

public var lastReply: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=lastReply) NSString* lastReply;

- (NSString*)lastReply;

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

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

Syntax

public var localHost: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

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

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

Syntax

public var mailPort: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=mailPort,setter=setMailPort:) int mailPort;

- (int)mailPort;
- (void)setMailPort :(int)newMailPort;

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

MailServer Property (SHTMLMailer Module)

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

Syntax

public var mailServer: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=mailServer,setter=setMailServer:) NSString* mailServer;

- (NSString*)mailServer;
- (void)setMailServer :(NSString*)newMailServer;

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

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

Syntax

public var messageDate: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=messageDate,setter=setMessageDate:) NSString* messageDate;

- (NSString*)messageDate;
- (void)setMessageDate :(NSString*)newMessageDate;

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

MessageHTML Property (SHTMLMailer Module)

This property includes the HTML version of the message.

Syntax

public var messageHTML: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=messageHTML,setter=setMessageHTML:) NSString* messageHTML;

- (NSString*)messageHTML;
- (void)setMessageHTML :(NSString*)newMessageHTML;

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

This property includes the message identifier for the message.

Syntax

public var messageId: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=messageId,setter=setMessageId:) NSString* messageId;

- (NSString*)messageId;
- (void)setMessageId :(NSString*)newMessageId;

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.

MessageRecipients Property (SHTMLMailer Module)

This property includes the collection of recipients of the message.

Syntax

public var messageRecipients: Array<MessageRecipient> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=messageRecipientCount,setter=setMessageRecipientCount:) int messageRecipientCount;

- (int)messageRecipientCount;
- (void)setMessageRecipientCount :(int)newMessageRecipientCount;

- (NSString*)messageRecipientAddress:(int)recipientIndex;
- (void)setMessageRecipientAddress:(int)recipientIndex :(NSString*)newMessageRecipientAddress;

- (NSString*)messageRecipientName:(int)recipientIndex;
- (void)setMessageRecipientName:(int)recipientIndex :(NSString*)newMessageRecipientName;

- (NSString*)messageRecipientOptions:(int)recipientIndex;
- (void)setMessageRecipientOptions:(int)recipientIndex :(NSString*)newMessageRecipientOptions;

- (int)messageRecipientType:(int)recipientIndex;
- (void)setMessageRecipientType:(int)recipientIndex :(int)newMessageRecipientType;

Default Value

""

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.

MessageText Property (SHTMLMailer Module)

This property includes the plaintext version of the message.

Syntax

public var messageText: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=messageText,setter=setMessageText:) NSString* messageText;

- (NSString*)messageText;
- (void)setMessageText :(NSString*)newMessageText;

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

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

Syntax

public var otherHeaders: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders :(NSString*)newOtherHeaders;

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 .

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

ParseHTML Property (SHTMLMailer Module)

This property controls the behavior of the MessageHTML property.

Syntax

public var parseHTML: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=parseHTML,setter=setParseHTML:) BOOL parseHTML;

- (BOOL)parseHTML;
- (void)setParseHTML :(BOOL)newParseHTML;

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

This property includes a password for logon to the MailServer .

Syntax

public var password: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

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.

Priority Property (SHTMLMailer Module)

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

Syntax

public var priority: SHTMLMailerPriorities {
  get {...}
  set {...}
}

public enum SHTMLMailerPriorities: Int32 {
  case epUnspecified = 0
  case epNormal = 1
  case epUrgent = 2
  case epNonUrgent = 3
}


@property (nonatomic,readwrite,assign,getter=priority,setter=setPriority:) int priority;

- (int)priority;
- (void)setPriority :(int)newPriority;

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

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

Syntax

public var readReceiptTo: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=readReceiptTo,setter=setReadReceiptTo:) NSString* readReceiptTo;

- (NSString*)readReceiptTo;
- (void)setReadReceiptTo :(NSString*)newReadReceiptTo;

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

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

Syntax

public var replyTo: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=replyTo,setter=setReplyTo:) NSString* replyTo;

- (NSString*)replyTo;
- (void)setReplyTo :(NSString*)newReplyTo;

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

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

Syntax

public var sendTo: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=sendTo,setter=setSendTo:) NSString* sendTo;

- (NSString*)sendTo;
- (void)setSendTo :(NSString*)newSendTo;

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 properties before setting this property to remove previous recipients.

Sensitivity Property (SHTMLMailer Module)

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

Syntax

public var sensitivity: SHTMLMailerSensitivities {
  get {...}
  set {...}
}

public enum SHTMLMailerSensitivities: Int32 {
  case esUnspecified = 0
  case esPersonal = 1
  case esPrivate = 2
  case esCompanyConfidential = 3
}


@property (nonatomic,readwrite,assign,getter=sensitivity,setter=setSensitivity:) int sensitivity;

- (int)sensitivity;
- (void)setSensitivity :(int)newSensitivity;

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

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

Syntax

public var signingAlgorithm: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=signingAlgorithm,setter=setSigningAlgorithm:) NSString* signingAlgorithm;

- (NSString*)signingAlgorithm;
- (void)setSigningAlgorithm :(NSString*)newSigningAlgorithm;

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

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

Syntax

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate;

- (NSString*)SSLAcceptServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate;

- (NSString*)SSLAcceptServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage;

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint;

- (NSString*)SSLAcceptServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1;

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256;

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer;

- (NSString*)SSLAcceptServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey;

- (NSString*)SSLAcceptServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable;

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer;

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey;

- (NSString*)SSLAcceptServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm;

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength;

- (int)SSLAcceptServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber;

- (NSString*)SSLAcceptServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm;

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames;

- (NSString*)SSLAcceptServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5;

- (NSString*)SSLAcceptServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1;

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256;

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage;

- (NSString*)SSLAcceptServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags;

- (int)SSLAcceptServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion;

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

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

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

Syntax

public var sslCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate;

- (NSString*)SSLCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate;

- (NSString*)SSLCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage;

- (NSString*)SSLCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint;

- (NSString*)SSLCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1;

- (NSString*)SSLCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256;

- (NSString*)SSLCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer;

- (NSString*)SSLCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey;

- (NSString*)SSLCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable;

- (BOOL)SSLCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer;

- (NSString*)SSLCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey;

- (NSString*)SSLCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm;

- (NSString*)SSLCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength;

- (int)SSLCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber;

- (NSString*)SSLCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm;

- (NSString*)SSLCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames;

- (NSString*)SSLCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5;

- (NSString*)SSLCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1;

- (NSString*)SSLCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256;

- (NSString*)SSLCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage;

- (NSString*)SSLCertUsage;

@property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags;

- (int)SSLCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion;

- (NSString*)SSLCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

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 field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLEnabled Property (SHTMLMailer Module)

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

Syntax

public var sslEnabled: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSLEnabled,setter=setSSLEnabled:) BOOL SSLEnabled;

- (BOOL)SSLEnabled;
- (void)setSSLEnabled :(BOOL)newSSLEnabled;

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.

SSLProvider Property (SHTMLMailer Module)

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

Syntax

public var sslProvider: SHTMLMailerSSLProviders {
  get {...}
  set {...}
}

public enum SHTMLMailerSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}


@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

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 will be used by default in all cases in the macOS edition.

SSLServerCert Property (SHTMLMailer Module)

The server certificate for the last established connection.

Syntax

public var sslServerCert: Certificate {
  get {...}
}


@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate;

- (NSString*)SSLServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate;

- (NSString*)SSLServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage;

- (NSString*)SSLServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint;

- (NSString*)SSLServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1;

- (NSString*)SSLServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256;

- (NSString*)SSLServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer;

- (NSString*)SSLServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey;

- (NSString*)SSLServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable;

- (BOOL)SSLServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer;

- (NSString*)SSLServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey;

- (NSString*)SSLServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm;

- (NSString*)SSLServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength;

- (int)SSLServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber;

- (NSString*)SSLServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm;

- (NSString*)SSLServerCertSignatureAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore;

- (NSString*)SSLServerCertStore;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB;

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType;

- (int)SSLServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames;

- (NSString*)SSLServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5;

- (NSString*)SSLServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1;

- (NSString*)SSLServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256;

- (NSString*)SSLServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage;

- (NSString*)SSLServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags;

- (int)SSLServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion;

- (NSString*)SSLServerCertVersion;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject;

- (NSString*)SSLServerCertSubject;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

SSLStartMode Property (SHTMLMailer Module)

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

Syntax

public var sslStartMode: SHTMLMailerSSLStartModes {
  get {...}
  set {...}
}

public enum SHTMLMailerSSLStartModes: Int32 {
  case sslAutomatic = 0
  case sslImplicit = 1
  case sslExplicit = 2
  case sslNone = 3
}


@property (nonatomic,readwrite,assign,getter=SSLStartMode,setter=setSSLStartMode:) int SSLStartMode;

- (int)SSLStartMode;
- (void)setSSLStartMode :(int)newSSLStartMode;

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

0 (sslAutomatic)If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)The class will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone - default)No SSL negotiation; no SSL security. All communication will be in plaintext mode.

Subject Property (SHTMLMailer Module)

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

Syntax

public var subject: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=subject,setter=setSubject:) NSString* subject;

- (NSString*)subject;
- (void)setSubject :(NSString*)newSubject;

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

The timeout for the module.

Syntax

public var timeout: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

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

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

Syntax

public var user: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser :(NSString*)newUser;

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.

AddAttachment Method (SHTMLMailer Module)

This adds FileName as an attachment.

Syntax

public func addAttachment(fileName: String) throws -> Void

- (void)addAttachment:(NSString*)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 3: Using an Attachments Array

component.AttachmentCount = 1; component.AttachmentName(0) = "name"; component.AttachmentFile(0) = "C:\file.txt";

AddRecipientCert Method (SHTMLMailer Module)

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

Syntax

public func addRecipientCert(certEncoded: Data) throws -> Void

- (void)addRecipientCert:(NSData*)certEncoded;

Remarks

This method is used to add recipient certificates to the internal MessageRecipients properties 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 Module)

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

Syntax

public func calcMessageText() throws -> Void

- (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 Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 Module)

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

Syntax

public func connect() throws -> Void

- (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 Module)

This method disconnects from the SMTP server.

Syntax

public func disconnect() throws -> Void

- (void)disconnect;

Remarks

This method disconnects from the mail relay.

DoEvents Method (SHTMLMailer Module)

This method processes events from the internal message queue.

Syntax

public func doEvents() throws -> Void

- (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 Module)

This method encrypts the message.

Syntax

public func encrypt() throws -> Void

- (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 properties.

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

This method interrupts the current method.

Syntax

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

ProcessQueue Method (SHTMLMailer Module)

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

Syntax

public func processQueue(queueDir: String) throws -> Void

- (void)processQueue:(NSString*)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 Module)

This method queues the message into QueueDir .

Syntax

public func queue(queueDir: String) throws -> String

- (NSString*)queue:(NSString*)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 Module)

This method will reset the component.

Syntax

public func reset() throws -> Void

- (void)reset;

Remarks

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

ResetHeaders Method (SHTMLMailer Module)

This method resets all the message headers to empty.

Syntax

public func resetHeaders() throws -> Void

- (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 Module)

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

Syntax

public func send() throws -> Void

- (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 Module)

This method sends the exact command directly to the server.

Syntax

public func sendCommand(command: String) throws -> Void

- (void)sendCommand:(NSString*)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.

Sign Method (SHTMLMailer Module)

This method signs the current message.

Syntax

public func sign() throws -> Void

- (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 Module)

This method signs and encrypts the current message.

Syntax

public func signAndEncrypt() throws -> Void

- (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 Module)

Fired to indicate changes in the connection state.

Syntax

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)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:

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.
StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

EndTransfer Event (SHTMLMailer Module)

This event is fired when the message text completes transferring.

Syntax

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(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 Module)

Fired when information is available about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

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

Syntax

func onPITrail(direction: Int32, message: String)

- (void)onPITrail:(int)direction :(NSString*)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:

0 (Client)The Message originates from the client.
1 (Server)The Message originates from the server.
2 (Info)The Message is an informative message originating from the client software (the class code).

SSLServerAuthentication Event (SHTMLMailer Module)

Fired after the server presents its certificate to the client.

Syntax

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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

Fired when secure connection progress messages are available.

Syntax

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

StartTransfer Event (SHTMLMailer Module)

This event is fired when the message text starts transferring.

Syntax

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(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 Module)

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

Syntax

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)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.

The following fields are available:
  • EffectiveDate
  • ExpirationDate
  • ExtendedKeyUsage
  • Fingerprint
  • FingerprintSHA1
  • FingerprintSHA256
  • Issuer
  • PrivateKey
  • PrivateKeyAvailable
  • PrivateKeyContainer
  • PublicKey
  • PublicKeyAlgorithm
  • PublicKeyLength
  • SerialNumber
  • SignatureAlgorithm
  • Store
  • StorePassword
  • StoreType
  • SubjectAltNames
  • ThumbprintMD5
  • ThumbprintSHA1
  • ThumbprintSHA256
  • Usage
  • UsageFlags
  • Version
  • Subject
  • Encoded

    • Fields

    effectiveDate
    String (read-only)
    Default Value: ""

    The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

    23-Jan-2000 15:00:00.

    expirationDate
    String (read-only)
    Default Value: ""

    The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

    23-Jan-2001 15:00:00.

    extendedKeyUsage
    String (read-only)
    Default Value: ""

    A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

    fingerprint
    String (read-only)
    Default Value: ""

    The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

    The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

    fingerprintSHA1
    String (read-only)
    Default Value: ""

    The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

    The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

    fingerprintSHA256
    String (read-only)
    Default Value: ""

    The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

    The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

    issuer
    String (read-only)
    Default Value: ""

    The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

    privateKey
    String (read-only)
    Default Value: ""

    The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

    Note: The may be available but not exportable. In this case, returns an empty string.

    privateKeyAvailable
    Bool (read-only)
    Default Value: False

    Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).

    privateKeyContainer
    String (read-only)
    Default Value: ""

    The name of the container for the certificate (if available). This functionality is available only on Windows platforms.

    publicKey
    String (read-only)
    Default Value: ""

    The public key of the certificate. The key is provided as PEM/Base64-encoded data.

    publicKeyAlgorithm
    String (read-only)
    Default Value: ""

    The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

    publicKeyLength
    Int32 (read-only)
    Default Value: 0

    The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

    serialNumber
    String (read-only)
    Default Value: ""

    The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

    signatureAlgorithm
    String (read-only)
    Default Value: ""

    The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

    storeB
    Data
    Default Value: "MY"

    The name of the certificate store for the client certificate.

    The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

    is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.

    Designations of certificate stores are platform dependent.

    The following designations are the most common User and Machine certificate stores in Windows:

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot certificates.

    When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

    store
    String
    Default Value: "MY"

    The name of the certificate store for the client certificate.

    The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

    is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.

    Designations of certificate stores are platform dependent.

    The following designations are the most common User and Machine certificate stores in Windows:

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot certificates.

    When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

    storePassword
    String
    Default Value: ""

    If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

    storeType
    CertStoreTypes
    Default Value: 0

    The type of certificate store for this certificate.

    The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

    0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

    Note: This store type is not available in Java.

    1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

    Note: This store type is not available in Java.

    2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
    3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
    4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

    Note: This store type is only available in Java.

    5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

    Note: This store type is only available in Java.

    6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
    7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
    8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
    9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
    10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
    11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
    12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
    13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
    14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
    15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
    16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
    17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
    18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
    19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
    21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

    Note: This store type is only available in Java and .NET.

    22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

    Note: This store type is only available in Java and .NET.

    23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

    To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

    When using a certificate, pass the previously saved security key information as the and set to the PIN.

    Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

    99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

    subjectAltNames
    String (read-only)
    Default Value: ""

    Comma-separated lists of alternative subject names for the certificate.

    thumbprintMD5
    String (read-only)
    Default Value: ""

    The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

    thumbprintSHA1
    String (read-only)
    Default Value: ""

    The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

    thumbprintSHA256
    String (read-only)
    Default Value: ""

    The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

    usage
    String (read-only)
    Default Value: ""

    The text description of .

    This value will be one or more of the following strings and will be separated by commas:

    • Digital Signature
    • Non-Repudiation
    • Key Encipherment
    • Data Encipherment
    • Key Agreement
    • Certificate Signing
    • CRL Signing
    • Encipher Only

    If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

    usageFlags
    Int32 (read-only)
    Default Value: 0

    The flags that show intended use for the certificate. The value of is a combination of the following flags:

    0x80Digital Signature
    0x40Non-Repudiation
    0x20Key Encipherment
    0x10Data Encipherment
    0x08Key Agreement
    0x04Certificate Signing
    0x02CRL Signing
    0x01Encipher Only

    Please see the property for a text representation of .

    This functionality currently is not available when the provider is OpenSSL.

    version
    String (read-only)
    Default Value: ""

    The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

    subject
    String
    Default Value: ""

    The subject of the certificate used for client authentication.

    This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

    If a matching certificate is found, the property is set to the full subject of the matching certificate.

    If an exact match is not found, the store is searched for subjects containing the value of the property.

    If a match is still not found, the property is set to an empty string, and no certificate is selected.

    The special value "*" picks a random certificate in the certificate store.

    The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

    FieldMeaning
    CNCommon Name. This is commonly a hostname like www.server.com.
    OOrganization
    OUOrganizational Unit
    LLocality
    SState
    CCountry
    EEmail Address

    If a field value contains a comma, it must be quoted.

    encodedB
    Data
    Default Value: ""

    The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.

    When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.

    encoded
    String
    Default Value: ""

    The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.

    When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.

    Constructors

    public init()

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

    public init(encoded: )

    Parses Encoded as an X.509 public key. 

    public init(storeType: , store: , storePassword: , subject: )

    StoreType identifies the type of certificate store to use. See 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 X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

    public init(storeType: , store: , storePassword: , subject: )

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array 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 X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

    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.

    The following fields are available:
  • Data
  • FileName
  • Name

    • Fields

    dataB
    Data
    Default Value: ""

    The raw data for the attachment that will be sent with your message. This field is used if is not set.

    data
    String
    Default Value: ""

    The raw data for the attachment that will be sent with your message. This field is used if is not set.

    fileName
    String
    Default Value: ""

    This property contains the path of a file on your system to be sent as an attachment with your message.

    name
    String
    Default Value: ""

    This property contains the name of the attachment to be sent.

    Constructors

    public init()

    public init(fileName: )

    public init(name: , fileName: )

    public init(name: , inputStream: )

    Firewall Type

    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 and the .

    The following fields are available:
  • AutoDetect
  • FirewallType
  • Host
  • Password
  • Port
  • User

    • Fields

    autoDetect
    Bool
    Default Value: False

    Whether to automatically detect and use firewall system settings, if available.

    firewallType
    FirewallTypes
    Default Value: 0

    The type of firewall to connect through. The applicable values are as follows:

    fwNone (0)No firewall (default setting).
    fwTunnel (1)Connect through a tunneling proxy. is set to 80.
    fwSOCKS4 (2)Connect through a SOCKS4 Proxy. is set to 1080.
    fwSOCKS5 (3)Connect through a SOCKS5 Proxy. is set to 1080.
    fwSOCKS4A (10)Connect through a SOCKS4A Proxy. is set to 1080.

    host
    String
    Default Value: ""

    The name or IP address of the firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting.

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

    password
    String
    Default Value: ""

    A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

    port
    Int32
    Default Value: 0

    The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details.

    Note: This property is set automatically when is set to a valid value. See the description of the property for details.

    user
    String
    Default Value: ""

    A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

    Constructors

    public init()

    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.

    The following fields are available:
  • Data
  • File
  • Id
  • ImageType

    • Fields

    dataB
    Data
    Default Value: ""

    This property optionally specifies the image data. This may be used instead of specifying an image by file. The value specified here may be either the hex-encoded image data or the raw unencoded image data.

    data
    String
    Default Value: ""

    This property optionally specifies the image data. This may be used instead of specifying an image by file. The value specified here may be either the hex-encoded image data or the raw unencoded image data.

    file
    String
    Default Value: ""

    This property contains the name of the image files embedded into the HTML message. This value 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).

    id
    String
    Default Value: ""

    This property contains the content identifier for embedded images. This value is computed automatically, unless ParseHTML is False, in which case you are responsible for providing it.

    imageType
    String
    Default Value: ""

    This property contains the content type for embedded images. This value is determined automatically, unless ParseHTML is False, in which case you are responsible for providing it.

    Constructors

    public init()

    public init(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.

    The following fields are available:
  • Address
  • Name
  • Options
  • RecipientType

    • Fields

    address
    String
    Default Value: ""

    This property contains the email address of the recipient.

    name
    String
    Default Value: ""

    This property contains the name of the recipient.

    options
    String
    Default Value: ""

    This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).

    One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.

    component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";

    recipientType
    EmailRecipientTypes
    Default Value: 0

    This property contains the recipient type: To, Cc, or Bcc.

    Constructors

    public init()

    public init(address: )

    Config Settings (SHTMLMailer Module)

    The class accepts one or more of the following configuration settings. Configuration 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.

    HTMLMailer Config Settings

    AttachmentEncoding[index]:   Content-Transfer-Encoding for attached file (at index).

    This configuration setting allows you to set the Content-Transfer-Encoding for each attached file in the Attachments array property. Valid array indices are from 0 to AttachmentCount -1. When set to one of the following integer values, the attachment will be encoded using the specified encoding. The following encodings are supported:

    07-bit
    1Quoted-Printable
    2Base64
    38-bit
    AttachmentText[index]:   Add the text into the attachment at the specified index.

    If this is set, text will be added into the attachment at the specified index. All data entered must be hex-encoded data. The class will then decode the hex-encoded data and insert the data into the attachment.

    AttachmentType[index]:   Content-type for attached file (at index).

    This configuration setting allows you to set the Content-Type for each attached file in the Attachments array property. Valid array indices are from 0 to AttachmentCount -1. To set the Content-Type for the attachment at index 2, you would set the string "AttachmentType[2]=application/octet-stream".

    Charset:   When set, the charset Content-Type attribute will be added using the specified value.

    This property is used to specify the "charset" Content-Type attribute for both the HTML (MessageHTML) and plain text (MessageText) part headers. The default value is "" (empty string) in which case the charset attribute will not be added to the Content-Type header.

    ExcludeTags:   Specifies tags that will be excluded when calculating MessageText.

    This property can be used to specify tags that will be excluded when the class calculates MessageText after MessageHTML has been set. Set this to a comma-separated list of tags, like "script,style". The default value is an empty string, so all tags will be included in MessageText.

    MessageTextEncoding:   When set, the MessageHTML and MessageText values will be encoded using the specified encoding.

    When set to one of the following integer values, both the MessageHTML and MessageText properties will be encoded using the specified encoding. The "Content-Transfer-Encoding" header will also be set for both the HTML and plain text parts. The following encodings are supported:

    07-bit
    1Quoted-Printable
    2Base64
    38-bit
    OverrideFileName:   If set to true, the AttachmentName property value will be used to set the MIME part FileName attribute.

    When set to True, the AttachmentsName value specified will be used to set the FileName attribute of the Content-Disposition header. The default value is False, in which case, the component will use the same name as the file being added.

    TempFilePath:   If set, the temporary files created during message creation will be put in the path specified.

    The TempFilePath configuration sets the path at which the temporary files will be created.

    UseTempFile:   Determines if temporary files are used during message creation.

    When , the class will create temporary files on disk at the path specified by TempFilePath as necessary during message creation. Set this to , to disable the creation of temporary files. When set to , the message will be created entirely in memory. The default value is . If set, the class uses temporary files when generating messages.

    This controls whether or not the class will use a temporary file when creating messages to be sent. Set this to True if the outgoing message contains large images or attachments.

    Note: Be aware of security considerations when using this configuration.

    UseTempFile:   Determines if temporary files are used during message creation.

    When , the class will create temporary files on disk at the path specified by TempFilePath as necessary during message creation. Set this to , to disable the creation of temporary files. When set to , the message will be created entirely in memory. The default value is . If set, the class uses temporary files when generating messages.

    This controls whether or not the class will use a temporary file when creating messages to be sent. Set this to True if the outgoing message contains large images or attachments.

    Note: Be aware of security considerations when using this configuration.

    SMTP Config Settings

    AllowEmptyTo:   If set to True, then the SendTo property is not required.

    Normally, the SendTo property is required to send a message. If AllowEmptyTo is True, then this is not the case, and messages can be sent with just one or both of Cc and BCc set.

    AuthorizationIdentity:   The value to use as the authorization identity when SASL authentication is used.

    When AuthMechanism is set to amXOAUTH2, you may use this configuration setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2, this should be your OAUTH authorization string. For instance:

    Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q

    Note: When using amXOAUTH2, User must be specified, but Password is not required.

    Charset:   When set, the message headers will be encoded using the specified Charset.

    This configuration setting is used to specify the "charset" to be used to encode the message headers. For example, to use UTF-8 you can set this property to "UTF-8". The default value is "" (empty string) in which case the headers will not be encoded.

    Hello:   The argument for HELO (herald) command to the server (defaults to local host name).

    The Hello property specifies a string to send to the MailServer at connection time as an argument to the SMTP HELO command. This generally identifies the host sending mail, and that is why the Hello property defaults to the name of the local host. The property is provided in case the class does not accept the default value and a custom value (e.g., a fully qualified domain name) must be sent.

    If AllowExtensions is True, the EHLO command will be sent instead of the HELO command.

    KeepQueue:   If set to True, queued files are not deleted after a successful send.

    Normally, ProcessQueue deletes queued files after processing them. If KeepQueue is True, then the file extension is instead changed to ".sent" and the files are not deleted.

    MaxHeaderLength:   Maximum length for headers to avoid line folding (default 80).

    The MaxHeaderLength specifies the maximum line length supported by the mail delivery system. Any headers longer than MaxHeaderLength are folded as specified in RFC 822.

    It is generally a good idea to use a MaxHeaderLength of less than 100 bytes, although different mail relays and mail servers have different requirements for header lengths.

    MessageHeadersString:   String representation of RFC822-encoded headers of the message.

    This setting holds the full headers of the message in RFC 822 format. Use this along with TransferText to store the entire message in RFC 822 format.

    Example: smtp1.Send(); string rawMsg = smtp1.Config("MessageHeadersString") + smtp1.Config("TransferText");

    MessageIdAlgorithm:   Determines the algorithm used to hash the random MessageId.

    The MessageIdAlgorithm specifies which algorithm to use in the hash for the MessageId when the property is set to "*". The default value is "SHA1".

    Possible values are as follows:

    • "MD5"
    • "SHA1" (default)
    • "SHA256"

    OtherHeaders:   An RFC 822 compliant string consisting of extra headers.

    This is the same as the OtherHeaders property. This configuration setting is exposed for use by classs that are inherited from SMTP.

    ReturnPath:   Sets the Return-Path to be used for sending email.

    This is the same as the ReturnPath property. This configuration setting is exposed for use by classs that are inherited from SMTP.

    SendRSET:   Whether to send RSET command.

    By default, the class will periodically send the RSET command to the server. Changing this configuration setting to False will prevent the RSET command from being sent. This can be useful when interacting with some servers that do not respond properly to the RSET command.

    StopOnBccErrors:   Instructs the class to stop sending the message if the server does not acknowledge any of the BCCs.

    If this configuration setting is set to True, the class will fail the moment the server does not acknowledge a Bcc address. If it is set to False, an error will be fired for every Bcc that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is False.

    StopOnCcErrors:   Instructs the class to stop sending the message if the server does not acknowledge any of the CCs.

    If this configuration setting is set to True, the class will fail the moment the server does not acknowledge a Cc address. If it is set to False, an error will be fired for every Cc that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is True.

    StopOnToErrors:   Instructs the class to stop sending the message if the server does not acknowledge any of the TOs.

    If this configuration setting is set to True, the class will fail the moment the server does not acknowledge a To address. If it is set to False, an error will be fired for every To that is not recognized by the server, but the message will be sent to the rest of the recipients. The default value is True.

    TransferText:   String representation of RFC822-encoded body of the message.

    This configuration setting holds the full body of the message in RFC 822 format. Use this along with MessageHeadersString to store the entire message in RFC 822 format.

    Example: smtp1.Send(); string rawMsg = smtp1.Config("MessageHeadersString") + smtp1.Config("TransferText");

    TCPClient Config Settings

    ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

    When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

    FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

    This configuration setting is provided for use by classs that do not directly expose Firewall properties.

    FirewallHost:   Name or IP address of firewall (optional).

    If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

    If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

    Note: This setting is provided for use by classs that do not directly expose Firewall properties.

    FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

    If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

    Note: This setting is provided for use by classs that do not directly expose Firewall properties.

    FirewallPort:   The TCP port for the FirewallHost;.

    The FirewallPort is set automatically when FirewallType is set to a valid value.

    Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

    FirewallType:   Determines the type of firewall to connect through.

    Possible values are as follows:

    0No firewall (default setting).
    1Connect through a tunneling proxy. FirewallPort is set to 80.
    2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
    3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
    10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

    Note: This setting is provided for use by classs that do not directly expose Firewall properties.

    FirewallUser:   A user name if authentication is to be used connecting through a firewall.

    If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

    Note: This setting is provided for use by classs that do not directly expose Firewall properties.

    KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

    When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

    Note: This value is not applicable in macOS.

    KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

    When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

    Linger:   When set to True, connections are terminated gracefully.

    This property controls how a connection is closed. The default is True.

    In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

    In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

    The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

    Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

    LingerTime:   Time in seconds to have the connection linger.

    LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

    LocalHost:   The name of the local host through which connections are initiated or accepted.

    The LocalHost setting 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 value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

    If the class is connected, the LocalHost setting 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).

    LocalPort:   The port in the local host where the class binds.

    This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

    Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

    LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

    This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

    MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

    MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

    If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

    If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

    The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

    MaxTransferRate:   The transfer rate limit in bytes per second.

    This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

    ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

    This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

    www.google.com;www.nsoftware.com

    TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

    If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

    Note: This value is not applicable in Java.

    TcpNoDelay:   Whether or not to delay when sending packets.

    When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

    By default, this configuration setting is set to False.

    UseIPv6:   Whether to use IPv6.

    When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:

    0 IPv4 only
    1 IPv6 only
    2 IPv6 with IPv4 fallback

    SSL Config Settings

    LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

    When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

    When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

    Enabling this configuration setting has no effect if SSLProvider is set to Platform.

    OpenSSLCADir:   The path to a directory containing CA certificates.

    This functionality is available only when the provider is OpenSSL.

    The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

    OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

    This functionality is available only when the provider is OpenSSL.

    The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

    -----BEGIN CERTIFICATE-----

    ... (CA certificate in base64 encoding) ...

    -----END CERTIFICATE-----

    Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

    OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

    This functionality is available only when the provider is OpenSSL.

    The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

    OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

    This functionality is available only when the provider is OpenSSL.

    By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

    ReuseSSLSession:   Determines if the SSL session is reused.

    If set to True, the class will reuse the context if and only if the following criteria are met:

    • The target host name is the same.
    • The system cache entry has not expired (default timeout is 10 hours).
    • The application process that calls the function is the same.
    • The logon session is the same.
    • The instance of the class is the same.

    SSLCACerts:   A newline separated list of CA certificates to be included when performing an SSL handshake.

    When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: 

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

    SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

    This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class .

    When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

    This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

    SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

    This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class .

    When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

    This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

    SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

    This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

    Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

    Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

    When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

    SSLClientCACerts:   A newline separated list of CA certificates to use during SSL client certificate validation.

    This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

    The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: 

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

    SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

    This configuration setting enables the cipher suites to be used in SSL negotiation.

    By default, the enabled cipher suites will include all available ciphers ("*").

    The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

    Multiple cipher suites are separated by semicolons.

    Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

    • CALG_3DES
    • CALG_3DES_112
    • CALG_AES
    • CALG_AES_128
    • CALG_AES_192
    • CALG_AES_256
    • CALG_AGREEDKEY_ANY
    • CALG_CYLINK_MEK
    • CALG_DES
    • CALG_DESX
    • CALG_DH_EPHEM
    • CALG_DH_SF
    • CALG_DSS_SIGN
    • CALG_ECDH
    • CALG_ECDH_EPHEM
    • CALG_ECDSA
    • CALG_ECMQV
    • CALG_HASH_REPLACE_OWF
    • CALG_HUGHES_MD5
    • CALG_HMAC
    • CALG_KEA_KEYX
    • CALG_MAC
    • CALG_MD2
    • CALG_MD4
    • CALG_MD5
    • CALG_NO_SIGN
    • CALG_OID_INFO_CNG_ONLY
    • CALG_OID_INFO_PARAMETERS
    • CALG_PCT1_MASTER
    • CALG_RC2
    • CALG_RC4
    • CALG_RC5
    • CALG_RSA_KEYX
    • CALG_RSA_SIGN
    • CALG_SCHANNEL_ENC_KEY
    • CALG_SCHANNEL_MAC_KEY
    • CALG_SCHANNEL_MASTER_HASH
    • CALG_SEAL
    • CALG_SHA
    • CALG_SHA1
    • CALG_SHA_256
    • CALG_SHA_384
    • CALG_SHA_512
    • CALG_SKIPJACK
    • CALG_SSL2_MASTER
    • CALG_SSL3_MASTER
    • CALG_SSL3_SHAMD5
    • CALG_TEK
    • CALG_TLS1_MASTER
    • CALG_TLS1PRF
    Example values when SSLProvider is set to Internalinclude the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include the following:
    • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
    • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
    • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
    • TLS_RSA_WITH_AES_256_GCM_SHA384
    • TLS_RSA_WITH_AES_128_GCM_SHA256
    • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
    • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
    • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
    • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
    • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
    • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
    • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
    • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
    • TLS_RSA_WITH_AES_256_CBC_SHA256
    • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
    • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
    • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
    • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
    • TLS_RSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
    • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
    • TLS_RSA_WITH_AES_256_CBC_SHA
    • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
    • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
    • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
    • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
    • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
    • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
    • TLS_RSA_WITH_AES_128_CBC_SHA
    • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
    • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
    • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
    • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
    • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
    • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
    • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
    • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
    • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
    • TLS_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_RSA_WITH_DES_CBC_SHA
    • TLS_DHE_RSA_WITH_DES_CBC_SHA
    • TLS_DHE_DSS_WITH_DES_CBC_SHA
    • TLS_RSA_WITH_RC4_128_MD5
    • TLS_RSA_WITH_RC4_128_SHA

    When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

    • TLS_AES_256_GCM_SHA384
    • TLS_CHACHA20_POLY1305_SHA256
    • TLS_AES_128_GCM_SHA256

    SSLEnabledCipherSuites is used together with SSLCipherStrength.

    SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

    This configuration setting is used to enable or disable the supported security protocols.

    Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:

    TLS1.312288 (Hex 3000)
    TLS1.23072 (Hex C00) (Default - Client and Server)
    TLS1.1768 (Hex 300) (Default - Client)
    TLS1 192 (Hex C0) (Default - Client)
    SSL3 48 (Hex 30)
    SSL2 12 (Hex 0C)

    Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

    SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

    By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

    In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

    If set to 1 (Platform provider), please be aware of the following notes:

    • The platform provider is available only on Windows 11/Windows Server 2022 and up.
    • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
    • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

    SSLEnabledProtocols: SSL2 and SSL3 Notes:

    SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

    SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

    This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is by default, but it can be set to to enable the extension.

    This configuration setting is applicable only when SSLProvider is set to Internal.

    SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

    This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

    If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

    SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

    This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

    When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

    Note: This configuration setting is applicable only when SSLProvider is set to Internal.

    SSLNegotiatedCipher:   Returns the negotiated cipher suite.

    This configuration setting returns the cipher suite negotiated during the SSL handshake.

    Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

    SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

    This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

    Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

    SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

    This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

    Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

    SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

    This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

    Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

    SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

    This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

    Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

    SSLNegotiatedVersion:   Returns the negotiated protocol version.

    This configuration setting returns the protocol version negotiated during the SSL handshake.

    Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

    SSLSecurityFlags:   Flags that control certificate verification.

    The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

    0x00000001Ignore time validity status of certificate.
    0x00000002Ignore time validity status of CTL.
    0x00000004Ignore non-nested certificate times.
    0x00000010Allow unknown certificate authority.
    0x00000020Ignore wrong certificate usage.
    0x00000100Ignore unknown certificate revocation status.
    0x00000200Ignore unknown CTL signer revocation status.
    0x00000400Ignore unknown certificate authority revocation status.
    0x00000800Ignore unknown root revocation status.
    0x00008000Allow test root certificate.
    0x00004000Trust test root certificate.
    0x80000000Ignore non-matching CN (certificate CN non-matching server name).

    This functionality is currently not available when the provider is OpenSSL.

    SSLServerCACerts:   A newline separated list of CA certificates to use during SSL server certificate validation.

    This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

    The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: 

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

    TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

    This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

    When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class .

    The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

    To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

    TLS12SupportedGroups:   The supported groups for ECC.

    This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

    The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

    When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

    • "ecdhe_secp256r1" (default)
    • "ecdhe_secp384r1" (default)
    • "ecdhe_secp521r1" (default)

    TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

    This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

    The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

    Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

    In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

    The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

    The values are ordered from most preferred to least preferred. The following values are supported:

    • "ecdhe_x25519" (default)
    • "ecdhe_x448"
    • "ecdhe_secp256r1" (default)
    • "ecdhe_secp384r1" (default)
    • "ecdhe_secp521r1"
    • "ffdhe_2048" (default)
    • "ffdhe_3072" (default)
    • "ffdhe_4096"
    • "ffdhe_6144"
    • "ffdhe_8192"

    TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

    This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

    • "ed25519" (default)
    • "ed448" (default)
    • "ecdsa_secp256r1_sha256" (default)
    • "ecdsa_secp384r1_sha384" (default)
    • "ecdsa_secp521r1_sha512" (default)
    • "rsa_pkcs1_sha256" (default)
    • "rsa_pkcs1_sha384" (default)
    • "rsa_pkcs1_sha512" (default)
    • "rsa_pss_sha256" (default)
    • "rsa_pss_sha384" (default)
    • "rsa_pss_sha512" (default)
    The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.
    TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

    This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

    The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

    The values are ordered from most preferred to least preferred. The following values are supported:

    • "ecdhe_x25519" (default)
    • "ecdhe_x448" (default)
    • "ecdhe_secp256r1" (default)
    • "ecdhe_secp384r1" (default)
    • "ecdhe_secp521r1" (default)
    • "ffdhe_2048" (default)
    • "ffdhe_3072" (default)
    • "ffdhe_4096" (default)
    • "ffdhe_6144" (default)
    • "ffdhe_8192" (default)

    Socket Config Settings

    AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

    If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

    Note: This option is not valid for User Datagram Protocol (UDP) ports.

    FirewallData:   Used to send extra data to the firewall.

    When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

    InBufferSize:   The size in bytes of the incoming queue of the socket.

    This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

    Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

    OutBufferSize:   The size in bytes of the outgoing queue of the socket.

    This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

    Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

    Base Config Settings

    BuildInfo:   Information about the product's build.

    When queried, this setting will return a string containing information about the product's build.

    CodePage:   The system code page used for Unicode to Multibyte translations.

    The default code page is Unicode UTF-8 (65001).

    The following is a list of valid code page identifiers:

    IdentifierName
    037IBM EBCDIC - U.S./Canada
    437OEM - United States
    500IBM EBCDIC - International
    708Arabic - ASMO 708
    709Arabic - ASMO 449+, BCON V4
    710Arabic - Transparent Arabic
    720Arabic - Transparent ASMO
    737OEM - Greek (formerly 437G)
    775OEM - Baltic
    850OEM - Multilingual Latin I
    852OEM - Latin II
    855OEM - Cyrillic (primarily Russian)
    857OEM - Turkish
    858OEM - Multilingual Latin I + Euro symbol
    860OEM - Portuguese
    861OEM - Icelandic
    862OEM - Hebrew
    863OEM - Canadian-French
    864OEM - Arabic
    865OEM - Nordic
    866OEM - Russian
    869OEM - Modern Greek
    870IBM EBCDIC - Multilingual/ROECE (Latin-2)
    874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
    875IBM EBCDIC - Modern Greek
    932ANSI/OEM - Japanese, Shift-JIS
    936ANSI/OEM - Simplified Chinese (PRC, Singapore)
    949ANSI/OEM - Korean (Unified Hangul Code)
    950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
    1026IBM EBCDIC - Turkish (Latin-5)
    1047IBM EBCDIC - Latin 1/Open System
    1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
    1141IBM EBCDIC - Germany (20273 + Euro symbol)
    1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
    1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
    1144IBM EBCDIC - Italy (20280 + Euro symbol)
    1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
    1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
    1147IBM EBCDIC - France (20297 + Euro symbol)
    1148IBM EBCDIC - International (500 + Euro symbol)
    1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
    1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
    1201Unicode UCS-2 Big-Endian
    1250ANSI - Central European
    1251ANSI - Cyrillic
    1252ANSI - Latin I
    1253ANSI - Greek
    1254ANSI - Turkish
    1255ANSI - Hebrew
    1256ANSI - Arabic
    1257ANSI - Baltic
    1258ANSI/OEM - Vietnamese
    1361Korean (Johab)
    10000MAC - Roman
    10001MAC - Japanese
    10002MAC - Traditional Chinese (Big5)
    10003MAC - Korean
    10004MAC - Arabic
    10005MAC - Hebrew
    10006MAC - Greek I
    10007MAC - Cyrillic
    10008MAC - Simplified Chinese (GB 2312)
    10010MAC - Romania
    10017MAC - Ukraine
    10021MAC - Thai
    10029MAC - Latin II
    10079MAC - Icelandic
    10081MAC - Turkish
    10082MAC - Croatia
    12000Unicode UCS-4 Little-Endian
    12001Unicode UCS-4 Big-Endian
    20000CNS - Taiwan
    20001TCA - Taiwan
    20002Eten - Taiwan
    20003IBM5550 - Taiwan
    20004TeleText - Taiwan
    20005Wang - Taiwan
    20105IA5 IRV International Alphabet No. 5 (7-bit)
    20106IA5 German (7-bit)
    20107IA5 Swedish (7-bit)
    20108IA5 Norwegian (7-bit)
    20127US-ASCII (7-bit)
    20261T.61
    20269ISO 6937 Non-Spacing Accent
    20273IBM EBCDIC - Germany
    20277IBM EBCDIC - Denmark/Norway
    20278IBM EBCDIC - Finland/Sweden
    20280IBM EBCDIC - Italy
    20284IBM EBCDIC - Latin America/Spain
    20285IBM EBCDIC - United Kingdom
    20290IBM EBCDIC - Japanese Katakana Extended
    20297IBM EBCDIC - France
    20420IBM EBCDIC - Arabic
    20423IBM EBCDIC - Greek
    20424IBM EBCDIC - Hebrew
    20833IBM EBCDIC - Korean Extended
    20838IBM EBCDIC - Thai
    20866Russian - KOI8-R
    20871IBM EBCDIC - Icelandic
    20880IBM EBCDIC - Cyrillic (Russian)
    20905IBM EBCDIC - Turkish
    20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
    20932JIS X 0208-1990 & 0121-1990
    20936Simplified Chinese (GB2312)
    21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
    21027Extended Alpha Lowercase
    21866Ukrainian (KOI8-U)
    28591ISO 8859-1 Latin I
    28592ISO 8859-2 Central Europe
    28593ISO 8859-3 Latin 3
    28594ISO 8859-4 Baltic
    28595ISO 8859-5 Cyrillic
    28596ISO 8859-6 Arabic
    28597ISO 8859-7 Greek
    28598ISO 8859-8 Hebrew
    28599ISO 8859-9 Latin 5
    28605ISO 8859-15 Latin 9
    29001Europa 3
    38598ISO 8859-8 Hebrew
    50220ISO 2022 Japanese with no halfwidth Katakana
    50221ISO 2022 Japanese with halfwidth Katakana
    50222ISO 2022 Japanese JIS X 0201-1989
    50225ISO 2022 Korean
    50227ISO 2022 Simplified Chinese
    50229ISO 2022 Traditional Chinese
    50930Japanese (Katakana) Extended
    50931US/Canada and Japanese
    50933Korean Extended and Korean
    50935Simplified Chinese Extended and Simplified Chinese
    50936Simplified Chinese
    50937US/Canada and Traditional Chinese
    50939Japanese (Latin) Extended and Japanese
    51932EUC - Japanese
    51936EUC - Simplified Chinese
    51949EUC - Korean
    51950EUC - Traditional Chinese
    52936HZ-GB2312 Simplified Chinese
    54936Windows XP: GB18030 Simplified Chinese (4 Byte)
    57002ISCII Devanagari
    57003ISCII Bengali
    57004ISCII Tamil
    57005ISCII Telugu
    57006ISCII Assamese
    57007ISCII Oriya
    57008ISCII Kannada
    57009ISCII Malayalam
    57010ISCII Gujarati
    57011ISCII Punjabi
    65000Unicode UTF-7
    65001Unicode UTF-8
    The following is a list of valid code page identifiers for Mac OS only:
    IdentifierName
    1ASCII
    2NEXTSTEP
    3JapaneseEUC
    4UTF8
    5ISOLatin1
    6Symbol
    7NonLossyASCII
    8ShiftJIS
    9ISOLatin2
    10Unicode
    11WindowsCP1251
    12WindowsCP1252
    13WindowsCP1253
    14WindowsCP1254
    15WindowsCP1250
    21ISO2022JP
    30MacOSRoman
    10UTF16String
    0x90000100UTF16BigEndian
    0x94000100UTF16LittleEndian
    0x8c000100UTF32String
    0x98000100UTF32BigEndian
    0x9c000100UTF32LittleEndian
    65536Proprietary

    LicenseInfo:   Information about the current license.

    When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

    • Product: The product the license is for.
    • Product Key: The key the license was generated from.
    • License Source: Where the license was found (e.g., RuntimeLicense, License File).
    • License Type: The type of license installed (e.g., Royalty Free, Single Server).
    • Last Valid Build: The last valid build number for which the license will work.
    MaskSensitiveData:   Whether sensitive data is masked in log messages.

    In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

    This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

    UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

    When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

    Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.

    This setting is set to by default on all platforms.

    Trappable Errors (SHTMLMailer Module)

    HTMLMailer Errors

    169   Invalid image index (out of range).
    170   Invalid attachment index (out of range).

    MIME Errors

    3   Can't create the file for write (illegal name or disk is write-protected).
    4   Can't open the file for read (doesn't exist?).
    5   Can't read from file.
    6   Can't write to file (disk full?).
    280   Invalid Part Index.
    281   Unknown MIME type.
    282   No MIME-boundary found.
    283   No file given.
    284   The class is busy.
    285   Can't create a temporary file to decode the data.
    286   Can't read Message file.
    287   No header separator found.
    289   No separator found.
    290   Input stream must have seeking enabled.

    SMTP Errors

    118   Firewall Error. Error message contains detailed description.
    161   SMTP protocol error. Description contains the server reply.
    162   Error communicating with server. Error text is attached.
    163   Please specify a MailServer.
    164   Please specify a sender (From).
    165   Please specify a recipient.
    166   Busy executing current method.
    301   Operation interrupted.
    302   Cannot open AttachedFile.

    TCPClient Errors

    100   You cannot change the RemotePort at this time. A connection is in progress.
    101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
    102   The RemoteHost address is invalid (0.0.0.0).
    104   Already connected. If you want to reconnect, close the current connection first.
    106   You cannot change the LocalPort at this time. A connection is in progress.
    107   You cannot change the LocalHost at this time. A connection is in progress.
    112   You cannot change MaxLineLength at this time. A connection is in progress.
    116   RemotePort cannot be zero. Please specify a valid service port number.
    117   You cannot change the UseConnection option while the class is active.
    135   Operation would block.
    201   Timeout.
    211   Action impossible in control's present state.
    212   Action impossible while not connected.
    213   Action impossible while listening.
    301   Timeout.
    302   Could not open file.
    434   Unable to convert string to selected CodePage.
    1105   Already connecting. If you want to reconnect, close the current connection first.
    1117   You need to connect first.
    1119   You cannot change the LocalHost at this time. A connection is in progress.
    1120   Connection dropped by remote host.

    SSL Errors

    270   Cannot load specified security library.
    271   Cannot open certificate store.
    272   Cannot find specified certificate.
    273   Cannot acquire security credentials.
    274   Cannot find certificate chain.
    275   Cannot verify certificate chain.
    276   Error during handshake.
    280   Error verifying certificate.
    281   Could not find client certificate.
    282   Could not find server certificate.
    283   Error encrypting data.
    284   Error decrypting data.

    TCP/IP Errors

    10004   [10004] Interrupted system call.
    10009   [10009] Bad file number.
    10013   [10013] Access denied.
    10014   [10014] Bad address.
    10022   [10022] Invalid argument.
    10024   [10024] Too many open files.
    10035   [10035] Operation would block.
    10036   [10036] Operation now in progress.
    10037   [10037] Operation already in progress.
    10038   [10038] Socket operation on nonsocket.
    10039   [10039] Destination address required.
    10040   [10040] Message is too long.
    10041   [10041] Protocol wrong type for socket.
    10042   [10042] Bad protocol option.
    10043   [10043] Protocol is not supported.
    10044   [10044] Socket type is not supported.
    10045   [10045] Operation is not supported on socket.
    10046   [10046] Protocol family is not supported.
    10047   [10047] Address family is not supported by protocol family.
    10048   [10048] Address already in use.
    10049   [10049] Cannot assign requested address.
    10050   [10050] Network is down.
    10051   [10051] Network is unreachable.
    10052   [10052] Net dropped connection or reset.
    10053   [10053] Software caused connection abort.
    10054   [10054] Connection reset by peer.
    10055   [10055] No buffer space available.
    10056   [10056] Socket is already connected.
    10057   [10057] Socket is not connected.
    10058   [10058] Cannot send after socket shutdown.
    10059   [10059] Too many references, cannot splice.
    10060   [10060] Connection timed out.
    10061   [10061] Connection refused.
    10062   [10062] Too many levels of symbolic links.
    10063   [10063] File name is too long.
    10064   [10064] Host is down.
    10065   [10065] No route to host.
    10066   [10066] Directory is not empty
    10067   [10067] Too many processes.
    10068   [10068] Too many users.
    10069   [10069] Disc Quota Exceeded.
    10070   [10070] Stale NFS file handle.
    10071   [10071] Too many levels of remote in path.
    10091   [10091] Network subsystem is unavailable.
    10092   [10092] WINSOCK DLL Version out of range.
    10093   [10093] Winsock is not loaded yet.
    11001   [11001] Host not found.
    11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
    11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
    11004   [11004] Valid name, no data record (check DNS setup).