PHTMLMailer Class
Properties Methods Events Config Settings Errors
The PHTMLMailer class is used to send encrypted and/or signed HTML-formatted emails with or without any attachments using OpenPGP.
Syntax
PHTMLMailer
Remarks
The PHTMLMailer class offers an easy-to-use interface that supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. It enables you to create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.
Construct the Message
To begin specify common email properties such as SendTo, Cc, BCc, Subject, and MessageText. Connection information is specified by setting MailServer and MailPort.
Encrypt
To encrypt a message specify a recipient key using the RecipientKey* properties. For instance:
PHTMLMailer1.RecipientKeyCount = 1
PHTMLMailer1.RecipientKeyKeyring(0) = "c:\my_keyring_dir"
PHTMLMailer1.RecipientKeyUserId(0) = "recipient@nsoftware.com"
The specified public key will be used to encrypt the message when Encrypt is called.
Sign
To sign a message specify a recipient key using the Key* properties. For instance:
PHTMLMailer1.KeyCount = 1
PHTMLMailer1.KeyKeyring(0) = "c:\my_keyring_dir"
PHTMLMailer1.KeyUserId(0) = "sender@nsoftware.com"
PHTMLMailer1.KeyPassphrase(0) = "password"
The specified private key will be used to sign the message when Sign is called.
Sign and Encrypt
To both sign and encrypt a message call SignAndEncrypt. The message will be signed with the private keys specified in the Key* properties and encrypted with the public keys defined in the RecipientKeys* properties.
Add Attachments
To add attachments simply call AddAttachment. The ProcessAttachments setting specifies whether attachments are also encrypted and signed.
Send
Once all the appropriate properties have been set call the Send method and the message will be sent to its intended recipient(s).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Attachments | This property contains paths of the files to attach to the message. |
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). |
CompressionMethod | The compression algorithm used. |
Connected | This property shows whether the class is connected. |
DeliveryNotificationTo | This property includes the email address to which to send a delivery notification. |
EncryptingAlgorithm | The encryption algorithm used when encrypting. |
Firewall | A set of properties related to firewall access. |
From | This property includes the email address of the sender (required). |
HTMLFile | This property includes the path to a local HTML file. |
Idle | This property specifies the current status of the class. |
Images | This property includes the embedded images in the HTML message. |
Importance | This property indicates the importance of the mail message (optional). |
Keys | A collection of keys used for cryptographic operations. |
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). |
MessageHTML | This property includes the HTML version of the message. |
MessageId | This property includes the message identifier for the message. |
MessageRecipients | This property includes the collection of recipients of the message. |
MessageText | This property includes the plaintext version of the message. |
OtherHeaders | This property includes an RFC 822-compliant string consisting of extra headers. |
ParseHTML | This property controls the behavior of the MessageHTML property. |
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. |
RecipientKeys | The collection of keys belonging to the recipient of the message. |
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). |
SigningAlgorithm | The signature hash algorithm used when signing. |
SSLAcceptServerCert | This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
SSLStartMode | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. |
Subject | This property includes the subject of the mail message (optional). |
Timeout | This property includes the timeout for the class. |
User | This property includes the user identifier needed to log in as in the MailServer . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
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. |
Encrypt | Encrypts the message. |
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 . |
ResetHeaders | This method resets all the message headers to empty. |
Send | This method sends the current message and MIME-encoded attachment. |
SendCommand | This method sends the exact command directly to the server. |
SetMessageHTMLStream | This method sets the stream from which the class will read the HTML version of the message. |
Sign | Signs the message. |
SignAndEncrypt | Signs and encrypts the current message. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
ConnectionStatus | This event is fired to indicate changes in the connection state. |
EndTransfer | This event is fired when the message text completes transferring. |
Error | Fired when information is available about errors during data delivery. |
KeyPassphrase | Fired if the passphrase of current key is incorrect or empty. |
PITrail | This event traces the commands sent to the mail server, and the respective replies. |
Progress | Fired as progress is made. |
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. |
Status | Shows the progress of the operation. |
Transfer | This event is fired when the message text is transferred to MailServer . |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
ClearSignature | Specifies whether or not to create a cleartext signature. |
Comment | The OpenPGP message comment. |
CompressionLevel | The level of compression used. |
EnsureValidDSASignatureHashAlgorithm | Whether or not to select a suitable signature hash algorithm automatically. |
LogLevel | Specifies the level of detail that is logged. |
ProcessAttachments | Whether or not to process attachments. |
SymmetricPassphrase | The password used for symmetric encryption or decryption. |
VersionHeader | The Version header value in the ASCII armored OpenPGP message. |
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. |
ExcludeTags | Specifies tags that will be excluded when calculating MessageText. |
MessageTextEncoding | When set, the MessageHTML and MessageText values 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. |
UseTempFile | Determines if temporary files are used during message creation. |
UseTempFile | If set, the class uses temporary files when generating messages. |
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 class to stop sending the message if the server does not acknowledge any of the BCCs. |
StopOnCcErrors | Instructs the class to stop sending the message if the server does not acknowledge any of the CCs. |
StopOnToErrors | Instructs the class to stop sending the message if the server does not acknowledge any of the TOs. |
TransferText | String representation of RFC822-encoded body of the message. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
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. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
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. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Attachments Property (PHTMLMailer Class)
This property contains paths of the files to attach to the message.
Syntax
IPWorksOpenPGPList<IPWorksOpenPGPFileAttachment>* GetAttachments(); int SetAttachments(IPWorksOpenPGPList<IPWorksOpenPGPFileAttachment>* val);
int ipworksopenpgp_phtmlmailer_getattachmentcount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setattachmentcount(void* lpObj, int iAttachmentCount);
int ipworksopenpgp_phtmlmailer_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int ipworksopenpgp_phtmlmailer_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);
char* ipworksopenpgp_phtmlmailer_getattachmentfilename(void* lpObj, int attachmentindex);
int ipworksopenpgp_phtmlmailer_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFileName);
int ipworksopenpgp_phtmlmailer_setattachmentinputstream(void* lpObj, int attachmentindex, IPWorksOpenPGPStream* sAttachmentInputStream);
char* ipworksopenpgp_phtmlmailer_getattachmentname(void* lpObj, int attachmentindex);
int ipworksopenpgp_phtmlmailer_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);
int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount); QByteArray GetAttachmentData(int iAttachmentIndex);
int SetAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData); QString GetAttachmentFileName(int iAttachmentIndex);
int SetAttachmentFileName(int iAttachmentIndex, QString qsAttachmentFileName); int SetAttachmentInputStream(int iAttachmentIndex, IPWorksOpenPGPStream* sAttachmentInputStream); QString GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, QString qsAttachmentName);
Remarks
This property contains the path of a file on your system to be sent as an attachment with your message. The class will open the file and encode its contents in MIME format.
Example 1: Adding an Attachment
component.AddAttachment("C:\file1.zip");
component.AddAttachment("C:\file2.zip");
component.Send();
Example 3: Using an Attachments Array
component.AttachmentCount = 1;
component.AttachmentName(0) = "name";
component.AttachmentFile(0) = "C:\file.txt";
This property is not available at design time.
Data Type
AuthMechanism Property (PHTMLMailer Class)
This property is used when connecting to the mail server.
Syntax
ANSI (Cross Platform) int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism); Unicode (Windows) INT GetAuthMechanism();
INT SetAuthMechanism(INT iAuthMechanism);
Possible Values
AM_USER_PASSWORD(0),
AM_CRAMMD5(1),
AM_NTLM(2),
AM_APOP(3),
AM_SASLPLAIN(4),
AM_SASLDIGEST_MD5(5),
AM_KERBEROS(6),
AM_XOAUTH2(7)
int ipworksopenpgp_phtmlmailer_getauthmechanism(void* lpObj);
int ipworksopenpgp_phtmlmailer_setauthmechanism(void* lpObj, int iAuthMechanism);
int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);
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 (PHTMLMailer Class)
This property includes a comma-separated list of addresses for blind carbon copies (optional).
Syntax
ANSI (Cross Platform) char* GetBCc();
int SetBCc(const char* lpszBCc); Unicode (Windows) LPWSTR GetBCc();
INT SetBCc(LPCWSTR lpszBCc);
char* ipworksopenpgp_phtmlmailer_getbcc(void* lpObj);
int ipworksopenpgp_phtmlmailer_setbcc(void* lpObj, const char* lpszBCc);
QString GetBCc();
int SetBCc(QString qsBCc);
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination. Because no BCc SMTP header is created containing the destination addresses, individual recipients never see the list of the other recipients.
The class will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in this property.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.
Data Type
String
Cc Property (PHTMLMailer Class)
This property includes a comma-separated list of addresses for carbon copies (optional).
Syntax
ANSI (Cross Platform) char* GetCc();
int SetCc(const char* lpszCc); Unicode (Windows) LPWSTR GetCc();
INT SetCc(LPCWSTR lpszCc);
char* ipworksopenpgp_phtmlmailer_getcc(void* lpObj);
int ipworksopenpgp_phtmlmailer_setcc(void* lpObj, const char* lpszCc);
QString GetCc();
int SetCc(QString qsCc);
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc).
The class will return an error if the MailServer returns an error code about any email address specified in SendTo or Cc but it will fire an Error event only if the same thing happens with an email address specified in BCc.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.
Data Type
String
CompressionMethod Property (PHTMLMailer Class)
The compression algorithm used.
Syntax
ANSI (Cross Platform) char* GetCompressionMethod();
int SetCompressionMethod(const char* lpszCompressionMethod); Unicode (Windows) LPWSTR GetCompressionMethod();
INT SetCompressionMethod(LPCWSTR lpszCompressionMethod);
char* ipworksopenpgp_phtmlmailer_getcompressionmethod(void* lpObj);
int ipworksopenpgp_phtmlmailer_setcompressionmethod(void* lpObj, const char* lpszCompressionMethod);
QString GetCompressionMethod();
int SetCompressionMethod(QString qsCompressionMethod);
Default Value
"zip"
Remarks
This property specifies which compression method is used when generating output. Possible values are:
- zip (default)
- zlib
- bzip2
- none or uncompressed
Data Type
String
Connected Property (PHTMLMailer Class)
This property shows whether the class is connected.
Syntax
ANSI (Cross Platform) int GetConnected(); Unicode (Windows) BOOL GetConnected();
int ipworksopenpgp_phtmlmailer_getconnected(void* lpObj);
bool GetConnected();
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Data Type
Boolean
DeliveryNotificationTo Property (PHTMLMailer Class)
This property includes the email address to which to send a delivery notification.
Syntax
ANSI (Cross Platform) char* GetDeliveryNotificationTo();
int SetDeliveryNotificationTo(const char* lpszDeliveryNotificationTo); Unicode (Windows) LPWSTR GetDeliveryNotificationTo();
INT SetDeliveryNotificationTo(LPCWSTR lpszDeliveryNotificationTo);
char* ipworksopenpgp_phtmlmailer_getdeliverynotificationto(void* lpObj);
int ipworksopenpgp_phtmlmailer_setdeliverynotificationto(void* lpObj, const char* lpszDeliveryNotificationTo);
QString GetDeliveryNotificationTo();
int SetDeliveryNotificationTo(QString qsDeliveryNotificationTo);
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
EncryptingAlgorithm Property (PHTMLMailer Class)
The encryption algorithm used when encrypting.
Syntax
ANSI (Cross Platform) char* GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(const char* lpszEncryptingAlgorithm); Unicode (Windows) LPWSTR GetEncryptingAlgorithm();
INT SetEncryptingAlgorithm(LPCWSTR lpszEncryptingAlgorithm);
char* ipworksopenpgp_phtmlmailer_getencryptingalgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_setencryptingalgorithm(void* lpObj, const char* lpszEncryptingAlgorithm);
QString GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(QString qsEncryptingAlgorithm);
Default Value
"AES128"
Remarks
This property specifies the encryption algorithm used when encrypting. Possible values are:
- CAST5
- 3DES or TripleDES
- AES256
- AES192
- AES128 (default)
- BLOWFISH
- TWOFISH
- IDEA
- AES256-OCB (AEAD)
- AES192-OCB (AEAD)
- AES128-OCB (AEAD)
- AES256-GCM (AEAD)
- AES192-GCM (AEAD)
- AES128-GCM (AEAD)
Note that if UseArgon2 is enabled, and SymmetricPassphrase is specified, an AEAD encryption algorithm (AES*-OCB and AES*-GCM) must be specified for symmetric encryption. If UseArgon2 is disabled, and an AEAD encryption algorithm is specified, the AEAD mode (OCB or GCM) will be ignored when performing symmetric encryption.
An AEAD encryption algorithm may optionally be utilized when encrypting messages (when calling Encrypt). In this case, the AEADChunkSizeExp configuration will specify the chunk size for splitting plaintext for encryption. Please see AEADChunkSizeExp for additional details.
Data Type
String
Firewall Property (PHTMLMailer Class)
A set of properties related to firewall access.
Syntax
IPWorksOpenPGPFirewall* GetFirewall(); int SetFirewall(IPWorksOpenPGPFirewall* val);
int ipworksopenpgp_phtmlmailer_getfirewallautodetect(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int ipworksopenpgp_phtmlmailer_getfirewalltype(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewalltype(void* lpObj, int iFirewallType);
char* ipworksopenpgp_phtmlmailer_getfirewallhost(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* ipworksopenpgp_phtmlmailer_getfirewallpassword(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int ipworksopenpgp_phtmlmailer_getfirewallport(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallport(void* lpObj, int iFirewallPort);
char* ipworksopenpgp_phtmlmailer_getfirewalluser(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect); int GetFirewallType();
int SetFirewallType(int iFirewallType); QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost); QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword); int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Data Type
From Property (PHTMLMailer Class)
This property includes the email address of the sender (required).
Syntax
ANSI (Cross Platform) char* GetFrom();
int SetFrom(const char* lpszFrom); Unicode (Windows) LPWSTR GetFrom();
INT SetFrom(LPCWSTR lpszFrom);
char* ipworksopenpgp_phtmlmailer_getfrom(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfrom(void* lpObj, const char* lpszFrom);
QString GetFrom();
int SetFrom(QString qsFrom);
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
HTMLFile Property (PHTMLMailer Class)
This property includes the path to a local HTML file.
Syntax
ANSI (Cross Platform) char* GetHTMLFile();
int SetHTMLFile(const char* lpszHTMLFile); Unicode (Windows) LPWSTR GetHTMLFile();
INT SetHTMLFile(LPCWSTR lpszHTMLFile);
char* ipworksopenpgp_phtmlmailer_gethtmlfile(void* lpObj);
int ipworksopenpgp_phtmlmailer_sethtmlfile(void* lpObj, const char* lpszHTMLFile);
QString GetHTMLFile();
int SetHTMLFile(QString qsHTMLFile);
Default Value
""
Remarks
This property may contain the path to the local HTML file. If this property is not empty, the contents of the file with that name will be appended to the text in MessageHTML.
Note: This means that if MessageHTML is empty, HTMLFile is what will be sent to the server.
This property is not available at design time.
Data Type
String
Idle Property (PHTMLMailer Class)
This property specifies the current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int ipworksopenpgp_phtmlmailer_getidle(void* lpObj);
bool GetIdle();
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
Images Property (PHTMLMailer Class)
This property includes the embedded images in the HTML message.
Syntax
IPWorksOpenPGPList<IPWorksOpenPGPHTMLImage>* GetImages(); int SetImages(IPWorksOpenPGPList<IPWorksOpenPGPHTMLImage>* val);
int ipworksopenpgp_phtmlmailer_getimagecount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setimagecount(void* lpObj, int iImageCount);
int ipworksopenpgp_phtmlmailer_getimagedata(void* lpObj, int imageindex, char** lpImageData, int* lenImageData);
int ipworksopenpgp_phtmlmailer_setimagedata(void* lpObj, int imageindex, const char* lpImageData, int lenImageData);
char* ipworksopenpgp_phtmlmailer_getimagefile(void* lpObj, int imageindex);
int ipworksopenpgp_phtmlmailer_setimagefile(void* lpObj, int imageindex, const char* lpszImageFile);
char* ipworksopenpgp_phtmlmailer_getimageid(void* lpObj, int imageindex);
int ipworksopenpgp_phtmlmailer_setimageid(void* lpObj, int imageindex, const char* lpszImageId);
char* ipworksopenpgp_phtmlmailer_getimagetype(void* lpObj, int imageindex);
int ipworksopenpgp_phtmlmailer_setimagetype(void* lpObj, int imageindex, const char* lpszImageType);
int GetImageCount();
int SetImageCount(int iImageCount); QByteArray GetImageData(int iImageIndex);
int SetImageData(int iImageIndex, QByteArray qbaImageData); QString GetImageFile(int iImageIndex);
int SetImageFile(int iImageIndex, QString qsImageFile); QString GetImageId(int iImageIndex);
int SetImageId(int iImageIndex, QString qsImageId); QString GetImageType(int iImageIndex);
int SetImageType(int iImageIndex, QString qsImageType);
Remarks
This property contains the names of the image files embedded into the HTML message. The collection is updated every time MessageHTML is set. You may change the file names before sending (e.g., if they don't point to valid files).
Data Type
Importance Property (PHTMLMailer Class)
This property indicates the importance of the mail message (optional).
Syntax
ANSI (Cross Platform) int GetImportance();
int SetImportance(int iImportance); Unicode (Windows) INT GetImportance();
INT SetImportance(INT iImportance);
Possible Values
MI_UNSPECIFIED(0),
MI_HIGH(1),
MI_NORMAL(2),
MI_LOW(3)
int ipworksopenpgp_phtmlmailer_getimportance(void* lpObj);
int ipworksopenpgp_phtmlmailer_setimportance(void* lpObj, int iImportance);
int GetImportance();
int SetImportance(int iImportance);
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
Keys Property (PHTMLMailer Class)
A collection of keys used for cryptographic operations.
Syntax
IPWorksOpenPGPList<IPWorksOpenPGPKey>* GetKeys(); int SetKeys(IPWorksOpenPGPList<IPWorksOpenPGPKey>* val);
int ipworksopenpgp_phtmlmailer_getkeycount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setkeycount(void* lpObj, int iKeyCount);
int ipworksopenpgp_phtmlmailer_getkeyencoded(void* lpObj, int keyindex, char** lpKeyEncoded, int* lenKeyEncoded);
int ipworksopenpgp_phtmlmailer_setkeyencoded(void* lpObj, int keyindex, const char* lpKeyEncoded, int lenKeyEncoded);
char* ipworksopenpgp_phtmlmailer_getkeykeyring(void* lpObj, int keyindex);
int ipworksopenpgp_phtmlmailer_setkeykeyring(void* lpObj, int keyindex, const char* lpszKeyKeyring);
char* ipworksopenpgp_phtmlmailer_getkeypassphrase(void* lpObj, int keyindex);
int ipworksopenpgp_phtmlmailer_setkeypassphrase(void* lpObj, int keyindex, const char* lpszKeyPassphrase);
char* ipworksopenpgp_phtmlmailer_getkeyuserid(void* lpObj, int keyindex);
int ipworksopenpgp_phtmlmailer_setkeyuserid(void* lpObj, int keyindex, const char* lpszKeyUserId);
int GetKeyCount();
int SetKeyCount(int iKeyCount); QByteArray GetKeyEncoded(int iKeyIndex);
int SetKeyEncoded(int iKeyIndex, QByteArray qbaKeyEncoded); QString GetKeyKeyring(int iKeyIndex);
int SetKeyKeyring(int iKeyIndex, QString qsKeyKeyring); QString GetKeyPassphrase(int iKeyIndex);
int SetKeyPassphrase(int iKeyIndex, QString qsKeyPassphrase); QString GetKeyUserId(int iKeyIndex);
int SetKeyUserId(int iKeyIndex, QString qsKeyUserId);
Remarks
This collection holds keys that are used for signing and decrypting. In most cases only one key will be specified, however multiple keys may be needed in some cases.
This property is not available at design time.
Data Type
LastReply Property (PHTMLMailer Class)
This property indicates the last reply received from the server.
Syntax
ANSI (Cross Platform) char* GetLastReply(); Unicode (Windows) LPWSTR GetLastReply();
char* ipworksopenpgp_phtmlmailer_getlastreply(void* lpObj);
QString GetLastReply();
Default Value
""
Remarks
This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.
This property is read-only.
Data Type
String
LocalHost Property (PHTMLMailer Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksopenpgp_phtmlmailer_getlocalhost(void* lpObj);
int ipworksopenpgp_phtmlmailer_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MailPort Property (PHTMLMailer Class)
This property includes the server port for SMTP (default 25).
Syntax
ANSI (Cross Platform) int GetMailPort();
int SetMailPort(int iMailPort); Unicode (Windows) INT GetMailPort();
INT SetMailPort(INT iMailPort);
int ipworksopenpgp_phtmlmailer_getmailport(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmailport(void* lpObj, int iMailPort);
int GetMailPort();
int SetMailPort(int iMailPort);
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 (PHTMLMailer Class)
This property includes the name or address of a mail server (mail relay).
Syntax
ANSI (Cross Platform) char* GetMailServer();
int SetMailServer(const char* lpszMailServer); Unicode (Windows) LPWSTR GetMailServer();
INT SetMailServer(LPCWSTR lpszMailServer);
char* ipworksopenpgp_phtmlmailer_getmailserver(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmailserver(void* lpObj, const char* lpszMailServer);
QString GetMailServer();
int SetMailServer(QString qsMailServer);
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or domain name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.
The current version of the class does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (e.g., a UNIX host), but it is preferable to select a MailServer that is close to the machine sending mail.
If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
Data Type
String
MessageDate Property (PHTMLMailer Class)
This property includes the date of the mail message (optional).
Syntax
ANSI (Cross Platform) char* GetMessageDate();
int SetMessageDate(const char* lpszMessageDate); Unicode (Windows) LPWSTR GetMessageDate();
INT SetMessageDate(LPCWSTR lpszMessageDate);
char* ipworksopenpgp_phtmlmailer_getmessagedate(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmessagedate(void* lpObj, const char* lpszMessageDate);
QString GetMessageDate();
int SetMessageDate(QString qsMessageDate);
Default Value
"*"
Remarks
If this property contains a nonempty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.
Special case: If this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders is computed and the message is sent. This is the default behavior of the class
RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".
This property is not available at design time.
Data Type
String
MessageHTML Property (PHTMLMailer Class)
This property includes the HTML version of the message.
Syntax
ANSI (Cross Platform) char* GetMessageHTML();
int SetMessageHTML(const char* lpszMessageHTML); Unicode (Windows) LPWSTR GetMessageHTML();
INT SetMessageHTML(LPCWSTR lpszMessageHTML);
char* ipworksopenpgp_phtmlmailer_getmessagehtml(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmessagehtml(void* lpObj, const char* lpszMessageHTML);
QString GetMessageHTML();
int SetMessageHTML(QString qsMessageHTML);
Default Value
""
Remarks
This property contains the HTML version of the message.
When this property is set, the class automatically computes a plaintext version of the text and puts it into MessageText. You may choose to override this default text with your own version.
Example. Setting MessageHTML:
component.MessageHTML = "<b>Hello</b>, my name is <i>Tom</i>";
Data Type
String
MessageId Property (PHTMLMailer Class)
This property includes the message identifier for the message.
Syntax
ANSI (Cross Platform) char* GetMessageId();
int SetMessageId(const char* lpszMessageId); Unicode (Windows) LPWSTR GetMessageId();
INT SetMessageId(LPCWSTR lpszMessageId);
char* ipworksopenpgp_phtmlmailer_getmessageid(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmessageid(void* lpObj, const char* lpszMessageId);
QString GetMessageId();
int SetMessageId(QString qsMessageId);
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
MessageRecipients Property (PHTMLMailer Class)
This property includes the collection of recipients of the message.
Syntax
IPWorksOpenPGPList<IPWorksOpenPGPMessageRecipient>* GetMessageRecipients(); int SetMessageRecipients(IPWorksOpenPGPList<IPWorksOpenPGPMessageRecipient>* val);
int ipworksopenpgp_phtmlmailer_getmessagerecipientcount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmessagerecipientcount(void* lpObj, int iMessageRecipientCount);
char* ipworksopenpgp_phtmlmailer_getmessagerecipientaddress(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipientaddress(void* lpObj, int recipientindex, const char* lpszMessageRecipientAddress);
char* ipworksopenpgp_phtmlmailer_getmessagerecipientname(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipientname(void* lpObj, int recipientindex, const char* lpszMessageRecipientName);
char* ipworksopenpgp_phtmlmailer_getmessagerecipientoptions(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipientoptions(void* lpObj, int recipientindex, const char* lpszMessageRecipientOptions);
int ipworksopenpgp_phtmlmailer_getmessagerecipienttype(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipienttype(void* lpObj, int recipientindex, int iMessageRecipientType);
int GetMessageRecipientCount();
int SetMessageRecipientCount(int iMessageRecipientCount); QString GetMessageRecipientAddress(int iRecipientIndex);
int SetMessageRecipientAddress(int iRecipientIndex, QString qsMessageRecipientAddress); QString GetMessageRecipientName(int iRecipientIndex);
int SetMessageRecipientName(int iRecipientIndex, QString qsMessageRecipientName); QString GetMessageRecipientOptions(int iRecipientIndex);
int SetMessageRecipientOptions(int iRecipientIndex, QString qsMessageRecipientOptions); int GetMessageRecipientType(int iRecipientIndex);
int SetMessageRecipientType(int iRecipientIndex, int iMessageRecipientType);
Remarks
This property contains a collection that describes to whom the message is being sent. You may include all recipients in this property, even Cc's and BCc's, which are specified by the type field.
Data Type
IPWorksOpenPGPMessageRecipient
MessageText Property (PHTMLMailer Class)
This property includes the plaintext version of the message.
Syntax
ANSI (Cross Platform) char* GetMessageText();
int SetMessageText(const char* lpszMessageText); Unicode (Windows) LPWSTR GetMessageText();
INT SetMessageText(LPCWSTR lpszMessageText);
char* ipworksopenpgp_phtmlmailer_getmessagetext(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmessagetext(void* lpObj, const char* lpszMessageText);
QString GetMessageText();
int SetMessageText(QString qsMessageText);
Default Value
""
Remarks
This property is a plaintext version of the HTML message. This is necessary for recipients with legacy mail readers that do not support HTML.
The MessageHTML property contains the HTML version of the message. When MessageHTML is set, the class automatically computes a plaintext version of the text and puts it into this property. You may choose to override this default text with your own version.
Data Type
String
OtherHeaders Property (PHTMLMailer Class)
This property includes an RFC 822-compliant string consisting of extra headers.
Syntax
ANSI (Cross Platform) char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
char* ipworksopenpgp_phtmlmailer_getotherheaders(void* lpObj);
int ipworksopenpgp_phtmlmailer_setotherheaders(void* lpObj, const char* lpszOtherHeaders);
QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);
Default Value
""
Remarks
This property contains a string of headers to be appended to the message headers created from other properties like SendTo, Subject, and so on.
The headers must be of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, message delivery might not be successful.
This property is useful for extending the functionality of the class. A good example is delivery of MIME-encoded messages.
Special case: If this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.
Example. Sending an Email with an Additional Header:
component.MailServer = "MyServer";
component.From = "me@server.com";
component.SendTo = "recipient@server.com";
component.Subject = "My Subject";
component.MessageText = "This is the message body.";
component.OtherHeaders = "HeaderName: HeaderValue";
component.Send();
This property is not available at design time.
Data Type
String
ParseHTML Property (PHTMLMailer Class)
This property controls the behavior of the MessageHTML property.
Syntax
ANSI (Cross Platform) int GetParseHTML();
int SetParseHTML(int bParseHTML); Unicode (Windows) BOOL GetParseHTML();
INT SetParseHTML(BOOL bParseHTML);
int ipworksopenpgp_phtmlmailer_getparsehtml(void* lpObj);
int ipworksopenpgp_phtmlmailer_setparsehtml(void* lpObj, int bParseHTML);
bool GetParseHTML();
int SetParseHTML(bool bParseHTML);
Default Value
TRUE
Remarks
This property controls the behavior of the MessageHTML property. If ParseHTML is set to False, you must provide valid values in MessageHTML, MessageText, and Images.
Data Type
Boolean
Password Property (PHTMLMailer Class)
This property includes a password for logon to the MailServer .
Syntax
ANSI (Cross Platform) char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* ipworksopenpgp_phtmlmailer_getpassword(void* lpObj);
int ipworksopenpgp_phtmlmailer_setpassword(void* lpObj, const char* lpszPassword);
QString GetPassword();
int SetPassword(QString qsPassword);
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 (PHTMLMailer Class)
This property includes the priority of the mail message (optional).
Syntax
ANSI (Cross Platform) int GetPriority();
int SetPriority(int iPriority); Unicode (Windows) INT GetPriority();
INT SetPriority(INT iPriority);
Possible Values
EP_UNSPECIFIED(0),
EP_NORMAL(1),
EP_URGENT(2),
EP_NON_URGENT(3)
int ipworksopenpgp_phtmlmailer_getpriority(void* lpObj);
int ipworksopenpgp_phtmlmailer_setpriority(void* lpObj, int iPriority);
int GetPriority();
int SetPriority(int iPriority);
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 (PHTMLMailer Class)
This property includes the email address to send a read-receipt to.
Syntax
ANSI (Cross Platform) char* GetReadReceiptTo();
int SetReadReceiptTo(const char* lpszReadReceiptTo); Unicode (Windows) LPWSTR GetReadReceiptTo();
INT SetReadReceiptTo(LPCWSTR lpszReadReceiptTo);
char* ipworksopenpgp_phtmlmailer_getreadreceiptto(void* lpObj);
int ipworksopenpgp_phtmlmailer_setreadreceiptto(void* lpObj, const char* lpszReadReceiptTo);
QString GetReadReceiptTo();
int SetReadReceiptTo(QString qsReadReceiptTo);
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
RecipientKeys Property (PHTMLMailer Class)
The collection of keys belonging to the recipient of the message.
Syntax
IPWorksOpenPGPList<IPWorksOpenPGPKey>* GetRecipientKeys(); int SetRecipientKeys(IPWorksOpenPGPList<IPWorksOpenPGPKey>* val);
int ipworksopenpgp_phtmlmailer_getrecipientkeycount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setrecipientkeycount(void* lpObj, int iRecipientKeyCount);
int ipworksopenpgp_phtmlmailer_getrecipientkeyencoded(void* lpObj, int recipientkeyindex, char** lpRecipientKeyEncoded, int* lenRecipientKeyEncoded);
int ipworksopenpgp_phtmlmailer_setrecipientkeyencoded(void* lpObj, int recipientkeyindex, const char* lpRecipientKeyEncoded, int lenRecipientKeyEncoded);
char* ipworksopenpgp_phtmlmailer_getrecipientkeykeyring(void* lpObj, int recipientkeyindex);
int ipworksopenpgp_phtmlmailer_setrecipientkeykeyring(void* lpObj, int recipientkeyindex, const char* lpszRecipientKeyKeyring);
char* ipworksopenpgp_phtmlmailer_getrecipientkeyuserid(void* lpObj, int recipientkeyindex);
int ipworksopenpgp_phtmlmailer_setrecipientkeyuserid(void* lpObj, int recipientkeyindex, const char* lpszRecipientKeyUserId);
int GetRecipientKeyCount();
int SetRecipientKeyCount(int iRecipientKeyCount); QByteArray GetRecipientKeyEncoded(int iRecipientKeyIndex);
int SetRecipientKeyEncoded(int iRecipientKeyIndex, QByteArray qbaRecipientKeyEncoded); QString GetRecipientKeyKeyring(int iRecipientKeyIndex);
int SetRecipientKeyKeyring(int iRecipientKeyIndex, QString qsRecipientKeyKeyring); QString GetRecipientKeyUserId(int iRecipientKeyIndex);
int SetRecipientKeyUserId(int iRecipientKeyIndex, QString qsRecipientKeyUserId);
Remarks
This property contains the keys of the message recipient.
Set this property before calling Encrypt or SignAndEncrypt.
This property is not available at design time.
Data Type
ReplyTo Property (PHTMLMailer Class)
This property includes a mail address to which to reply (optional).
Syntax
ANSI (Cross Platform) char* GetReplyTo();
int SetReplyTo(const char* lpszReplyTo); Unicode (Windows) LPWSTR GetReplyTo();
INT SetReplyTo(LPCWSTR lpszReplyTo);
char* ipworksopenpgp_phtmlmailer_getreplyto(void* lpObj);
int ipworksopenpgp_phtmlmailer_setreplyto(void* lpObj, const char* lpszReplyTo);
QString GetReplyTo();
int SetReplyTo(QString qsReplyTo);
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 (PHTMLMailer Class)
This property includes a comma-separated list of addresses for destinations (required).
Syntax
ANSI (Cross Platform) char* GetSendTo();
int SetSendTo(const char* lpszSendTo); Unicode (Windows) LPWSTR GetSendTo();
INT SetSendTo(LPCWSTR lpszSendTo);
char* ipworksopenpgp_phtmlmailer_getsendto(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsendto(void* lpObj, const char* lpszSendTo);
QString GetSendTo();
int SetSendTo(QString qsSendTo);
Default Value
""
Remarks
This property specifies a comma-separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.
Examples of valid addresses are as follows: "Friendly Name" <address@company.com> or address@company.com
The class will fail if the MailServer returns an error code about any email address specified in SendTo or Cc but it will silently ignore the error if the same thing happens with an email address specified in BCc.
If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 822 specifications.
Note: You must clear the MessageRecipients properties before setting this property to remove previous recipients.
Data Type
String
Sensitivity Property (PHTMLMailer Class)
This property indicates the sensitivity of the mail message (optional).
Syntax
ANSI (Cross Platform) int GetSensitivity();
int SetSensitivity(int iSensitivity); Unicode (Windows) INT GetSensitivity();
INT SetSensitivity(INT iSensitivity);
Possible Values
ES_UNSPECIFIED(0),
ES_PERSONAL(1),
ES_PRIVATE(2),
ES_COMPANY_CONFIDENTIAL(3)
int ipworksopenpgp_phtmlmailer_getsensitivity(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsensitivity(void* lpObj, int iSensitivity);
int GetSensitivity();
int SetSensitivity(int iSensitivity);
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
SigningAlgorithm Property (PHTMLMailer Class)
The signature hash algorithm used when signing.
Syntax
ANSI (Cross Platform) char* GetSigningAlgorithm();
int SetSigningAlgorithm(const char* lpszSigningAlgorithm); Unicode (Windows) LPWSTR GetSigningAlgorithm();
INT SetSigningAlgorithm(LPCWSTR lpszSigningAlgorithm);
char* ipworksopenpgp_phtmlmailer_getsigningalgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsigningalgorithm(void* lpObj, const char* lpszSigningAlgorithm);
QString GetSigningAlgorithm();
int SetSigningAlgorithm(QString qsSigningAlgorithm);
Default Value
"SHA256"
Remarks
This property specifies the signature hash algorithm used when signing. Possible values are:
- SHA1
- MD5
- SHA256 (default)
- SHA384
- SHA512
- SHA224
- RIPEMD160
- SHA3-256
- SHA3-512
Data Type
String
SSLAcceptServerCert Property (PHTMLMailer Class)
This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
IPWorksOpenPGPCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(IPWorksOpenPGPCertificate* val);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercerteffectivedate(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertexpirationdate(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertextendedkeyusage(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertfingerprint(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertfingerprintsha1(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertfingerprintsha256(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertissuer(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertprivatekey(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertpublickey(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslacceptservercertpublickeylength(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertserialnumber(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertsignaturealgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksopenpgp_phtmlmailer_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertstorepassword(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int ipworksopenpgp_phtmlmailer_getsslacceptservercertstoretype(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertsubjectaltnames(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertthumbprintmd5(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertthumbprintsha1(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertthumbprintsha256(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertusage(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslacceptservercertusageflags(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertversion(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslacceptservercertsubject(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int ipworksopenpgp_phtmlmailer_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksopenpgp_phtmlmailer_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString GetSSLAcceptServerCertEffectiveDate(); QString GetSSLAcceptServerCertExpirationDate(); QString GetSSLAcceptServerCertExtendedKeyUsage(); QString GetSSLAcceptServerCertFingerprint(); QString GetSSLAcceptServerCertFingerprintSHA1(); QString GetSSLAcceptServerCertFingerprintSHA256(); QString GetSSLAcceptServerCertIssuer(); QString GetSSLAcceptServerCertPrivateKey(); bool GetSSLAcceptServerCertPrivateKeyAvailable(); QString GetSSLAcceptServerCertPrivateKeyContainer(); QString GetSSLAcceptServerCertPublicKey(); QString GetSSLAcceptServerCertPublicKeyAlgorithm(); int GetSSLAcceptServerCertPublicKeyLength(); QString GetSSLAcceptServerCertSerialNumber(); QString GetSSLAcceptServerCertSignatureAlgorithm(); QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString GetSSLAcceptServerCertSubjectAltNames(); QString GetSSLAcceptServerCertThumbprintMD5(); QString GetSSLAcceptServerCertThumbprintSHA1(); QString GetSSLAcceptServerCertThumbprintSHA256(); QString GetSSLAcceptServerCertUsage(); int GetSSLAcceptServerCertUsageFlags(); QString GetSSLAcceptServerCertVersion(); QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Data Type
SSLCert Property (PHTMLMailer Class)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
IPWorksOpenPGPCertificate* GetSSLCert(); int SetSSLCert(IPWorksOpenPGPCertificate* val);
char* ipworksopenpgp_phtmlmailer_getsslcerteffectivedate(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertexpirationdate(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertextendedkeyusage(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertfingerprint(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertfingerprintsha1(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertfingerprintsha256(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertissuer(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertprivatekey(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslcertprivatekeyavailable(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertprivatekeycontainer(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertpublickey(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertpublickeyalgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslcertpublickeylength(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertserialnumber(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertsignaturealgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksopenpgp_phtmlmailer_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* ipworksopenpgp_phtmlmailer_getsslcertstorepassword(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int ipworksopenpgp_phtmlmailer_getsslcertstoretype(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* ipworksopenpgp_phtmlmailer_getsslcertsubjectaltnames(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertthumbprintmd5(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertthumbprintsha1(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertthumbprintsha256(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertusage(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslcertusageflags(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertversion(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslcertsubject(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int ipworksopenpgp_phtmlmailer_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksopenpgp_phtmlmailer_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString GetSSLCertEffectiveDate(); QString GetSSLCertExpirationDate(); QString GetSSLCertExtendedKeyUsage(); QString GetSSLCertFingerprint(); QString GetSSLCertFingerprintSHA1(); QString GetSSLCertFingerprintSHA256(); QString GetSSLCertIssuer(); QString GetSSLCertPrivateKey(); bool GetSSLCertPrivateKeyAvailable(); QString GetSSLCertPrivateKeyContainer(); QString GetSSLCertPublicKey(); QString GetSSLCertPublicKeyAlgorithm(); int GetSSLCertPublicKeyLength(); QString GetSSLCertSerialNumber(); QString GetSSLCertSignatureAlgorithm(); QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore); QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword); int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); QString GetSSLCertSubjectAltNames(); QString GetSSLCertThumbprintMD5(); QString GetSSLCertThumbprintSHA1(); QString GetSSLCertThumbprintSHA256(); QString GetSSLCertUsage(); int GetSSLCertUsageFlags(); QString GetSSLCertVersion(); QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject); QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Data Type
SSLEnabled Property (PHTMLMailer Class)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
ANSI (Cross Platform) int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled); Unicode (Windows) BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);
int ipworksopenpgp_phtmlmailer_getsslenabled(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslenabled(void* lpObj, int bSSLEnabled);
bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);
Default Value
FALSE
Remarks
This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
Data Type
Boolean
SSLProvider Property (PHTMLMailer Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworksopenpgp_phtmlmailer_getsslprovider(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCert Property (PHTMLMailer Class)
This property includes the server certificate for the last established connection.
Syntax
IPWorksOpenPGPCertificate* GetSSLServerCert();
char* ipworksopenpgp_phtmlmailer_getsslservercerteffectivedate(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertexpirationdate(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertextendedkeyusage(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertfingerprint(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertfingerprintsha1(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertfingerprintsha256(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertissuer(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertprivatekey(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslservercertprivatekeyavailable(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertprivatekeycontainer(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertpublickey(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertpublickeyalgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslservercertpublickeylength(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertserialnumber(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertsignaturealgorithm(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* ipworksopenpgp_phtmlmailer_getsslservercertstorepassword(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslservercertstoretype(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertsubjectaltnames(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertthumbprintmd5(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertthumbprintsha1(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertthumbprintsha256(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertusage(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslservercertusageflags(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertversion(void* lpObj);
char* ipworksopenpgp_phtmlmailer_getsslservercertsubject(void* lpObj);
int ipworksopenpgp_phtmlmailer_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString GetSSLServerCertEffectiveDate(); QString GetSSLServerCertExpirationDate(); QString GetSSLServerCertExtendedKeyUsage(); QString GetSSLServerCertFingerprint(); QString GetSSLServerCertFingerprintSHA1(); QString GetSSLServerCertFingerprintSHA256(); QString GetSSLServerCertIssuer(); QString GetSSLServerCertPrivateKey(); bool GetSSLServerCertPrivateKeyAvailable(); QString GetSSLServerCertPrivateKeyContainer(); QString GetSSLServerCertPublicKey(); QString GetSSLServerCertPublicKeyAlgorithm(); int GetSSLServerCertPublicKeyLength(); QString GetSSLServerCertSerialNumber(); QString GetSSLServerCertSignatureAlgorithm(); QByteArray GetSSLServerCertStore(); QString GetSSLServerCertStorePassword(); int GetSSLServerCertStoreType(); QString GetSSLServerCertSubjectAltNames(); QString GetSSLServerCertThumbprintMD5(); QString GetSSLServerCertThumbprintSHA1(); QString GetSSLServerCertThumbprintSHA256(); QString GetSSLServerCertUsage(); int GetSSLServerCertUsageFlags(); QString GetSSLServerCertVersion(); QString GetSSLServerCertSubject(); QByteArray GetSSLServerCertEncoded();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Data Type
SSLStartMode Property (PHTMLMailer Class)
This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.
Syntax
ANSI (Cross Platform) int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode); Unicode (Windows) INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);
Possible Values
SSL_AUTOMATIC(0),
SSL_IMPLICIT(1),
SSL_EXPLICIT(2),
SSL_NONE(3)
int ipworksopenpgp_phtmlmailer_getsslstartmode(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslstartmode(void* lpObj, int iSSLStartMode);
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);
Default Value
3
Remarks
The SSLStartMode property may have one of the following values:
0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
2 (sslExplicit) | The class will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. |
3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. |
Data Type
Integer
Subject Property (PHTMLMailer Class)
This property includes the subject of the mail message (optional).
Syntax
ANSI (Cross Platform) char* GetSubject();
int SetSubject(const char* lpszSubject); Unicode (Windows) LPWSTR GetSubject();
INT SetSubject(LPCWSTR lpszSubject);
char* ipworksopenpgp_phtmlmailer_getsubject(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsubject(void* lpObj, const char* lpszSubject);
QString GetSubject();
int SetSubject(QString qsSubject);
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 (PHTMLMailer Class)
This property includes the timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworksopenpgp_phtmlmailer_gettimeout(void* lpObj);
int ipworksopenpgp_phtmlmailer_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class 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 (PHTMLMailer Class)
This property includes the user identifier needed to log in as in the MailServer .
Syntax
ANSI (Cross Platform) char* GetUser();
int SetUser(const char* lpszUser); Unicode (Windows) LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);
char* ipworksopenpgp_phtmlmailer_getuser(void* lpObj);
int ipworksopenpgp_phtmlmailer_setuser(void* lpObj, const char* lpszUser);
QString GetUser();
int SetUser(QString qsUser);
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 (PHTMLMailer Class)
This adds FileName as an attachment.
Syntax
ANSI (Cross Platform) int AddAttachment(const char* lpszFileName); Unicode (Windows) INT AddAttachment(LPCWSTR lpszFileName);
int ipworksopenpgp_phtmlmailer_addattachment(void* lpObj, const char* lpszFileName);
int AddAttachment(const QString& qsFileName);
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";
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (PHTMLMailer Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksopenpgp_phtmlmailer_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Connect Method (PHTMLMailer Class)
This method connects to the mail relay and sends the SMTP HELO command.
Syntax
ANSI (Cross Platform) int Connect(); Unicode (Windows) INT Connect();
int ipworksopenpgp_phtmlmailer_connect(void* lpObj);
int 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()
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Disconnect Method (PHTMLMailer Class)
This method disconnects from the SMTP server.
Syntax
ANSI (Cross Platform) int Disconnect(); Unicode (Windows) INT Disconnect();
int ipworksopenpgp_phtmlmailer_disconnect(void* lpObj);
int Disconnect();
Remarks
This method disconnects from the mail relay.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (PHTMLMailer Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksopenpgp_phtmlmailer_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Encrypt Method (PHTMLMailer Class)
Encrypts the message.
Syntax
ANSI (Cross Platform) int Encrypt(); Unicode (Windows) INT Encrypt();
int ipworksopenpgp_phtmlmailer_encrypt(void* lpObj);
int Encrypt();
Remarks
This method encrypts the specified message.
The message is encrypted with the public keys specified in RecipientKeys.
When encrypting, the following properties may be used to further configure the class:
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Interrupt Method (PHTMLMailer Class)
This method interrupts the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int ipworksopenpgp_phtmlmailer_interrupt(void* lpObj);
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ProcessQueue Method (PHTMLMailer Class)
This method sends the messages that previously have been queued into QueueDir .
Syntax
ANSI (Cross Platform) int ProcessQueue(const char* lpszQueueDir); Unicode (Windows) INT ProcessQueue(LPCWSTR lpszQueueDir);
int ipworksopenpgp_phtmlmailer_processqueue(void* lpObj, const char* lpszQueueDir);
int ProcessQueue(const QString& qsQueueDir);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Queue Method (PHTMLMailer Class)
This method queues the message into QueueDir .
Syntax
ANSI (Cross Platform) char* Queue(const char* lpszQueueDir); Unicode (Windows) LPWSTR Queue(LPCWSTR lpszQueueDir);
char* ipworksopenpgp_phtmlmailer_queue(void* lpObj, const char* lpszQueueDir);
QString Queue(const QString& qsQueueDir);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ResetHeaders Method (PHTMLMailer Class)
This method resets all the message headers to empty.
Syntax
ANSI (Cross Platform) int ResetHeaders(); Unicode (Windows) INT ResetHeaders();
int ipworksopenpgp_phtmlmailer_resetheaders(void* lpObj);
int 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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Send Method (PHTMLMailer Class)
This method sends the current message and MIME-encoded attachment.
Syntax
ANSI (Cross Platform) int Send(); Unicode (Windows) INT Send();
int ipworksopenpgp_phtmlmailer_send(void* lpObj);
int Send();
Remarks
This method sends the current message and MIME-encoded attachment. If the class is not connected to the mail relay, a connection is created, the message is sent, and then the connection is closed unless an error occurs.
If the class is already connected (by use of the Connect method), the connection will remain open after the message is sent. To disconnect, call the Disconnect method.
Example. Send an HTML Email:
HTMLMailerControl.MailServer = "myserver"
HTMLMailerControl.SendTo = "recipient@myserver.com"
HTMLMailerControl.From = "me@myserver.com"
HTMLMailerControl.Subject = "My Subject"
HTMLMailerControl.MessageHTML = "<b>Hello</b>, my name is <i>Tom</i>"
HTMLMailerControl.Send
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendCommand Method (PHTMLMailer Class)
This method sends the exact command directly to the server.
Syntax
ANSI (Cross Platform) int SendCommand(const char* lpszCommand); Unicode (Windows) INT SendCommand(LPCWSTR lpszCommand);
int ipworksopenpgp_phtmlmailer_sendcommand(void* lpObj, const char* lpszCommand);
int SendCommand(const QString& qsCommand);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetMessageHTMLStream Method (PHTMLMailer Class)
This method sets the stream from which the class will read the HTML version of the message.
Syntax
ANSI (Cross Platform) int SetMessageHTMLStream(IPWorksOpenPGPStream* sMessageStream); Unicode (Windows) INT SetMessageHTMLStream(IPWorksOpenPGPStream* sMessageStream);
int ipworksopenpgp_phtmlmailer_setmessagehtmlstream(void* lpObj, IPWorksOpenPGPStream* sMessageStream);
int SetMessageHTMLStream(IPWorksOpenPGPStream* sMessageStream);
Remarks
This method sets the stream from which the class will read the HTML version of the message. Once set, the class reads the content of the stream and populates the MessageHTML property with the HTML version of the message. The corresponding plaintext version is provided in the MessageText property.
When this property is called, the class automatically computes a plaintext version of the text and puts it into MessageText. You may choose to override this default text with your own version.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Sign Method (PHTMLMailer Class)
Signs the message.
Syntax
ANSI (Cross Platform) int Sign(); Unicode (Windows) INT Sign();
int ipworksopenpgp_phtmlmailer_sign(void* lpObj);
int Sign();
Remarks
This method signs the specified message.
The message is signed with the private key specified in Keys.
When signing, the following properties may be used to further configure the class:
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SignAndEncrypt Method (PHTMLMailer Class)
Signs and encrypts the current message.
Syntax
ANSI (Cross Platform) int SignAndEncrypt(); Unicode (Windows) INT SignAndEncrypt();
int ipworksopenpgp_phtmlmailer_signandencrypt(void* lpObj);
int SignAndEncrypt();
Remarks
This method signs and encrypts the specified message.
The message is encrypted with the public keys specified in RecipientKeys and signed with the private key specified in Keys.
When encrypting, the following properties may be used to further configure the class:
When signing, the following properties may be used to further configure the class:
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ConnectionStatus Event (PHTMLMailer Class)
This event is fired to indicate changes in the connection state.
Syntax
ANSI (Cross Platform) virtual int FireConnectionStatus(PHTMLMailerConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } PHTMLMailerConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(PHTMLMailerConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } PHTMLMailerConnectionStatusEventParams;
#define EID_PHTMLMAILER_CONNECTIONSTATUS 1 virtual INT IPWORKSOPENPGP_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
class PHTMLMailerConnectionStatusEventParams { public: const QString &ConnectionEvent(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ConnectionStatus(PHTMLMailerConnectionStatusEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireConnectionStatus(PHTMLMailerConnectionStatusEventParams *e) {...}
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 (PHTMLMailer Class)
This event is fired when the message text completes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(PHTMLMailerEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } PHTMLMailerEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(PHTMLMailerEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } PHTMLMailerEndTransferEventParams;
#define EID_PHTMLMAILER_ENDTRANSFER 2 virtual INT IPWORKSOPENPGP_CALL FireEndTransfer(INT &iDirection);
class PHTMLMailerEndTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EndTransfer(PHTMLMailerEndTransferEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireEndTransfer(PHTMLMailerEndTransferEventParams *e) {...}
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 (PHTMLMailer Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(PHTMLMailerErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } PHTMLMailerErrorEventParams;
Unicode (Windows) virtual INT FireError(PHTMLMailerErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } PHTMLMailerErrorEventParams;
#define EID_PHTMLMAILER_ERROR 3 virtual INT IPWORKSOPENPGP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class PHTMLMailerErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(PHTMLMailerErrorEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireError(PHTMLMailerErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class 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.
KeyPassphrase Event (PHTMLMailer Class)
Fired if the passphrase of current key is incorrect or empty.
Syntax
ANSI (Cross Platform) virtual int FireKeyPassphrase(PHTMLMailerKeyPassphraseEventParams *e);
typedef struct {
const char *UserId;
const char *KeyId;
const char *Fingerprint;
char *Passphrase; int reserved; } PHTMLMailerKeyPassphraseEventParams;
Unicode (Windows) virtual INT FireKeyPassphrase(PHTMLMailerKeyPassphraseEventParams *e);
typedef struct {
LPCWSTR UserId;
LPCWSTR KeyId;
LPCWSTR Fingerprint;
LPWSTR Passphrase; INT reserved; } PHTMLMailerKeyPassphraseEventParams;
#define EID_PHTMLMAILER_KEYPASSPHRASE 4 virtual INT IPWORKSOPENPGP_CALL FireKeyPassphrase(LPSTR &lpszUserId, LPSTR &lpszKeyId, LPSTR &lpszFingerprint, LPSTR &lpszPassphrase);
class PHTMLMailerKeyPassphraseEventParams { public: const QString &UserId(); const QString &KeyId(); const QString &Fingerprint(); const QString &Passphrase(); void SetPassphrase(const QString &qsPassphrase); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void KeyPassphrase(PHTMLMailerKeyPassphraseEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireKeyPassphrase(PHTMLMailerKeyPassphraseEventParams *e) {...}
Remarks
This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the Passphrase field before attempting the operation.
The passphrase is required when using the following methods in KeyMgr:
- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase
When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:
- Decrypt
- Sign
- SignAndEncrypt
UserId holds the user Id of the key the passphrase is required for.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
PITrail Event (PHTMLMailer Class)
This event traces the commands sent to the mail server, and the respective replies.
Syntax
ANSI (Cross Platform) virtual int FirePITrail(PHTMLMailerPITrailEventParams *e);
typedef struct {
int Direction;
const char *Message; int reserved; } PHTMLMailerPITrailEventParams;
Unicode (Windows) virtual INT FirePITrail(PHTMLMailerPITrailEventParams *e);
typedef struct {
INT Direction;
LPCWSTR Message; INT reserved; } PHTMLMailerPITrailEventParams;
#define EID_PHTMLMAILER_PITRAIL 5 virtual INT IPWORKSOPENPGP_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);
class PHTMLMailerPITrailEventParams { public: int Direction(); const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void PITrail(PHTMLMailerPITrailEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FirePITrail(PHTMLMailerPITrailEventParams *e) {...}
Remarks
The PITrail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers.
The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:
0 (Client) | The Message originates from the client. |
1 (Server) | The Message originates from the server. |
2 (Info) | The Message is an informative message originating from the client software (the class code). |
Progress Event (PHTMLMailer Class)
Fired as progress is made.
Syntax
ANSI (Cross Platform) virtual int FireProgress(PHTMLMailerProgressEventParams *e);
typedef struct {
int64 BytesProcessed;
int PercentProcessed; int reserved; } PHTMLMailerProgressEventParams;
Unicode (Windows) virtual INT FireProgress(PHTMLMailerProgressEventParams *e);
typedef struct {
LONG64 BytesProcessed;
INT PercentProcessed; INT reserved; } PHTMLMailerProgressEventParams;
#define EID_PHTMLMAILER_PROGRESS 6 virtual INT IPWORKSOPENPGP_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);
class PHTMLMailerProgressEventParams { public: qint64 BytesProcessed(); int PercentProcessed(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Progress(PHTMLMailerProgressEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireProgress(PHTMLMailerProgressEventParams *e) {...}
Remarks
This event is fired automatically as data is processed by the class.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
SSLServerAuthentication Event (PHTMLMailer Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(PHTMLMailerSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } PHTMLMailerSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(PHTMLMailerSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } PHTMLMailerSSLServerAuthenticationEventParams;
#define EID_PHTMLMAILER_SSLSERVERAUTHENTICATION 7 virtual INT IPWORKSOPENPGP_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class PHTMLMailerSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(PHTMLMailerSSLServerAuthenticationEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireSSLServerAuthentication(PHTMLMailerSSLServerAuthenticationEventParams *e) {...}
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 (PHTMLMailer Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(PHTMLMailerSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } PHTMLMailerSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(PHTMLMailerSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } PHTMLMailerSSLStatusEventParams;
#define EID_PHTMLMAILER_SSLSTATUS 8 virtual INT IPWORKSOPENPGP_CALL FireSSLStatus(LPSTR &lpszMessage);
class PHTMLMailerSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(PHTMLMailerSSLStatusEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireSSLStatus(PHTMLMailerSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (PHTMLMailer Class)
This event is fired when the message text starts transferring.
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(PHTMLMailerStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } PHTMLMailerStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(PHTMLMailerStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } PHTMLMailerStartTransferEventParams;
#define EID_PHTMLMAILER_STARTTRANSFER 9 virtual INT IPWORKSOPENPGP_CALL FireStartTransfer(INT &iDirection);
class PHTMLMailerStartTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void StartTransfer(PHTMLMailerStartTransferEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireStartTransfer(PHTMLMailerStartTransferEventParams *e) {...}
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.
Status Event (PHTMLMailer Class)
Shows the progress of the operation.
Syntax
ANSI (Cross Platform) virtual int FireStatus(PHTMLMailerStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } PHTMLMailerStatusEventParams;
Unicode (Windows) virtual INT FireStatus(PHTMLMailerStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } PHTMLMailerStatusEventParams;
#define EID_PHTMLMAILER_STATUS 10 virtual INT IPWORKSOPENPGP_CALL FireStatus(LPSTR &lpszMessage);
class PHTMLMailerStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Status(PHTMLMailerStatusEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireStatus(PHTMLMailerStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.
The level of detail is controlled by the LogLevel setting.
Transfer Event (PHTMLMailer Class)
This event is fired when the message text is transferred to MailServer .
Syntax
ANSI (Cross Platform) virtual int FireTransfer(PHTMLMailerTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } PHTMLMailerTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(PHTMLMailerTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } PHTMLMailerTransferEventParams;
#define EID_PHTMLMAILER_TRANSFER 11 virtual INT IPWORKSOPENPGP_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);
class PHTMLMailerTransferEventParams { public: int Direction(); qint64 BytesTransferred(); int PercentDone(); const QByteArray &Text(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Transfer(PHTMLMailerTransferEventParams *e);
// Or, subclass PHTMLMailer and override this emitter function. virtual int FireTransfer(PHTMLMailerTransferEventParams *e) {...}
Remarks
One or more Transfer events are fired during message delivery. Messages consist of MessageText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of MessageText or AttachedFile.
Text contains the current portion of the message being sent.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Syntax
IPWorksOpenPGPCertificate (declared in ipworksopenpgp.h)
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
char* (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
char* (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
char* (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
char* (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
char* (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
char* (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
char* (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
char* (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
int (read-only)
Default Value: FALSE
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
char* (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
char* (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
char* (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
char*
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
char*
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
char* (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
char* (read-only)
Default Value: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
char* (read-only)
Default Value: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
char* (read-only)
Default Value: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
char* (read-only)
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
char* (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
char*
Default Value: ""
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 field 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.
Encoded
char*
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
Certificate()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
Certificate(const char* lpEncoded, int lenEncoded)
Parses Encoded as an X.509 public key.
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
FileAttachment Type
This describes the file being attached.
Syntax
IPWorksOpenPGPFileAttachment (declared in ipworksopenpgp.h)
Remarks
This contains information about the location of the file that is being attached to the message.
Fields
Data
char*
Default Value: ""
The raw data for the attachment that will be sent with your message. This field is used if InputStream and File are not set.
FileName
char*
Default Value: ""
This field contains the path of a file on your system to be sent as an attachment with your message. Not used if InputStream is set.
Name
char*
Default Value: ""
This field contains the name of the attachment to be sent.
Constructors
FileAttachment()
FileAttachment(const char* lpszFileName)
FileAttachment(const char* lpszName, const char* lpszFileName)
FileAttachment(const char* lpszName, IPWorksOpenPGPStream* sInputStream)
Firewall Type
The firewall the component will connect through.
Syntax
IPWorksOpenPGPFirewall (declared in ipworksopenpgp.h)
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
int
Default Value: FALSE
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType
int
Default Value: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
char*
Default Value: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.
Password
char*
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Port
int
Default Value: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
char*
Default Value: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Constructors
Firewall()
HTMLImage Type
This type describes an HTML-embedded image.
Syntax
IPWorksOpenPGPHTMLImage (declared in ipworksopenpgp.h)
Remarks
Each image in the HTML message gets set when the MessageHTML property is set. You may, however, make changes to the fields for each HTMLImage before the message is sent.
Fields
Data
char*
Default Value: ""
This field optionally specifies the image data. This may be used instead of specifying an image by file. The value specified here may be either the hex-encoded image data or the raw unencoded image data.
File
char*
Default Value: ""
This field contains the name of the image files embedded into the HTML message. This value is updated every time MessageHTML is set. You may change the file names before sending (e.g., if they don't point to valid files).
Id
char*
Default Value: ""
This field contains the content identifier for embedded images. This value is computed automatically, unless ParseHTML is False, in which case you are responsible for providing it.
ImageType
char*
Default Value: ""
This field contains the content type for embedded images. This value is determined automatically, unless ParseHTML is False, in which case you are responsible for providing it.
Constructors
HTMLImage()
HTMLImage(const char* lpszFile)
Key Type
The OpenPGP key being used.
Syntax
IPWorksOpenPGPKey (declared in ipworksopenpgp.h)
Remarks
This type describes the current key. The key may be a public or secret key. The fields are used to identify or select the key.
Fields
Curve
char* (read-only)
Default Value: ""
This field specifies the elliptic curve if PublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448. Possible values are:
Curve | Valid Public Key Algorithms | Description |
secp256r1 | ECDSA | NIST curve P-256 |
secp384r1 | ECDSA | NIST curve P-384 |
secp521r1 | ECDSA | NIST curve P-521 |
secp256k1 | ECDSA | Secp256k1 |
Ed25519 | EdDSA, Ed25519 | Ed25519 |
Ed448 | Ed448 | Ed448 |
EffectiveDate
char* (read-only)
Default Value: ""
The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:
23-Jan-2000 15:00:00.
Encoded
char*
Default Value: ""
The key. This field can be used to assign a specific key. The Fingerprint, Id, and UserId fields may also be used to specify a key.
ExpirationDate
char* (read-only)
Default Value: ""
The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:
23-Jan-2001 15:00:00.
Fingerprint
char*
Default Value: ""
The hex-encoded, 20-byte fingerprint of the key.
When a key is loaded, this field is populated with the Fingerprint associated with the key. This field may be set to load a key from the Keyring. When this field is set the classwill search the Keyring for a key associated with the Fingerprint specified.
This is in the form:
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
Id
char*
Default Value: ""
The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:
5E70662EA810E768
When a key is loaded, this field is populated with the Id associated with the key. This field may be set to load a key from the Keyring. When this field is set the class will search the Keyring for a key associated with the Id specified.
The KeyIdLength setting may be set to control the length of the returned key Id.
Note: It is recommended to use the Fingerprint field when loading a key from the Keyring, as it is possible for different keys to have the same Id.
Keyring
char*
Default Value: ""
The location of the keyring.
If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.
When This field is set the class will read the keyring and populate the Key property with the first key found in the keyring. Set UserId to select a different key in the current keyring.
OtherUserIds
char* (read-only)
Default Value: ""
If the specified key has alternate user Ids associated with it, this field returns a comma-separated list of the other user Ids.
Passphrase
char*
Default Value: ""
The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this field or through the KeyPassphrase event, which will fire when a passphrase is required.
The passphrase is required when using the following methods in KeyMgr:
- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase
When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:
- Decrypt
- Sign
- SignAndEncrypt
PublicKey
char* (read-only)
Default Value: ""
The public key of the key. The key is provided as ASCII armored data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
A text description of the public key algorithm of the key. Possible values are:
- RSA
- DSA
- ECDSA
- EdDSA
- Ed25519
- Ed448
- RSA-Legacy
PublicKeyLength
int (read-only)
Default Value: 0
The length of the public key in bits. Common values are 512, 1024, and 2048.
If the PublicKeyAlgorithm field is ECDSA, EdDSA, Ed25519, or Ed448, the length of the public key is determined by the Curve. Possible lengths are:
Curve | Public Key Length (bits) |
secp256r1 | 256 |
secp384r1 | 384 |
secp521r1 | 528 |
secp256k1 | 256 |
Ed25519 | 256 |
Ed448 | 456 |
Revoked
int (read-only)
Default Value: FALSE
Whether or not the key is revoked.
SecretKey
char* (read-only)
Default Value: ""
The secret key of the key (if available). The key is provided as ASCII armored data.
SecretKeyAvailable
int (read-only)
Default Value: FALSE
Whether or not a secret key is available for the selected key.
Usage
char* (read-only)
Default Value: ""
A text description of UsageFlags.
The value will be of one or more of the following strings, separated by commas:
- Certifying Other Certificates
- Signing Emails and Files
- Encrypting Emails and Files
- Split Key
- Authenticate Against Servers
- Group Key
UsageFlags
int (read-only)
Default Value: 47
Flags that show the intended use for the key. The default value is 0x0F. The value of UsageFlags is a combination of the following flags:
0x01 | This key may be used to certify other keys. |
0x02 | This key may be used to sign data. |
0x0C | This key may be used to encrypt communications and encrypt storage. |
0x10 | The private component of this key may have been split by a secret-sharing mechanism. |
0x20 | This key may be used for authentication. |
0x80 | The private component of this key may be in the possession of more than one person. |
Please refer to the Usage field for a text representation of UsageFlags.
UserId
char*
Default Value: ""
The user Id of the key. When a key is loaded this field is populated with the user Id associated with the key. This field may be set to load a key from the Keyring. When this field is set the class will search the Keyring for a key associated with the UserId specified.
When loading a key with multiple user Ids, this field will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this field and OtherUserIds after loading the key.
The UserId format is:
FirstName LastName (Comment) <Email>Not all values are required when selecting or generating a key, but at least FirstName or Email are required.
Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.
When using this field to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.
Version
int (read-only)
Default Value: 4
This field can be used to query the OpenPGP version of the currently selected Key. Possible values are:
- 4 - OpenPGP v4 (default)
- 6 - OpenPGP v6
MessageRecipient Type
This types describes the message recipient.
Syntax
IPWorksOpenPGPMessageRecipient (declared in ipworksopenpgp.h)
Remarks
This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the class is sending the message.
Fields
Address
char*
Default Value: ""
This field contains the email address of the recipient.
Name
char*
Default Value: ""
This field contains the name of the recipient.
Options
char*
Default Value: ""
This field contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).
One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.
component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";
RecipientType
int
Default Value: 0
This field contains the recipient type: To, Cc, or Bcc.
Constructors
MessageRecipient()
MessageRecipient(const char* lpszAddress)
IPWorksOpenPGPList Type
Syntax
IPWorksOpenPGPList<T> (declared in ipworksopenpgp.h)
Remarks
IPWorksOpenPGPList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the PHTMLMailer class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount() {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
IPWorksOpenPGPStream Type
Syntax
IPWorksOpenPGPStream (declared in ipworksopenpgp.h)
Remarks
The PHTMLMailer class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksOpenPGPStream interface and pass the PHTMLMailer class an instance of that concrete class.
When implementing the IPWorksOpenPGPStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when an IPWorksOpenPGPStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config Settings (PHTMLMailer Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.PHTMLMailer Config Settings
Note: some mail applications such as GpgOL cannot process cleartext signatures.
zlib | 1-6 |
zip | 1-6 |
bzip2 | 1-9 |
DSA Notes
DSA requires that the hash be 160 bits or larger, which means MD5 is not a suitable algorithm. When DSA Signature Hash Algorithm selection is enabled (default) the class will use the preferred algorithm from the key if it meets the requirements for DSA. If the preferred algorithm is MD5 and does not meed the requirements for DSA the class will automatically use a suitable algorithm based on the Q element of the DSA key (may be SHA1, SHA224, or SHA256).
ECDSA Notes
The ECDSA Signature Hash Algorithm requirements are directly related to the Curve used by the key. When this setting is enabled (default) the class will use the preferred algorithm from the key if it meets the requirements for ECDSA. If the preferred algorithm does not meet the requirements the class will automatically select a valid hash algorithm based on the curve as follows:
Curve | Hash Algorithm |
secp256r1 | SHA256 |
secp384r1 | SHA384 |
secp521r1 | SHA512 |
secp256k1 | SHA256 |
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is logged. |
This setting will be populated after calling Decrypt, VerifySignature, or DecryptAndVerifySignature.
HTMLMailer Config Settings
0 | 7-bit |
1 | Quoted-Printable |
2 | Base64 |
3 | 8-bit |
0 | 7-bit |
1 | Quoted-Printable |
2 | Base64 |
3 | 8-bit |
Note: Be aware of security considerations when using this configuration.
Note: Be aware of security considerations when using this configuration.
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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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 class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----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-----
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
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 class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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 class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class 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 class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
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 |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
On Linux, the C++ edition requires installation of the FIPS-enabled OpenSSL library. The OpenSSL FIPS provider version must be at least 3.0.0. For additional information and instructions regarding the installation and activation of the FIPS-enabled OpenSSL library, please refer to the following link: https://github.com/openssl/openssl/blob/master/README-FIPS.md
To ensure the class utilizes the FIPS-enabled OpenSSL library, the obfuscated source code should first be compiled with OpenSSL enabled, as described in the Supported Platforms section. Additionally, the FIPS module should be enabled and active. If the obfuscated source code is not compiled as mentioned, or the FIPS module is inactive, the class will throw an appropriate error assuming FIPS mode is enabled.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (PHTMLMailer Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
HTMLMailer Errors
169 | Invalid image index (out of range). |
170 | Invalid attachment index (out of range). |
The class may also return one of the following error codes, which are inherited from other classes.
MIME Errors
3 | Can't create the file for write (illegal name or disk is write-protected). |
4 | Can't open the file for read (doesn't exist?). |
5 | Can't read from file. |
6 | Can't write to file (disk full?). |
280 | Invalid Part Index. |
281 | Unknown MIME type. |
282 | No MIME-boundary found. |
283 | No file given. |
284 | The class is busy. |
285 | Can't create a temporary file to decode the data. |
286 | Can't read Message file. |
287 | No header separator found. |
289 | No separator found. |
290 | Input stream must have seeking enabled. |
SMTP Errors
118 | Firewall Error. Error message contains detailed description. |
161 | SMTP protocol error. Description contains the server reply. |
162 | Error communicating with server. Error text is attached. |
163 | Please specify a MailServer. |
164 | Please specify a sender (From). |
165 | Please specify a recipient. |
166 | Busy executing current method. |
301 | Operation interrupted. |
302 | Cannot open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |
OpenPGP Errors
101 | Cannot decode ASCII Armor data. |
102 | Unknown ASCII Armor data type. |
103 | Checksum failed. |
104 | Unknown ASCII Armor header. |
105 | Cannot decode PGP packet. |
106 | Cannot encode PGP packet. |
107 | Unknown PGP packet tag. |
108 | Unsupported version. |
109 | Unsupported algorithm. |
110 | Unknown subpacket. |
111 | Internal error. |
112 | Feature not supported. |
113 | Secret data was not encrypted. |
114 | Cannot find the key. |
115 | Error reading file. |
116 | Error writing file. |
117 | Error reading key. |
118 | Error writing key. |
119 | Cannot verify signature. |
120 | Cannot create signature. |
121 | Invalid UserId. |
122 | Invalid passphrase. |
123 | Data encryption failed. |
124 | Error creating key. |
125 | Unsupported symmetric algorithm. |
126 | Unsupported hash. |
127 | Unsupported compression algorithm. |
128 | Invalid key usage. |
129 | Component is busy. |
130 | Error decrypting data. |
131 | Data is not compressed. |
132 | Error decompressing data. |
133 | Error compressing data. |
134 | Unsupported signature. |
135 | Failed to overwrite file. |
141 | No input. |
142 | Signing was required, but the message was not signed. |
143 | Encryption was required, but the message was not encrypted. |
146 | No data integrity packet was found (MDC), but one was required. |
200 | Out of memory. |