SMTP Class
Properties Methods Events Config Settings Errors
The SMTP Class is used to send internet mail using the SMTP protocol (the internet mail standard).
Syntax
ipworks.SMTP
Remarks
The SMTP 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 SMTP Class implements a standard SMTP client as specified in RFC 821. It has a simple plug-and-play interface. It contains a number of properties, such as SendTo, Subject, From, Cc, and BCc, that map directly to the internet mail message headers with the same name (RFC 822). The message text is set in MessageText. Messages are sent by calling the Send method.
The class supports message delivery to multiple recipients through the SendTo, Cc, and BCc properties. Simply specify the destination email addresses separated by commas.
The interface of the class is open-ended. New features, including MIME attachments, can be supported by using the OtherHeaders property.
A number of events provide feedback during the operation of the class. The Transfer event is fired during message delivery to show the number of bytes delivered. The PITrail event traces the commands that are sent to the server and the respective replies.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AllowExtensions | This property is a switch allowing the class to use ESMTP features (Extended SMTP). |
AuthMechanism | This property is used when connecting to the mail server. |
BCc | This property includes a comma-separated list of addresses for blind carbon copies (optional). |
Cc | This property includes a comma-separated list of addresses for carbon copies (optional). |
Connected | This property shows whether the class is connected. |
DeliveryNotificationTo | This property includes the email address to which to send a delivery notification. |
Firewall | A set of properties related to firewall access. |
From | This property includes the email address of the sender (required). |
Idle | This property specifies the current status of the class. |
Importance | This property indicates the importance of the mail message (optional). |
LastReply | This property indicates the last reply received from the server. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MailPort | This property includes the server port for SMTP (default 25). |
MailServer | This property includes the name or address of a mail server (mail relay). |
Message | This property provides a way to set the raw message content. |
MessageDate | This property includes the date of the mail message (optional). |
MessageHeaders | This property includes a collection of RFC 822-encoded headers of the message. |
MessageHeadersString | This property includes the string representation of RFC 822-encoded headers of the message. |
MessageId | This property includes the message identifier for the message. |
MessageRecipients | This property includes the collection of recipients of the message. |
MessageText | This property includes the full text of the message to send (without headers). |
OtherHeaders | This property includes an RFC 822-compliant string consisting of extra headers. |
Password | This property includes a password for logon to the MailServer . |
Priority | This property includes the priority of the mail message (optional). |
ReadReceiptTo | This property includes the email address to send a read-receipt to. |
ReplyTo | This property includes a mail address to which to reply (optional). |
ReturnPath | This property sets the Return-Path to be used for sending email. |
SendTo | This property includes a comma-separated list of addresses for destinations (required). |
Sensitivity | This property indicates the sensitivity of the mail message (optional). |
SSLAcceptServerCert | This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
SSLStartMode | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. |
Subject | This property includes the subject of the mail message (optional). |
Timeout | This property includes the timeout for the class. |
User | This 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 class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to the mail relay and sends the SMTP HELO command. |
Disconnect | This method disconnects from the SMTP server. |
DoEvents | This method processes events from the internal message queue. |
Expand | This method asks the MailServer to expand a name or mailing list. |
Interrupt | This method interrupts the current method. |
ProcessQueue | This method sends the messages that previously have been queued into QueueDir . |
Queue | This method queues the message into QueueDir . |
Reset | This method will reset the class. |
ResetHeaders | This method resets all the message headers to empty. |
Send | This method sends the current message. |
SendCommand | This method sends the exact command directly to the server. |
SendToTerminalAndEmail | This method sends to terminal and email. |
SendToTerminalOnly | This method sends to terminal only. |
SendToTerminalOrEmail | This method sends to terminal or email. |
SetMessageStream | This method sets the stream to be uploaded to the server as part of the message. |
Verify | This method sends a verification request to the SMTP server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
ConnectionStatus | This event is fired to indicate changes in the connection state. |
EndTransfer | This event is fired when the message text completes transferring. |
Error | Fired when information is available about errors during data delivery. |
Expand | This event is fired for every email address returned by the server when the Expand method is called. |
PITrail | This event traces the commands sent to the mail server, and the respective replies. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when the message text starts transferring. |
Transfer | This event is fired when the message text is transferred to MailServer . |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowEmptyTo | If set to True, then the SendTo property is not required. |
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
Charset | When set, the message headers will be encoded using the specified Charset. |
FoldHeaders | Tells the class whether to fold the headers. |
Hello | The argument for HELO (herald) command to the server (defaults to local host name). |
KeepQueue | If set to True, queued files are not deleted after a successful send. |
MaxHeaderLength | Maximum length for headers to avoid line folding (default 80). |
MessageHeadersString | String representation of RFC822-encoded headers of the message. |
MessageIdAlgorithm | Determines the algorithm used to hash the random MessageId. |
OtherHeaders | An RFC 822 compliant string consisting of extra headers. |
ReturnPath | Sets the Return-Path to be used for sending email. |
SendRSET | Whether to send RSET command. |
StopOnBccErrors | Instructs the class to stop sending the message if the server does not acknowledge any of the BCCs. |
StopOnCcErrors | Instructs the class to stop sending the message if the server does not acknowledge any of the CCs. |
StopOnToErrors | Instructs the class to stop sending the message if the server does not acknowledge any of the TOs. |
TransferText | String representation of RFC822-encoded body of the message. |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AllowExtensions Property (SMTP Class)
This property is a switch allowing the class to use ESMTP features (Extended SMTP).
Syntax
public boolean isAllowExtensions(); public void setAllowExtensions(boolean allowExtensions);
Default Value
True
Remarks
This property is a switch allowing the class to use ESMTP features (Extended SMTP). If this property is True, the class will first send the EHLO greeting (Extended Hello) to the server and, if that fails, the standard HELO command will be sent.
This property is True by default but may be disabled if it is known in advance that the MailServer does not support SMTP extensions.
This property is not available at design time.
AuthMechanism Property (SMTP Class)
This property is used when connecting to the mail server.
Syntax
public int getAuthMechanism(); public void setAuthMechanism(int authMechanism); Enumerated values: public final static int amUserPassword = 0; public final static int amCRAMMD5 = 1; public final static int amNTLM = 2; public final static int amAPOP = 3; public final static int amSASLPlain = 4; public final static int amSASLDigestMD5 = 5; public final static int amKerberos = 6; public final static int amXOAUTH2 = 7;
Default Value
0
Remarks
This is the authentication mechanism property to be used when connecting to the mail server.
By default, this property is amUserPassword (0), and if the User and Password properties are set, the AUTH command is sent to the server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5 authentication is used instead.
If this property is set to amNTLM (2), NTLM authentication will be used.
If this property is set to amKerberos (6), Kerberos authentication will be used.
Note: This functionality is available only in Windows.
When set to amXOAUTH2 (7), set User to the username and AuthorizationIdentity to the OAuth token. See AuthorizationIdentity for details.
BCc Property (SMTP Class)
This property includes a comma-separated list of addresses for blind carbon copies (optional).
Syntax
public String getBCc(); public void setBCc(String BCc);
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no BCc SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.
The class will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in this property.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients collection before setting this property to remove previous recipients.
Cc Property (SMTP Class)
This property includes a comma-separated list of addresses for carbon copies (optional).
Syntax
public String getCc(); public void setCc(String cc);
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc).
The class will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients collection before setting this property to remove previous recipients.
Connected Property (SMTP Class)
This property shows whether the class is connected.
Syntax
public boolean isConnected();
Default Value
False
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
DeliveryNotificationTo Property (SMTP Class)
This property includes the email address to which to send a delivery notification.
Syntax
public String getDeliveryNotificationTo(); public void setDeliveryNotificationTo(String deliveryNotificationTo);
Default Value
""
Remarks
This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.
Firewall Property (SMTP Class)
A set of properties related to firewall access.
Syntax
public Firewall getFirewall(); public void setFirewall(Firewall firewall);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Please refer to the Firewall type for a complete list of fields.From Property (SMTP Class)
This property includes the email address of the sender (required).
Syntax
public String getFrom(); public void setFrom(String from);
Default Value
""
Remarks
This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Idle Property (SMTP Class)
This property specifies the current status of the class.
Syntax
public boolean isIdle();
Default Value
True
Remarks
Idle 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.
Importance Property (SMTP Class)
This property indicates the importance of the mail message (optional).
Syntax
public int getImportance(); public void setImportance(int importance); Enumerated values: public final static int miUnspecified = 0; public final static int miHigh = 1; public final static int miNormal = 2; public final static int miLow = 3;
Default Value
0
Remarks
This property indicates the importance of the mail message (optional). When set, an Importance header will be added to the message.
Importance is an indication to the recipient(s) about the level of importance of the message. The possible values are Unspecified (0), High (1), Normal (2), and Low (3).
LastReply Property (SMTP Class)
This property indicates the last reply received from the server.
Syntax
public String getLastReply();
Default Value
""
Remarks
This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.
This property is read-only.
LocalHost Property (SMTP Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public String getLocalHost(); public void setLocalHost(String localHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In 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 (SMTP Class)
This property includes the server port for SMTP (default 25).
Syntax
public int getMailPort(); public void setMailPort(int mailPort);
Default Value
25
Remarks
This property contains the server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
For an implicit Secure Sockets Layer (SSL), use port 465 (please refer to the SSLStartMode property for more information).
This property is not available at design time.
MailServer Property (SMTP Class)
This property includes the name or address of a mail server (mail relay).
Syntax
public String getMailServer(); public void setMailServer(String mailServer);
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or domain name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.
The current version of the class does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (e.g., a UNIX host), but it is preferable to select a MailServer that is close to the machine sending mail.
If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
Message Property (SMTP Class)
This property provides a way to set the raw message content.
Syntax
public byte[] getMessage(); public void setMessage(byte[] message);
Default Value
""
Remarks
This property may be set instead of MessageText. This value will not be modified in any way by the class and will be sent as is. Use caution when setting this value as all encoding must be done before supplying the value to the component.
This property is not available at design time.
MessageDate Property (SMTP Class)
This property includes the date of the mail message (optional).
Syntax
public String getMessageDate(); public void setMessageDate(String messageDate);
Default Value
"*"
Remarks
If this property contains a nonempty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.
Special case: If this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders is computed and the message is sent. This is the default behavior of the class
RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".
This property is not available at design time.
MessageHeaders Property (SMTP Class)
This property includes a collection of RFC 822-encoded headers of the message.
Syntax
public HeaderList getMessageHeaders();
Remarks
This property holds the full headers of the message in RFC 822 format.
This property is read-only and not available at design time.
Please refer to the Header type for a complete list of fields.MessageHeadersString Property (SMTP Class)
This property includes the string representation of RFC 822-encoded headers of the message.
Syntax
public String getMessageHeadersString();
Default Value
""
Remarks
This property holds the full headers of the message in RFC 822 format.
This property is read-only.
MessageId Property (SMTP Class)
This property includes the message identifier for the message.
Syntax
public String getMessageId(); public void setMessageId(String messageId);
Default Value
"*"
Remarks
This property contains the message identifier for the message. When set, the value of MessageId is used as the Message-Id header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.
This property is not available at design time.
MessageRecipients Property (SMTP Class)
This property includes the collection of recipients of the message.
Syntax
public MessageRecipientList getMessageRecipients(); public void setMessageRecipients(MessageRecipientList messageRecipients);
Remarks
This property contains a collection that describes to whom the message is being sent. You may include all recipients in this property, even Cc's and BCc's, which are specified by the type field.
This collection is indexed from 0 to size -1.
Please refer to the MessageRecipient type for a complete list of fields.MessageText Property (SMTP Class)
This property includes the full text of the message to send (without headers).
Syntax
public String getMessageText(); public void setMessageText(String messageText);
Default Value
""
Remarks
This property contains the full text of the message.
The text contained in this property should be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the message lines must contain 7-bit characters so that the message can successfully pass through the multitude of mail systems on the Internet.
The class automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.
OtherHeaders Property (SMTP Class)
This property includes an RFC 822-compliant string consisting of extra headers.
Syntax
public String getOtherHeaders(); public void setOtherHeaders(String otherHeaders);
Default Value
""
Remarks
This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, and so on.
The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, message delivery might not be successful.
This property is useful for extending the functionality of the class. A good example is delivery of MIME-encoded messages.
Special case: If this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.
Example. Sending an Email with an Additional Header:
component.MailServer = "MyServer";
component.From = "me@server.com";
component.SendTo = "recipient@server.com";
component.Subject = "My Subject";
component.MessageText = "This is the message body.";
component.OtherHeaders = "HeaderName: HeaderValue";
component.Send();
This property is not available at design time.
Password Property (SMTP Class)
This property includes a password for logon to the MailServer .
Syntax
public String getPassword(); public void setPassword(String password);
Default Value
""
Remarks
If this property is set to a nonempty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent to provide authentication information for the user.
This property is not available at design time.
Priority Property (SMTP Class)
This property includes the priority of the mail message (optional).
Syntax
public int getPriority(); public void setPriority(int priority); Enumerated values: public final static int epUnspecified = 0; public final static int epNormal = 1; public final static int epUrgent = 2; public final static int epNonUrgent = 3;
Default Value
0
Remarks
When this property is set, a priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.
ReadReceiptTo Property (SMTP Class)
This property includes the email address to send a read-receipt to.
Syntax
public String getReadReceiptTo(); public void setReadReceiptTo(String readReceiptTo);
Default Value
""
Remarks
When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address that should receive the read-receipt.
ReplyTo Property (SMTP Class)
This property includes a mail address to which to reply (optional).
Syntax
public String getReplyTo(); public void setReplyTo(String replyTo);
Default Value
""
Remarks
If this property contains a nonempty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies, which is useful if this address is different from the one in From.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
ReturnPath Property (SMTP Class)
This property sets the Return-Path to be used for sending email.
Syntax
public String getReturnPath(); public void setReturnPath(String returnPath);
Default Value
""
Remarks
Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in the From property is used.
SendTo Property (SMTP Class)
This property includes a comma-separated list of addresses for destinations (required).
Syntax
public String getSendTo(); public void setSendTo(String sendTo);
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.
Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com
The class will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same thing happens with an email address specified in BCc.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients collection before setting this property to remove previous recipients.
Sensitivity Property (SMTP Class)
This property indicates the sensitivity of the mail message (optional).
Syntax
public int getSensitivity(); public void setSensitivity(int sensitivity); Enumerated values: public final static int esUnspecified = 0; public final static int esPersonal = 1; public final static int esPrivate = 2; public final static int esCompanyConfidential = 3;
Default Value
0
Remarks
This property provides an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are as follows: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).
SSLAcceptServerCert Property (SMTP Class)
This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (SMTP Class)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLEnabled Property (SMTP Class)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
public boolean isSSLEnabled(); public void setSSLEnabled(boolean SSLEnabled);
Default Value
False
Remarks
This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
SSLProvider Property (SMTP Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
SSLServerCert Property (SMTP Class)
This property includes the server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.SSLStartMode Property (SMTP Class)
This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.
Syntax
public int getSSLStartMode(); public void setSSLStartMode(int SSLStartMode); Enumerated values: public final static int sslAutomatic = 0; public final static int sslImplicit = 1; public final static int sslExplicit = 2; public final static int sslNone = 3;
Default Value
3
Remarks
The SSLStartMode property may have one of the following values:
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 (SMTP Class)
This property includes the subject of the mail message (optional).
Syntax
public String getSubject(); public void setSubject(String subject);
Default Value
""
Remarks
The string in this property is sent with a Subject SMTP header to the mail recipient.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Timeout Property (SMTP Class)
This property includes the timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int timeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class throws an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
User Property (SMTP Class)
This property includes the user identifier needed to log in as in the MailServer .
Syntax
public String getUser(); public void setUser(String user);
Default Value
""
Remarks
If this property is set to a nonempty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent to provide authentication information for the user.
This property is not available at design time.
Config Method (SMTP Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (SMTP Class)
This method connects to the mail relay and sends the SMTP HELO command.
Syntax
public void connect();
Remarks
This method connects to the mail relay and sends the SMTP HELO command, thus preparing to send messages. Any number of messages can later be sent using the Send method.
Example. Connecting and Sending an Email:
control.MailServer = "MyServer"
control.From = "me@server.com"
control.SendTo = "recipient@server.com"
control.Subject = "My Subject"
control.MessageText = "This is the message body"
control.Connect()
control.Send()
control.Disconnect()
Disconnect Method (SMTP Class)
This method disconnects from the SMTP server.
Syntax
public void disconnect();
Remarks
This method disconnects from the mail relay.
DoEvents Method (SMTP Class)
This method processes events from the internal message queue.
Syntax
public void doEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Expand Method (SMTP Class)
This method asks the MailServer to expand a name or mailing list.
Syntax
public void expand(String emailAddress);
Remarks
This method asks the MailServer to expand a name or mailing list. The resulting response is provided in one or more Expand events (one for each address). The class will try to connect to the mail relay if it is not already connected.
Interrupt Method (SMTP Class)
This method interrupts the current method.
Syntax
public void interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ProcessQueue Method (SMTP Class)
This method sends the messages that previously have been queued into QueueDir .
Syntax
public void processQueue(String queueDir);
Remarks
This method sends the messages that previously have been queued into QueueDir. The PITrail event shows the interaction with the server as messages are processed.
This method looks in the directory for files with the extension ".queued" and starts processing them.
When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".
If the file is successfully sent, the file is normally deleted, unless the KeepQueue configuration setting is set to True, in which case the file extension is instead changed to ".sent" and the queue file is not deleted.
Queue Method (SMTP Class)
This method queues the message into QueueDir .
Syntax
public String queue(String queueDir);
Remarks
This method queues the message into QueueDir. The message is queued into a unique file into the directory QueueDir for future processing.
QueueDir must already exist, or an error will be generated. Alternatively, QueueDir may be set to "*" to return the result as a string instead of writing it to a file.
This method returns the name of the unique queue file created in QueueDir. The file extension is ".queued".
Please refer to the ProcessQueue method for more information on email queue processing.
Reset Method (SMTP Class)
This method will reset the class.
Syntax
public void reset();
Remarks
This method will reset the class's properties to their default values.
ResetHeaders Method (SMTP Class)
This method resets all the message headers to empty.
Syntax
public void resetHeaders();
Remarks
This method resets all the message headers to "" (empty string). Use this method before creating a new message, so that headers from the previous message are not carried over to the next one.
Send Method (SMTP Class)
This method sends the current message.
Syntax
public void send();
Remarks
This method sends the current message. 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 Email:
SMTPControl.MailServer = "MyServer"
SMTPControl.From = "me@server.com"
SMTPControl.SendTo = "recipient@server.com"
SMTPControl.Subject = "My Subject"
SMTPControl.MessageText = "This is the message body"
SMTPControl.Send()
SendCommand Method (SMTP Class)
This method sends the exact command directly to the server.
Syntax
public void sendCommand(String command);
Remarks
This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.
After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.
SendToTerminalAndEmail Method (SMTP Class)
This method sends to terminal and email.
Syntax
public void sendToTerminalAndEmail();
Remarks
This method is similar to Send but requests also that the message is sent to the terminal of the users as well, if they are logged on and accept terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.
SendToTerminalOnly Method (SMTP Class)
This method sends to terminal only.
Syntax
public void sendToTerminalOnly();
Remarks
This method is similar to Send but requests instead that the message is sent to the user's terminal. An exception with the server's response is raised if the user is not logged in or does not accept terminal messages. This method requires that AllowExtensions is set to True and is not supported by all mail relays.
SendToTerminalOrEmail Method (SMTP Class)
This method sends to terminal or email.
Syntax
public void sendToTerminalOrEmail();
Remarks
This method is similar to Send but requests instead that the message is first sent to the user's terminal. If the user is not logged in or does not accept terminal messages, the message is sent to his or her mailbox. This method requires that AllowExtensions is set to True and is not supported by all mail relays.
SetMessageStream Method (SMTP Class)
This method sets the stream to be uploaded to the server as part of the message.
Syntax
public void setMessageStream(java.io.InputStream messageStream);
Remarks
This method sets the stream to be uploaded to the server as part of the message. If an upload stream is set before the Send method is called, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is set to True (default). If the stream is closed, you will need to call this method again before calling Send again. The content of the stream will be read from the current position all the way to the end.
Note: This method and LocalFile will reset the other.
Verify Method (SMTP Class)
This method sends a verification request to the SMTP server.
Syntax
public void verify(String emailAddress);
Remarks
This method asks the MailServer to verify the email address provided in the 'EmailAddress' parameter.
ConnectionStatus Event (SMTP Class)
This event is fired to indicate changes in the connection state.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void connectionStatus(SMTPConnectionStatusEvent e) {} ... } public class SMTPConnectionStatusEvent { public String connectionEvent; public int statusCode; public String description; }
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
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. |
EndTransfer Event (SMTP Class)
This event is fired when the message text completes transferring.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void endTransfer(SMTPEndTransferEvent e) {} ... } public class SMTPEndTransferEvent { public int direction; }
Remarks
If MessageText is not empty, the EndTransfer event is fired when the MessageText finishes transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.
If a file is attached to the MessageText via the AttachedFile property, then EndTransfer fires again when the file finishes transferring. For more information, go to the description of the AttachedFile property.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (SMTP Class)
Fired when information is available about errors during data delivery.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void error(SMTPErrorEvent e) {} ... } public class SMTPErrorEvent { public int errorCode; public String description; }
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Expand Event (SMTP Class)
This event is fired for every email address returned by the server when the Expand method is called.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void expand(SMTPExpandEvent e) {} ... } public class SMTPExpandEvent { public String address; }
Remarks
This event is fired for every email address as returned by the mail server when the Expand method is called.
The Address parameter may contain a name and an email address, or just an email address, suitable for any of the addressing properties.
PITrail Event (SMTP Class)
This event traces the commands sent to the mail server, and the respective replies.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void PITrail(SMTPPITrailEvent e) {} ... } public class SMTPPITrailEvent { public int direction; public String message; }
Remarks
The PITrail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers.
The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:
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 (SMTP Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void SSLServerAuthentication(SMTPSSLServerAuthenticationEvent e) {} ... } public class SMTPSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; //read-write }
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (SMTP Class)
Fired when secure connection progress messages are available.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void SSLStatus(SMTPSSLStatusEvent e) {} ... } public class SMTPSSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (SMTP Class)
This event is fired when the message text starts transferring.
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void startTransfer(SMTPStartTransferEvent e) {} ... } public class SMTPStartTransferEvent { public int direction; }
Remarks
If MessageText is not empty, the StartTransfer event is fired when the MessageText starts transferring from the local host to the MailServer. If MessageText is empty, the event is not fired.
If a file is attached to the MessageText via the AttachedFile property, then StartTransfer fires again when the file starts transferring. Please go to the description of the AttachedFile property for more information.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (SMTP Class)
This event is fired when the message text is transferred to MailServer .
Syntax
public class DefaultSMTPEventListener implements SMTPEventListener { ... public void transfer(SMTPTransferEvent e) {} ... } public class SMTPTransferEvent { public int direction; public long bytesTransferred; public int percentDone; public byte[] text; }
Remarks
One or more Transfer events are fired during message delivery. Messages consist of MessageText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of MessageText or AttachedFile.
Text contains the current portion of the message being sent.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
String (read-only)
Default Value: ""
This is 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: ""
This is the date 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: ""
This is 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: ""
This is 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: ""
This is 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: ""
This is 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: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
KeyPassword
String
Default Value: ""
This is the password for the certificate's private key (if any).
Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.
Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.
PrivateKey
String (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
boolean (read-only)
Default Value: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
String (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
String (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
String (read-only)
Default Value: ""
This field contains 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
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
String (read-only)
Default Value: ""
This is 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 field contains 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.
Store
String
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte[]
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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
int
Default Value: 0
This is 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 field 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 Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
String (read-only)
Default Value: ""
This field contains 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: ""
This field contains 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: ""
This field contains 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: ""
This field contains the text description of UsageFlags.
This value will be of 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
int (read-only)
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
String (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
String
Default Value: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
String
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte[]
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate( encoded);
Parses Encoded as an X.509 public key.
public Certificate( storeType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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 Certificate( storeType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class 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 Certificate( storeType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate( storeType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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 Certificate( storeType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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 Certificate( storeType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the class will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
boolean
Default Value: False
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.
If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).
FirewallType
int
Default Value: 0
This field determines 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. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
String
Default Value: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.
Password
String
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.
Port
int
Default Value: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
String
Default Value: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.
Constructors
public Firewall();
Header Type
This is an HTTP header as it is received from the server.
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.
Fields
Field
String
Default Value: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
String
Default Value: ""
This field contains the Header contents.
Constructors
public Header();
public Header( field, value);
MessageRecipient Type
This types describes the message recipient.
Remarks
This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the class is sending the message.
Fields
Address
String
Default Value: ""
This field contains the email address of the recipient.
Name
String
Default Value: ""
This field contains the name of the recipient.
Options
String
Default Value: ""
This field 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.MessageRecipients(0).Options = "NOTIFY SUCCESS,FAILURE,DELAY";
RecipientType
int
Default Value: 0
This field contains the recipient type: To, Cc, or Bcc.
Constructors
public MessageRecipient();
public MessageRecipient( address);
public MessageRecipient( address, recipientType);
Config Settings (SMTP Class)
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.SMTP Config Settings
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q
Note: When using amXOAUTH2, User must be specified, but Password is not required.
Note: This is True by default.
If AllowExtensions is True, the EHLO command will be sent instead of the HELO command.
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.
Example:
smtp1.Send();
string rawMsg = smtp1.Config("MessageHeadersString") + smtp1.Config("TransferText");
Possible values are as follows:
- "MD5"
- "SHA1" (default)
- "SHA256"
Example:
smtp1.Send();
string rawMsg = smtp1.Config("MessageHeadersString") + smtp1.Config("TransferText");
TCPClient Config Settings
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.
If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect 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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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.
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).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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.
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.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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.
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.
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.
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-----
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.
Note: This value must be set after SSLProvider is set.
Example values:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
Possible values when SSLProvider is set to Platform include the following:
- SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_RC4_128_SHA
- SSL_RSA_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_WITH_DES_CBC_SHA
- SSL_RSA_WITH_NULL_MD5
- SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
- SSL_DHE_RSA_WITH_DES_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
- SSL_RSA_WITH_NULL_SHA
- SSL_DH_anon_WITH_RC4_128_MD5
- SSL_RSA_WITH_RC4_128_MD5
- SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_NULL_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
- TLS_ECDH_anon_WITH_RC4_128_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_EXPORT_WITH_RC4_40_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_RC4_128_SHA
- TLS_ECDH_ECDSA_WITH_RC4_128_SHA
- TLS_ECDH_anon_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_NULL_SHA256
- TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
- TLS_KRB5_WITH_RC4_128_MD5
- TLS_ECDHE_ECDSA_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_RC4_128_SHA
- TLS_EMPTY_RENEGOTIATION_INFO_SCSV
- TLS_KRB5_WITH_3DES_EDE_CBC_MD5
- TLS_KRB5_WITH_RC4_128_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_NULL_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_DES_CBC_MD5
- TLS_KRB5_EXPORT_WITH_RC4_40_MD5
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
- TLS_ECDH_anon_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_WITH_DES_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_NULL_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_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.
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.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (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.
This configuration setting is applicable only when SSLProvider is set to Internal.
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.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
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.
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]");
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]");
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]");
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]");
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]");
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]");
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-----
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 throws an exception.
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.
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)
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"
- "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 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
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.
- 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.
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.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (SMTP Class)
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. |
303 | 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). |