FileMailer Control
Properties Methods Events Config Settings Errors
The FileMailer Control is used to send emails with file attachments.
Syntax
FileMailer
Remarks
The FileMailer Control 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 control sends a message (provided in MessageText) and one or more file attachments specified in the Attachments properties.
The recipients are specified by the SendTo, Cc, and BCc properties, and the message subject is specified by the Subject property.
After all of the appropriate properties have been set, call the Send method and your message will be sent to its intended recipients.
Other SMTP headers may be specified through the OtherHeaders property. Information about interaction with the server is provided through the PITrail event.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
AttachmentCount | The number of records in the Attachment arrays. |
AttachmentData | The raw data for the attachment that will be sent with your message. |
AttachmentFileName | This property contains the path of a file on your system to be sent as an attachment with your message. |
AttachmentName | This property contains the name of the attachment to be sent. |
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 control is connected. |
DeliveryNotificationTo | This property includes the email address to which to send a delivery notification. |
FirewallAutoDetect | This property tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of the firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a username if authentication is to be used when connecting through a firewall. |
From | This property includes the email address of the sender (required). |
Idle | This property specifies the current status of the control. |
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). |
MessageDate | This property includes the date of the mail message (optional). |
MessageId | This property includes the message identifier for the message. |
MessageRecipientCount | The number of records in the MessageRecipient arrays. |
MessageRecipientAddress | This property contains the email address of the recipient. |
MessageRecipientName | This property contains the name of the recipient. |
MessageRecipientOptions | This property contains the recipient sending options (used only by SMTP). |
MessageRecipientType | This property contains the recipient type: To, Cc, or Bcc. |
MessageText | This is 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). |
SendTo | This property includes a comma-separated list of addresses for destinations (required). |
Sensitivity | This property indicates the sensitivity of the mail message (optional). |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
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. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLStartMode | This property determines how the control 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 control. |
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 control with short descriptions. Click on the links for further details.
AddAttachment | This adds FileName as an attachment. |
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. |
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 control. |
ResetHeaders | This method resets all the message headers to empty. |
Send | This sends the current message and the MIME-encoded attachment. |
SendCommand | This method sends the exact command directly to the server. |
Event List
The following is the full list of the events fired by the control 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. |
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 control with short descriptions. Click on the links for further details.
AttachmentEncoding[index] | Content-Transfer-Encoding for attached file (at index). |
AttachmentText[index] | Add the text into the attachment at the specified index. |
AttachmentType[index] | Content-type for attached file (at index). |
Charset | When set, the charset Content-Type attribute will be added using the specified value. |
MessageTextEncoding | When set, the MessageText value will be encoded using the specified encoding. |
OverrideFileName | If set to true, the AttachmentName property value will be used to set the MIME part FileName attribute. |
TempFilePath | If set, the temporary files created during message creation will be put in the path specified. |
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. |
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 control to stop sending the message if the server does not acknowledge any of the BCCs. |
StopOnCcErrors | Instructs the control to stop sending the message if the server does not acknowledge any of the CCs. |
StopOnToErrors | Instructs the control 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. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
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 control 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. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
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. |
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. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
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. |
CodePage | The system code page used for Unicode to Multibyte translations. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AttachmentCount Property (FileMailer Control)
The number of records in the Attachment arrays.
Syntax
filemailercontrol.AttachmentCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at AttachmentCount - 1.This property is not available at design time.
Data Type
Integer
AttachmentData Property (FileMailer Control)
The raw data for the attachment that will be sent with your message.
Syntax
filemailercontrol.AttachmentData(AttachmentIndex)[=string]
Default Value
""
Remarks
The raw data for the attachment that will be sent with your message. This field is used if AttachmentFileName is not set.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttachmentDataB.
This property is not available at design time.
Data Type
Binary String
AttachmentFileName Property (FileMailer Control)
This property contains the path of a file on your system to be sent as an attachment with your message.
Syntax
filemailercontrol.AttachmentFileName(AttachmentIndex)[=string]
Default Value
""
Remarks
This property contains the path of a file on your system to be sent as an attachment with your message.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
String
AttachmentName Property (FileMailer Control)
This property contains the name of the attachment to be sent.
Syntax
filemailercontrol.AttachmentName(AttachmentIndex)[=string]
Default Value
""
Remarks
This property contains the name of the attachment to be sent.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
String
AuthMechanism Property (FileMailer Control)
This property is used when connecting to the mail server.
Syntax
filemailercontrol.AuthMechanism[=integer]
Possible Values
amUserPassword(0), amCRAMMD5(1), amNTLM(2), amAPOP(3), amSASLPlain(4), amSASLDigestMD5(5), amKerberos(6), 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.
Data Type
Integer
BCc Property (FileMailer Control)
This property includes a comma-separated list of addresses for blind carbon copies (optional).
Syntax
filemailercontrol.BCc[=string]
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no BCc SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.
The control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in this property.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.
Data Type
String
Cc Property (FileMailer Control)
This property includes a comma-separated list of addresses for carbon copies (optional).
Syntax
filemailercontrol.Cc[=string]
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc).
The control will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.
Data Type
String
Connected Property (FileMailer Control)
This property shows whether the control is connected.
Syntax
filemailercontrol.Connected
Default Value
False
Remarks
This property is used to determine whether or not the control 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.
Data Type
Boolean
DeliveryNotificationTo Property (FileMailer Control)
This property includes the email address to which to send a delivery notification.
Syntax
filemailercontrol.DeliveryNotificationTo[=string]
Default Value
""
Remarks
This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address that can receive the delivery notification.
Data Type
String
FirewallAutoDetect Property (FileMailer Control)
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Syntax
filemailercontrol.FirewallAutoDetect[=boolean]
Default Value
False
Remarks
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (FileMailer Control)
This property determines the type of firewall to connect through.
Syntax
filemailercontrol.FirewallType[=integer]
Possible Values
fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)
Default Value
0
Remarks
This property 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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (FileMailer Control)
This property contains the name or IP address of the firewall (optional).
Syntax
filemailercontrol.FirewallHost[=string]
Default Value
""
Remarks
This property contains the name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.
Data Type
String
FirewallPassword Property (FileMailer Control)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
filemailercontrol.FirewallPassword[=string]
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
Data Type
String
FirewallPort Property (FileMailer Control)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
filemailercontrol.FirewallPort[=integer]
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (FileMailer Control)
This property contains a username if authentication is to be used when connecting through a firewall.
Syntax
filemailercontrol.FirewallUser[=string]
Default Value
""
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.
Data Type
String
From Property (FileMailer Control)
This property includes the email address of the sender (required).
Syntax
filemailercontrol.From[=string]
Default Value
""
Remarks
This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are 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.
Data Type
String
Idle Property (FileMailer Control)
This property specifies the current status of the control.
Syntax
filemailercontrol.Idle
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.
Data Type
Boolean
Importance Property (FileMailer Control)
This property indicates the importance of the mail message (optional).
Syntax
filemailercontrol.Importance[=integer]
Possible Values
miUnspecified(0), miHigh(1), miNormal(2), 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).
Data Type
Integer
LastReply Property (FileMailer Control)
This property indicates the last reply received from the server.
Syntax
filemailercontrol.LastReply
Default Value
""
Remarks
This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.
This property is read-only.
Data Type
String
LocalHost Property (FileMailer Control)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
filemailercontrol.LocalHost[=string]
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) 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 control 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.
Data Type
String
MailPort Property (FileMailer Control)
This property includes the server port for SMTP (default 25).
Syntax
filemailercontrol.MailPort[=integer]
Default Value
25
Remarks
This property contains the server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
For 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.
Data Type
Integer
MailServer Property (FileMailer Control)
This property includes the name or address of a mail server (mail relay).
Syntax
filemailercontrol.MailServer[=string]
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or domain name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.
The current version of the control 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 control 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.
Data Type
String
MessageDate Property (FileMailer Control)
This property includes the date of the mail message (optional).
Syntax
filemailercontrol.MessageDate[=string]
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 control
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.
Data Type
String
MessageId Property (FileMailer Control)
This property includes the message identifier for the message.
Syntax
filemailercontrol.MessageId[=string]
Default Value
"*"
Remarks
This property contains the message identifier for the message. When set, the value of MessageId is used as the Message-Id header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.
This property is not available at design time.
Data Type
String
MessageRecipientCount Property (FileMailer Control)
The number of records in the MessageRecipient arrays.
Syntax
filemailercontrol.MessageRecipientCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageRecipientCount - 1.This property is not available at design time.
Data Type
Integer
MessageRecipientAddress Property (FileMailer Control)
This property contains the email address of the recipient.
Syntax
filemailercontrol.MessageRecipientAddress(RecipientIndex)[=string]
Default Value
""
Remarks
This property contains the email address of the recipient.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is not available at design time.
Data Type
String
MessageRecipientName Property (FileMailer Control)
This property contains the name of the recipient.
Syntax
filemailercontrol.MessageRecipientName(RecipientIndex)[=string]
Default Value
""
Remarks
This property contains the name of the recipient.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is not available at design time.
Data Type
String
MessageRecipientOptions Property (FileMailer Control)
This property contains the recipient sending options (used only by SMTP).
Syntax
filemailercontrol.MessageRecipientOptions(RecipientIndex)[=string]
Default Value
""
Remarks
This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).
One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.
component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is not available at design time.
Data Type
String
MessageRecipientType Property (FileMailer Control)
This property contains the recipient type: To, Cc, or Bcc.
Syntax
filemailercontrol.MessageRecipientType(RecipientIndex)[=integer]
Possible Values
rtTo(0), rtCc(1), rtBCc(2)
Default Value
0
Remarks
This property contains the recipient type: To, Cc, or Bcc.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is not available at design time.
Data Type
Integer
MessageText Property (FileMailer Control)
This is the full text of the message to send (without headers).
Syntax
filemailercontrol.MessageText[=string]
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 (Chr$(13) & Chr$(10)) . 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 control 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.
Data Type
String
OtherHeaders Property (FileMailer Control)
This property includes an RFC 822-compliant string consisting of extra headers.
Syntax
filemailercontrol.OtherHeaders[=string]
Default Value
""
Remarks
This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, and so on.
The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .
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 control. 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.
Data Type
String
Password Property (FileMailer Control)
This property includes a password for logon to the MailServer .
Syntax
filemailercontrol.Password[=string]
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.
Data Type
String
Priority Property (FileMailer Control)
This property includes the priority of the mail message (optional).
Syntax
filemailercontrol.Priority[=integer]
Possible Values
epUnspecified(0), epNormal(1), epUrgent(2), 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.
Data Type
Integer
ReadReceiptTo Property (FileMailer Control)
This property includes the email address to send a read-receipt to.
Syntax
filemailercontrol.ReadReceiptTo[=string]
Default Value
""
Remarks
When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address that should receive the read-receipt.
Data Type
String
ReplyTo Property (FileMailer Control)
This property includes a mail address to which to reply (optional).
Syntax
filemailercontrol.ReplyTo[=string]
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.
Data Type
String
SendTo Property (FileMailer Control)
This property includes a comma-separated list of addresses for destinations (required).
Syntax
filemailercontrol.SendTo[=string]
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.
Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com
The control will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same thing happens with an email address specified in BCc.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.
Data Type
String
Sensitivity Property (FileMailer Control)
This property indicates the sensitivity of the mail message (optional).
Syntax
filemailercontrol.Sensitivity[=integer]
Possible Values
esUnspecified(0), esPersonal(1), esPrivate(2), 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).
Data Type
Integer
SSLAcceptServerCertEffectiveDate Property (FileMailer Control)
This is the date on which this certificate becomes valid.
Syntax
filemailercontrol.SSLAcceptServerCertEffectiveDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (FileMailer Control)
This is the date the certificate expires.
Syntax
filemailercontrol.SSLAcceptServerCertExpirationDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (FileMailer Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
filemailercontrol.SSLAcceptServerCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (FileMailer Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertFingerprint
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (FileMailer Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertFingerprintSHA1
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (FileMailer Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertFingerprintSHA256
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (FileMailer Control)
This is the issuer of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (FileMailer Control)
This is the private key of the certificate (if available).
Syntax
filemailercontrol.SSLAcceptServerCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (FileMailer Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
filemailercontrol.SSLAcceptServerCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (FileMailer Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
filemailercontrol.SSLAcceptServerCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (FileMailer Control)
This is the public key of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (FileMailer Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
filemailercontrol.SSLAcceptServerCertPublicKeyAlgorithm
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (FileMailer Control)
This is the length of the certificate's public key (in bits).
Syntax
filemailercontrol.SSLAcceptServerCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (FileMailer Control)
This is the serial number of the certificate encoded as a string.
Syntax
filemailercontrol.SSLAcceptServerCertSerialNumber
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (FileMailer Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
filemailercontrol.SSLAcceptServerCertSignatureAlgorithm
Default Value
""
Remarks
The property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (FileMailer Control)
This is the name of the certificate store for the client certificate.
Syntax
filemailercontrol.SSLAcceptServerCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property 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. |
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (FileMailer Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
filemailercontrol.SSLAcceptServerCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLAcceptServerCertStoreType Property (FileMailer Control)
This is the type of certificate store for this certificate.
Syntax
filemailercontrol.SSLAcceptServerCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. 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 SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword 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. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (FileMailer Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (FileMailer Control)
This property contains the MD5 hash of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertThumbprintMD5
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (FileMailer Control)
This property contains the SHA-1 hash of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertThumbprintSHA1
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (FileMailer Control)
This property contains the SHA-256 hash of the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertThumbprintSHA256
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (FileMailer Control)
This property contains the text description of UsageFlags .
Syntax
filemailercontrol.SSLAcceptServerCertUsage
Default Value
""
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (FileMailer Control)
This property contains the flags that show intended use for the certificate.
Syntax
filemailercontrol.SSLAcceptServerCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags 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 SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (FileMailer Control)
This property contains the certificate's version number.
Syntax
filemailercontrol.SSLAcceptServerCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (FileMailer Control)
This is the subject of the certificate used for client authentication.
Syntax
filemailercontrol.SSLAcceptServerCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLAcceptServerCertEncoded Property (FileMailer Control)
This is the certificate (PEM/Base64 encoded).
Syntax
filemailercontrol.SSLAcceptServerCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (FileMailer Control)
This is the date on which this certificate becomes valid.
Syntax
filemailercontrol.SSLCertEffectiveDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (FileMailer Control)
This is the date the certificate expires.
Syntax
filemailercontrol.SSLCertExpirationDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (FileMailer Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
filemailercontrol.SSLCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (FileMailer Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
filemailercontrol.SSLCertFingerprint
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (FileMailer Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
filemailercontrol.SSLCertFingerprintSHA1
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (FileMailer Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
filemailercontrol.SSLCertFingerprintSHA256
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLCertIssuer Property (FileMailer Control)
This is the issuer of the certificate.
Syntax
filemailercontrol.SSLCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (FileMailer Control)
This is the private key of the certificate (if available).
Syntax
filemailercontrol.SSLCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (FileMailer Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
filemailercontrol.SSLCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (FileMailer Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
filemailercontrol.SSLCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (FileMailer Control)
This is the public key of the certificate.
Syntax
filemailercontrol.SSLCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (FileMailer Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
filemailercontrol.SSLCertPublicKeyAlgorithm
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (FileMailer Control)
This is the length of the certificate's public key (in bits).
Syntax
filemailercontrol.SSLCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (FileMailer Control)
This is the serial number of the certificate encoded as a string.
Syntax
filemailercontrol.SSLCertSerialNumber
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (FileMailer Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
filemailercontrol.SSLCertSignatureAlgorithm
Default Value
""
Remarks
The property 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.
This property is read-only.
Data Type
String
SSLCertStore Property (FileMailer Control)
This is the name of the certificate store for the client certificate.
Syntax
filemailercontrol.SSLCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property 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. |
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (FileMailer Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
filemailercontrol.SSLCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (FileMailer Control)
This is the type of certificate store for this certificate.
Syntax
filemailercontrol.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. 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 SSLCertStore and set SSLCertStorePassword 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. |
Data Type
Integer
SSLCertSubjectAltNames Property (FileMailer Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
filemailercontrol.SSLCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (FileMailer Control)
This property contains the MD5 hash of the certificate.
Syntax
filemailercontrol.SSLCertThumbprintMD5
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (FileMailer Control)
This property contains the SHA-1 hash of the certificate.
Syntax
filemailercontrol.SSLCertThumbprintSHA1
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (FileMailer Control)
This property contains the SHA-256 hash of the certificate.
Syntax
filemailercontrol.SSLCertThumbprintSHA256
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLCertUsage Property (FileMailer Control)
This property contains the text description of UsageFlags .
Syntax
filemailercontrol.SSLCertUsage
Default Value
""
Remarks
This property contains the text description of SSLCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (FileMailer Control)
This property contains the flags that show intended use for the certificate.
Syntax
filemailercontrol.SSLCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (FileMailer Control)
This property contains the certificate's version number.
Syntax
filemailercontrol.SSLCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (FileMailer Control)
This is the subject of the certificate used for client authentication.
Syntax
filemailercontrol.SSLCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLCertEncoded Property (FileMailer Control)
This is the certificate (PEM/Base64 encoded).
Syntax
filemailercontrol.SSLCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLEnabled Property (FileMailer Control)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
filemailercontrol.SSLEnabled[=boolean]
Default Value
False
Remarks
This property specifies whether TLS/SSL is enabled in the control. When False (default), the control 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.
Data Type
Boolean
SSLProvider Property (FileMailer Control)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
filemailercontrol.SSLProvider[=integer]
Possible Values
sslpAutomatic(0), sslpPlatform(1), 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 control 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 control 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.
Data Type
Integer
SSLServerCertEffectiveDate Property (FileMailer Control)
This is the date on which this certificate becomes valid.
Syntax
filemailercontrol.SSLServerCertEffectiveDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (FileMailer Control)
This is the date the certificate expires.
Syntax
filemailercontrol.SSLServerCertExpirationDate
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (FileMailer Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
filemailercontrol.SSLServerCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (FileMailer Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
filemailercontrol.SSLServerCertFingerprint
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (FileMailer Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
filemailercontrol.SSLServerCertFingerprintSHA1
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (FileMailer Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
filemailercontrol.SSLServerCertFingerprintSHA256
Default Value
""
Remarks
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
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (FileMailer Control)
This is the issuer of the certificate.
Syntax
filemailercontrol.SSLServerCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (FileMailer Control)
This is the private key of the certificate (if available).
Syntax
filemailercontrol.SSLServerCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (FileMailer Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
filemailercontrol.SSLServerCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (FileMailer Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
filemailercontrol.SSLServerCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (FileMailer Control)
This is the public key of the certificate.
Syntax
filemailercontrol.SSLServerCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (FileMailer Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
filemailercontrol.SSLServerCertPublicKeyAlgorithm
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (FileMailer Control)
This is the length of the certificate's public key (in bits).
Syntax
filemailercontrol.SSLServerCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (FileMailer Control)
This is the serial number of the certificate encoded as a string.
Syntax
filemailercontrol.SSLServerCertSerialNumber
Default Value
""
Remarks
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.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (FileMailer Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
filemailercontrol.SSLServerCertSignatureAlgorithm
Default Value
""
Remarks
The property 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.
This property is read-only.
Data Type
String
SSLServerCertStore Property (FileMailer Control)
This is the name of the certificate store for the client certificate.
Syntax
filemailercontrol.SSLServerCertStore
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property 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. |
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (FileMailer Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
filemailercontrol.SSLServerCertStorePassword
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (FileMailer Control)
This is the type of certificate store for this certificate.
Syntax
filemailercontrol.SSLServerCertStoreType
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. 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 SSLServerCertStore and set SSLServerCertStorePassword 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. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (FileMailer Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
filemailercontrol.SSLServerCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (FileMailer Control)
This property contains the MD5 hash of the certificate.
Syntax
filemailercontrol.SSLServerCertThumbprintMD5
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (FileMailer Control)
This property contains the SHA-1 hash of the certificate.
Syntax
filemailercontrol.SSLServerCertThumbprintSHA1
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (FileMailer Control)
This property contains the SHA-256 hash of the certificate.
Syntax
filemailercontrol.SSLServerCertThumbprintSHA256
Default Value
""
Remarks
This property 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.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (FileMailer Control)
This property contains the text description of UsageFlags .
Syntax
filemailercontrol.SSLServerCertUsage
Default Value
""
Remarks
This property contains the text description of SSLServerCertUsageFlags.
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.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (FileMailer Control)
This property contains the flags that show intended use for the certificate.
Syntax
filemailercontrol.SSLServerCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags 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 SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (FileMailer Control)
This property contains the certificate's version number.
Syntax
filemailercontrol.SSLServerCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (FileMailer Control)
This is the subject of the certificate used for client authentication.
Syntax
filemailercontrol.SSLServerCertSubject
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (FileMailer Control)
This is the certificate (PEM/Base64 encoded).
Syntax
filemailercontrol.SSLServerCertEncoded
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.
This property is read-only and not available at design time.
Data Type
Binary String
SSLStartMode Property (FileMailer Control)
This property determines how the control starts the Secure Sockets Layer (SSL) negotiation.
Syntax
filemailercontrol.SSLStartMode[=integer]
Possible Values
sslAutomatic(0), sslImplicit(1), sslExplicit(2), 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 control 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 control 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. |
Data Type
Integer
Subject Property (FileMailer Control)
This property includes the subject of the mail message (optional).
Syntax
filemailercontrol.Subject[=string]
Default Value
""
Remarks
The string in this property is sent with a Subject SMTP header to the mail recipient.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Data Type
String
Timeout Property (FileMailer Control)
This property includes the timeout for the control.
Syntax
filemailercontrol.Timeout[=integer]
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.
The control 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 control fails with an error.
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.
Data Type
Integer
User Property (FileMailer Control)
This property includes the user identifier needed to log in as in the MailServer .
Syntax
filemailercontrol.User[=string]
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.
Data Type
String
AddAttachment Method (FileMailer Control)
This adds FileName as an attachment.
Syntax
filemailercontrol.AddAttachment FileName
Remarks
This method adds the file name as an attachment. The full list of attachments is contained in the Attachments property.
Example 1: Adding an Attachment
component.AddAttachment("C:\file1.zip");
component.AddAttachment("C:\file2.zip");
component.Send();
Example 3: Using an Attachments Array
component.AttachmentCount = 1;
component.AttachmentName(0) = "name";
component.AttachmentFile(0) = "C:\file.txt";
Config Method (FileMailer Control)
Sets or retrieves a configuration setting.
Syntax
filemailercontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (FileMailer Control)
This method connects to the mail relay and sends the SMTP HELO command.
Syntax
filemailercontrol.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 (FileMailer Control)
This method disconnects from the SMTP server.
Syntax
filemailercontrol.Disconnect
Remarks
This method disconnects from the mail relay.
DoEvents Method (FileMailer Control)
This method processes events from the internal message queue.
Syntax
filemailercontrol.DoEvents
Remarks
When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Interrupt Method (FileMailer Control)
This method interrupts the current method.
Syntax
filemailercontrol.Interrupt
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ProcessQueue Method (FileMailer Control)
This method sends the messages that previously have been queued into QueueDir .
Syntax
filemailercontrol.ProcessQueue 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 (FileMailer Control)
This method queues the message into QueueDir .
Syntax
filemailercontrol.Queue 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 (FileMailer Control)
This method will reset the control.
Syntax
filemailercontrol.Reset
Remarks
This method will reset the control's properties to their default values.
ResetHeaders Method (FileMailer Control)
This method resets all the message headers to empty.
Syntax
filemailercontrol.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 (FileMailer Control)
This sends the current message and the MIME-encoded attachment.
Syntax
filemailercontrol.Send
Remarks
This method sends the current message and the MIME-encoded attachment. If the control 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 control 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.
SendCommand Method (FileMailer Control)
This method sends the exact command directly to the server.
Syntax
filemailercontrol.SendCommand 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.
ConnectionStatus Event (FileMailer Control)
This event is fired to indicate changes in the connection state.
Syntax
Sub filemailercontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)
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 (FileMailer Control)
This event is fired when the message text completes transferring.
Syntax
Sub filemailercontrol_EndTransfer(Direction As Integer)
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 (FileMailer Control)
Fired when information is available about errors during data delivery.
Syntax
Sub filemailercontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
PITrail Event (FileMailer Control)
This event traces the commands sent to the mail server, and the respective replies.
Syntax
Sub filemailercontrol_PITrail(Direction As Integer, Message As String)
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 control code). |
SSLServerAuthentication Event (FileMailer Control)
Fired after the server presents its certificate to the client.
Syntax
Sub filemailercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
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 (FileMailer Control)
Fired when secure connection progress messages are available.
Syntax
Sub filemailercontrol_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (FileMailer Control)
This event is fired when the message text starts transferring.
Syntax
Sub filemailercontrol_StartTransfer(Direction As Integer)
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 (FileMailer Control)
This event is fired when the message text is transferred to MailServer .
Syntax
Sub filemailercontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)
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.
Config Settings (FileMailer Control)
The control 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 control, access to these internal properties is provided through the Config method.FileMailer Config Settings
0 | 7-bit |
1 | Quoted-Printable |
2 | Base64 |
3 | 8-bit |
0 | 7-bit |
1 | Quoted-Printable |
2 | Base64 |
3 | 8-bit |
SMTP Config Settings
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q
Note: When using amXOAUTH2, User must be specified, but Password is not required.
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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls 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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls 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 control 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 control initiate connections (or accept in the case of server controls) only through that interface.
If the control 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.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the control 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 control 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 control. 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 control 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 control will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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 control 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 control 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.
When set, the control 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 control 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]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
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 control 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 control fails with an error.
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 control 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 control 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
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (FileMailer Control)
FileMailer Errors
20170 | Invalid attachment index (out of range). |
20171 | Cannot create temporary file. |
The control may also return one of the following error codes, which are inherited from other controls.
MIME Errors
20004 | Can't create the file for write (illegal name or disk is write-protected). |
20005 | Can't open the file for read (doesn't exist?). |
20006 | Can't read from file. |
20007 | Can't write to file (disk full?). |
20281 | Invalid Part Index. |
20282 | Unknown MIME type. |
20283 | No MIME-boundary found. |
20284 | No file given. |
20285 | The control is busy. |
20286 | Can't create a temporary file to decode the data. |
20287 | Can't read Message file. |
20288 | No header separator found. |
20290 | No separator found. |
20291 | Input stream must have seeking enabled. |
SMTP Errors
20119 | Firewall Error. Error message contains detailed description. |
20162 | SMTP protocol error. Description contains the server reply. |
20163 | Error communicating with server. Error text is attached. |
20164 | Please specify a MailServer. |
20165 | Please specify a sender (From). |
20166 | Please specify a recipient. |
20167 | Busy executing current method. |
20302 | Operation interrupted. |
20303 | Cannot open AttachedFile. |
The control may also return one of the following error codes, which are inherited from other controls.
TCPClient Errors
20101 | You cannot change the RemotePort at this time. A connection is in progress. |
20102 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
20103 | The RemoteHost address is invalid (0.0.0.0). |
20105 | Already connected. If you want to reconnect, close the current connection first. |
20107 | You cannot change the LocalPort at this time. A connection is in progress. |
20108 | You cannot change the LocalHost at this time. A connection is in progress. |
20113 | You cannot change MaxLineLength at this time. A connection is in progress. |
20117 | RemotePort cannot be zero. Please specify a valid service port number. |
20118 | You cannot change the UseConnection option while the control is active. |
20136 | Operation would block. |
20202 | Timeout. |
20212 | Action impossible in control's present state. |
20213 | Action impossible while not connected. |
20214 | Action impossible while listening. |
20302 | Timeout. |
20303 | Could not open file. |
20435 | Unable to convert string to selected CodePage. |
21106 | Already connecting. If you want to reconnect, close the current connection first. |
21118 | You need to connect first. |
21120 | You cannot change the LocalHost at this time. A connection is in progress. |
21121 | Connection dropped by remote host. |
SSL Errors
20271 | Cannot load specified security library. |
20272 | Cannot open certificate store. |
20273 | Cannot find specified certificate. |
20274 | Cannot acquire security credentials. |
20275 | Cannot find certificate chain. |
20276 | Cannot verify certificate chain. |
20277 | Error during handshake. |
20281 | Error verifying certificate. |
20282 | Could not find client certificate. |
20283 | Could not find server certificate. |
20284 | Error encrypting data. |
20285 | Error decrypting data. |
TCP/IP Errors
25005 | [10004] Interrupted system call. |
25010 | [10009] Bad file number. |
25014 | [10013] Access denied. |
25015 | [10014] Bad address. |
25023 | [10022] Invalid argument. |
25025 | [10024] Too many open files. |
25036 | [10035] Operation would block. |
25037 | [10036] Operation now in progress. |
25038 | [10037] Operation already in progress. |
25039 | [10038] Socket operation on nonsocket. |
25040 | [10039] Destination address required. |
25041 | [10040] Message is too long. |
25042 | [10041] Protocol wrong type for socket. |
25043 | [10042] Bad protocol option. |
25044 | [10043] Protocol is not supported. |
25045 | [10044] Socket type is not supported. |
25046 | [10045] Operation is not supported on socket. |
25047 | [10046] Protocol family is not supported. |
25048 | [10047] Address family is not supported by protocol family. |
25049 | [10048] Address already in use. |
25050 | [10049] Cannot assign requested address. |
25051 | [10050] Network is down. |
25052 | [10051] Network is unreachable. |
25053 | [10052] Net dropped connection or reset. |
25054 | [10053] Software caused connection abort. |
25055 | [10054] Connection reset by peer. |
25056 | [10055] No buffer space available. |
25057 | [10056] Socket is already connected. |
25058 | [10057] Socket is not connected. |
25059 | [10058] Cannot send after socket shutdown. |
25060 | [10059] Too many references, cannot splice. |
25061 | [10060] Connection timed out. |
25062 | [10061] Connection refused. |
25063 | [10062] Too many levels of symbolic links. |
25064 | [10063] File name is too long. |
25065 | [10064] Host is down. |
25066 | [10065] No route to host. |
25067 | [10066] Directory is not empty |
25068 | [10067] Too many processes. |
25069 | [10068] Too many users. |
25070 | [10069] Disc Quota Exceeded. |
25071 | [10070] Stale NFS file handle. |
25072 | [10071] Too many levels of remote in path. |
25092 | [10091] Network subsystem is unavailable. |
25093 | [10092] WINSOCK DLL Version out of range. |
25094 | [10093] Winsock is not loaded yet. |
26002 | [11001] Host not found. |
26003 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
26004 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
26005 | [11004] Valid name, no data record (check DNS setup). |