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.

Method List

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

Event List

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

Config Settings

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

AttachmentCount Property (PHTMLMailer Class)

The number of records in the Attachment arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount);

Unicode (Windows)
INT GetAttachmentCount();
INT SetAttachmentCount(INT iAttachmentCount);

int ipworksopenpgp_phtmlmailer_getattachmentcount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setattachmentcount(void* lpObj, int iAttachmentCount);

int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentFile
• AttachmentInputStream
• AttachmentName

The array indices start at 0 and end at AttachmentCount - 1.

This property is not available at design time.

Data Type

Integer

AttachmentFile Property (PHTMLMailer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentFile(int iAttachmentIndex);
int SetAttachmentFile(int iAttachmentIndex, const char* lpszAttachmentFile);

Unicode (Windows)
LPWSTR GetAttachmentFile(INT iAttachmentIndex);
INT SetAttachmentFile(INT iAttachmentIndex, LPCWSTR lpszAttachmentFile);

char* ipworksopenpgp_phtmlmailer_getattachmentfile(void* lpObj, int attachmentindex);
int ipworksopenpgp_phtmlmailer_setattachmentfile(void* lpObj, int attachmentindex, const char* lpszAttachmentFile);

QString GetAttachmentFile(int iAttachmentIndex);
int SetAttachmentFile(int iAttachmentIndex, QString qsAttachmentFile);

Default Value

""

Remarks

This property contains the path of a file on your system to be sent as an attachment with your message. Not used if AttachmentInputStream is set.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentInputStream Property (PHTMLMailer Class)

When this property is set to a valid stream, the class will attach the data from the stream as the current attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetAttachmentInputStream(int iAttachmentIndex, IPWorksOpenPGPStream* sAttachmentInputStream);

Unicode (Windows)
INT SetAttachmentInputStream(INT iAttachmentIndex, IPWorksOpenPGPStream* sAttachmentInputStream);

int ipworksopenpgp_phtmlmailer_setattachmentinputstream(void* lpObj, int attachmentindex, IPWorksOpenPGPStream* sAttachmentInputStream);

int SetAttachmentInputStream(int iAttachmentIndex, IPWorksOpenPGPStream* sAttachmentInputStream);

Remarks

When this property is set to a valid stream, the class will attach the data from the stream as the current attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

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

Data Type

IPWorksOpenPGPStream

AttachmentName Property (PHTMLMailer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, const char* lpszAttachmentName);

Unicode (Windows)
LPWSTR GetAttachmentName(INT iAttachmentIndex);
INT SetAttachmentName(INT iAttachmentIndex, LPCWSTR lpszAttachmentName);

char* ipworksopenpgp_phtmlmailer_getattachmentname(void* lpObj, int attachmentindex);
int ipworksopenpgp_phtmlmailer_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);

QString GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, QString qsAttachmentName);

Default Value

""

Remarks

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

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AuthMechanism Property (PHTMLMailer Class)

This property is used when connecting to the mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);

Unicode (Windows)
INT GetAuthMechanism();
INT SetAuthMechanism(INT iAuthMechanism);

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

Command Property (PHTMLMailer Class)

This property is used to send additional commands directly to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetCommand(const char* lpszCommand);

Unicode (Windows)
INT SetCommand(LPCWSTR lpszCommand);

int ipworksopenpgp_phtmlmailer_setcommand(void* lpObj, const char* lpszCommand);

int SetCommand(QString qsCommand);

Default Value

""

Remarks

This property can be used to send additional commands directly to the server. Check the LastReply property or trap the PITrail events coming from the server to get the response.

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

Data Type

String

CompressionMethod Property (PHTMLMailer Class)

The compression algorithm used.

Syntax

• C++
• C
• Qt

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 shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworksopenpgp_phtmlmailer_getconnected(void* lpObj);
int ipworksopenpgp_phtmlmailer_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is 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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

Data Type

String

FirewallAutoDetect Property (PHTMLMailer Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksopenpgp_phtmlmailer_getfirewallautodetect(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (PHTMLMailer Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksopenpgp_phtmlmailer_getfirewalltype(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (PHTMLMailer Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksopenpgp_phtmlmailer_getfirewallhost(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (PHTMLMailer Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksopenpgp_phtmlmailer_getfirewallpassword(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (PHTMLMailer Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksopenpgp_phtmlmailer_getfirewallport(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (PHTMLMailer Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksopenpgp_phtmlmailer_getfirewalluser(void* lpObj);
int ipworksopenpgp_phtmlmailer_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

From Property (PHTMLMailer Class)

The email address of the sender (required).

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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)

The current status of the class.

Syntax

• C++
• C
• Qt

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 and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

ImageCount Property (PHTMLMailer Class)

The number of records in the Image arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetImageCount();
int SetImageCount(int iImageCount);

Unicode (Windows)
INT GetImageCount();
INT SetImageCount(INT iImageCount);

int ipworksopenpgp_phtmlmailer_getimagecount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setimagecount(void* lpObj, int iImageCount);

int GetImageCount();
int SetImageCount(int iImageCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ImageData
• ImageFile
• ImageId
• ImageType

The array indices start at 0 and end at ImageCount - 1.

This property is not available at design time.

Data Type

Integer

ImageData Property (PHTMLMailer Class)

This property optionally specifies the image data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetImageData(int iImageIndex, char* &lpImageData, int &lenImageData);
int SetImageData(int iImageIndex, const char* lpImageData, int lenImageData);

Unicode (Windows)
INT GetImageData(INT iImageIndex, LPSTR &lpImageData, INT &lenImageData);
INT SetImageData(INT iImageIndex, LPCSTR lpImageData, INT lenImageData);

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

QByteArray GetImageData(int iImageIndex);
int SetImageData(int iImageIndex, QByteArray qbaImageData);

Default Value

""

Remarks

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

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

This property is not available at design time.

Data Type

Binary String

ImageFile Property (PHTMLMailer Class)

This property contains the name of the image files embedded into the HTML message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImageFile(int iImageIndex);
int SetImageFile(int iImageIndex, const char* lpszImageFile);

Unicode (Windows)
LPWSTR GetImageFile(INT iImageIndex);
INT SetImageFile(INT iImageIndex, LPCWSTR lpszImageFile);

char* ipworksopenpgp_phtmlmailer_getimagefile(void* lpObj, int imageindex);
int ipworksopenpgp_phtmlmailer_setimagefile(void* lpObj, int imageindex, const char* lpszImageFile);

QString GetImageFile(int iImageIndex);
int SetImageFile(int iImageIndex, QString qsImageFile);

Default Value

""

Remarks

This property contains the name of the image files embedded into the HTML message. This value is updated every time MessageHTML is set. You may change the file names before sending (e.g., if they don't point to valid files).

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

This property is not available at design time.

Data Type

String

ImageId Property (PHTMLMailer Class)

This property contains the content identifier for embedded images.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImageId(int iImageIndex);
int SetImageId(int iImageIndex, const char* lpszImageId);

Unicode (Windows)
LPWSTR GetImageId(INT iImageIndex);
INT SetImageId(INT iImageIndex, LPCWSTR lpszImageId);

char* ipworksopenpgp_phtmlmailer_getimageid(void* lpObj, int imageindex);
int ipworksopenpgp_phtmlmailer_setimageid(void* lpObj, int imageindex, const char* lpszImageId);

QString GetImageId(int iImageIndex);
int SetImageId(int iImageIndex, QString qsImageId);

Default Value

""

Remarks

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

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

This property is not available at design time.

Data Type

String

ImageType Property (PHTMLMailer Class)

This property contains the content type for embedded images.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImageType(int iImageIndex);
int SetImageType(int iImageIndex, const char* lpszImageType);

Unicode (Windows)
LPWSTR GetImageType(INT iImageIndex);
INT SetImageType(INT iImageIndex, LPCWSTR lpszImageType);

char* ipworksopenpgp_phtmlmailer_getimagetype(void* lpObj, int imageindex);
int ipworksopenpgp_phtmlmailer_setimagetype(void* lpObj, int imageindex, const char* lpszImageType);

QString GetImageType(int iImageIndex);
int SetImageType(int iImageIndex, QString qsImageType);

Default Value

""

Remarks

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

The ImageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ImageCount property.

This property is not available at design time.

Data Type

String

Importance Property (PHTMLMailer Class)

Importance of the mail message (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetImportance();
int SetImportance(int iImportance);

Unicode (Windows)
INT GetImportance();
INT SetImportance(INT iImportance);

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

Data Type

Integer

KeyCount Property (PHTMLMailer Class)

The number of records in the Key arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyCount();
int SetKeyCount(int iKeyCount);

Unicode (Windows)
INT GetKeyCount();
INT SetKeyCount(INT iKeyCount);

int ipworksopenpgp_phtmlmailer_getkeycount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setkeycount(void* lpObj, int iKeyCount);

int GetKeyCount();
int SetKeyCount(int iKeyCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyEncoded
• KeyKeyring
• KeyPassphrase
• KeyUserId

The array indices start at 0 and end at KeyCount - 1.

This property is not available at design time.

Data Type

Integer

KeyEncoded Property (PHTMLMailer Class)

The key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyEncoded(int iKeyIndex, char* &lpKeyEncoded, int &lenKeyEncoded);
int SetKeyEncoded(int iKeyIndex, const char* lpKeyEncoded, int lenKeyEncoded);

Unicode (Windows)
INT GetKeyEncoded(INT iKeyIndex, LPSTR &lpKeyEncoded, INT &lenKeyEncoded);
INT SetKeyEncoded(INT iKeyIndex, LPCSTR lpKeyEncoded, INT lenKeyEncoded);

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

QByteArray GetKeyEncoded(int iKeyIndex);
int SetKeyEncoded(int iKeyIndex, QByteArray qbaKeyEncoded);

Default Value

""

Remarks

The key. This property is used to assign a specific key. The KeyUserId properties may also be used to specify a key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is not available at design time.

Data Type

Binary String

KeyKeyring Property (PHTMLMailer Class)

The location of the keyring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyKeyring(int iKeyIndex);
int SetKeyKeyring(int iKeyIndex, const char* lpszKeyKeyring);

Unicode (Windows)
LPWSTR GetKeyKeyring(INT iKeyIndex);
INT SetKeyKeyring(INT iKeyIndex, LPCWSTR lpszKeyKeyring);

char* ipworksopenpgp_phtmlmailer_getkeykeyring(void* lpObj, int keyindex);
int ipworksopenpgp_phtmlmailer_setkeykeyring(void* lpObj, int keyindex, const char* lpszKeyKeyring);

QString GetKeyKeyring(int iKeyIndex);
int SetKeyKeyring(int iKeyIndex, QString qsKeyKeyring);

Default Value

""

Remarks

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 property is set the class will read the keyring and populate the Key* properties with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is not available at design time.

Data Type

String

KeyPassphrase Property (PHTMLMailer Class)

The passphrase for the key's secret key (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyPassphrase(int iKeyIndex);
int SetKeyPassphrase(int iKeyIndex, const char* lpszKeyPassphrase);

Unicode (Windows)
LPWSTR GetKeyPassphrase(INT iKeyIndex);
INT SetKeyPassphrase(INT iKeyIndex, LPCWSTR lpszKeyPassphrase);

char* ipworksopenpgp_phtmlmailer_getkeypassphrase(void* lpObj, int keyindex);
int ipworksopenpgp_phtmlmailer_setkeypassphrase(void* lpObj, int keyindex, const char* lpszKeyPassphrase);

QString GetKeyPassphrase(int iKeyIndex);
int SetKeyPassphrase(int iKeyIndex, QString qsKeyPassphrase);

Default Value

""

Remarks

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is not available at design time.

Data Type

String

KeyUserId Property (PHTMLMailer Class)

The user Id of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyUserId(int iKeyIndex);
int SetKeyUserId(int iKeyIndex, const char* lpszKeyUserId);

Unicode (Windows)
LPWSTR GetKeyUserId(INT iKeyIndex);
INT SetKeyUserId(INT iKeyIndex, LPCWSTR lpszKeyUserId);

char* ipworksopenpgp_phtmlmailer_getkeyuserid(void* lpObj, int keyindex);
int ipworksopenpgp_phtmlmailer_setkeyuserid(void* lpObj, int keyindex, const char* lpszKeyUserId);

QString GetKeyUserId(int iKeyIndex);
int SetKeyUserId(int iKeyIndex, QString qsKeyUserId);

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property 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 property 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 property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

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

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is not available at design time.

Data Type

String

LastReply Property (PHTMLMailer Class)

The last reply from the server.

Syntax

• C++
• C
• Qt

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

This property is read-only.

Data Type

String

LocalHost Property (PHTMLMailer Class)

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

Syntax

• C++
• C
• Qt

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 multi-homed 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 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 multi-homed 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)

The server port for SMTP (default 25).

Syntax

• C++
• C
• Qt

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

The name or address of a mail server (mail relay).

Syntax

• C++
• C
• Qt

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 (a UNIX host for example), 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 and 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)

Date of the mail message (optional).

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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)

The Message Identifier for the message.

Syntax

• C++
• C
• Qt

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

MessageRecipientCount Property (PHTMLMailer Class)

The number of records in the MessageRecipient arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageRecipientCount();
int SetMessageRecipientCount(int iMessageRecipientCount);

Unicode (Windows)
INT GetMessageRecipientCount();
INT SetMessageRecipientCount(INT iMessageRecipientCount);

int ipworksopenpgp_phtmlmailer_getmessagerecipientcount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setmessagerecipientcount(void* lpObj, int iMessageRecipientCount);

int GetMessageRecipientCount();
int SetMessageRecipientCount(int iMessageRecipientCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageRecipientAddress
• MessageRecipientName
• MessageRecipientOptions
• MessageRecipientType

The array indices start at 0 and end at MessageRecipientCount - 1.

This property is not available at design time.

Data Type

Integer

MessageRecipientAddress Property (PHTMLMailer Class)

This property contains the email address of the recipient.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageRecipientAddress(int iRecipientIndex);
int SetMessageRecipientAddress(int iRecipientIndex, const char* lpszMessageRecipientAddress);

Unicode (Windows)
LPWSTR GetMessageRecipientAddress(INT iRecipientIndex);
INT SetMessageRecipientAddress(INT iRecipientIndex, LPCWSTR lpszMessageRecipientAddress);

char* ipworksopenpgp_phtmlmailer_getmessagerecipientaddress(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipientaddress(void* lpObj, int recipientindex, const char* lpszMessageRecipientAddress);

QString GetMessageRecipientAddress(int iRecipientIndex);
int SetMessageRecipientAddress(int iRecipientIndex, QString qsMessageRecipientAddress);

Default Value

""

Remarks

This property contains the email address of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

This property is not available at design time.

Data Type

String

MessageRecipientName Property (PHTMLMailer Class)

This property contains the name of the recipient.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageRecipientName(int iRecipientIndex);
int SetMessageRecipientName(int iRecipientIndex, const char* lpszMessageRecipientName);

Unicode (Windows)
LPWSTR GetMessageRecipientName(INT iRecipientIndex);
INT SetMessageRecipientName(INT iRecipientIndex, LPCWSTR lpszMessageRecipientName);

char* ipworksopenpgp_phtmlmailer_getmessagerecipientname(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipientname(void* lpObj, int recipientindex, const char* lpszMessageRecipientName);

QString GetMessageRecipientName(int iRecipientIndex);
int SetMessageRecipientName(int iRecipientIndex, QString qsMessageRecipientName);

Default Value

""

Remarks

This property contains the name of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

This property is not available at design time.

Data Type

String

MessageRecipientOptions Property (PHTMLMailer Class)

This property contains the recipient sending options (used only by SMTP).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageRecipientOptions(int iRecipientIndex);
int SetMessageRecipientOptions(int iRecipientIndex, const char* lpszMessageRecipientOptions);

Unicode (Windows)
LPWSTR GetMessageRecipientOptions(INT iRecipientIndex);
INT SetMessageRecipientOptions(INT iRecipientIndex, LPCWSTR lpszMessageRecipientOptions);

char* ipworksopenpgp_phtmlmailer_getmessagerecipientoptions(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipientoptions(void* lpObj, int recipientindex, const char* lpszMessageRecipientOptions);

QString GetMessageRecipientOptions(int iRecipientIndex);
int SetMessageRecipientOptions(int iRecipientIndex, QString qsMessageRecipientOptions);

Default Value

""

Remarks

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

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

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

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

This property is not available at design time.

Data Type

String

MessageRecipientType Property (PHTMLMailer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageRecipientType(int iRecipientIndex);
int SetMessageRecipientType(int iRecipientIndex, int iMessageRecipientType);

Unicode (Windows)
INT GetMessageRecipientType(INT iRecipientIndex);
INT SetMessageRecipientType(INT iRecipientIndex, INT iMessageRecipientType);

RT_TO(0), 
RT_CC(1), 
RT_BCC(2)

int ipworksopenpgp_phtmlmailer_getmessagerecipienttype(void* lpObj, int recipientindex);
int ipworksopenpgp_phtmlmailer_setmessagerecipienttype(void* lpObj, int recipientindex, int iMessageRecipientType);

int GetMessageRecipientType(int iRecipientIndex);
int SetMessageRecipientType(int iRecipientIndex, int iMessageRecipientType);

Default Value

0

Remarks

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

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

This property is not available at design time.

Data Type

Integer

MessageText Property (PHTMLMailer Class)

This property includes the plaintext version of the message.

Syntax

• C++
• C
• Qt

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)

An RFC 822 compliant string consisting of extra headers.

Syntax

• C++
• C
• Qt

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, etc.

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 (Send an Email With 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

• C++
• C
• Qt

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)

A password for logon to the MailServer .

Syntax

• C++
• C
• Qt

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 non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent in order to provide authentication information for the user.

This property is not available at design time.

Data Type

String

Priority Property (PHTMLMailer Class)

Priority of the mail message (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPriority();
int SetPriority(int iPriority);

Unicode (Windows)
INT GetPriority();
INT SetPriority(INT iPriority);

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)

Email address to send a read receipt to.

Syntax

• C++
• C
• Qt

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

Data Type

String

RecipientKeyCount Property (PHTMLMailer Class)

The number of records in the RecipientKey arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyCount();
int SetRecipientKeyCount(int iRecipientKeyCount);

Unicode (Windows)
INT GetRecipientKeyCount();
INT SetRecipientKeyCount(INT iRecipientKeyCount);

int ipworksopenpgp_phtmlmailer_getrecipientkeycount(void* lpObj);
int ipworksopenpgp_phtmlmailer_setrecipientkeycount(void* lpObj, int iRecipientKeyCount);

int GetRecipientKeyCount();
int SetRecipientKeyCount(int iRecipientKeyCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• RecipientKeyEncoded
• RecipientKeyKeyring
• RecipientKeyUserId

The array indices start at 0 and end at RecipientKeyCount - 1.

This property is not available at design time.

Data Type

Integer

RecipientKeyEncoded Property (PHTMLMailer Class)

The key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyEncoded(int iRecipientKeyIndex, char* &lpRecipientKeyEncoded, int &lenRecipientKeyEncoded);
int SetRecipientKeyEncoded(int iRecipientKeyIndex, const char* lpRecipientKeyEncoded, int lenRecipientKeyEncoded);

Unicode (Windows)
INT GetRecipientKeyEncoded(INT iRecipientKeyIndex, LPSTR &lpRecipientKeyEncoded, INT &lenRecipientKeyEncoded);
INT SetRecipientKeyEncoded(INT iRecipientKeyIndex, LPCSTR lpRecipientKeyEncoded, INT lenRecipientKeyEncoded);

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

QByteArray GetRecipientKeyEncoded(int iRecipientKeyIndex);
int SetRecipientKeyEncoded(int iRecipientKeyIndex, QByteArray qbaRecipientKeyEncoded);

Default Value

""

Remarks

The key. This property is used to assign a specific key. The RecipientKeyUserId properties may also be used to specify a key.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is not available at design time.

Data Type

Binary String

RecipientKeyKeyring Property (PHTMLMailer Class)

The location of the keyring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientKeyKeyring(int iRecipientKeyIndex);
int SetRecipientKeyKeyring(int iRecipientKeyIndex, const char* lpszRecipientKeyKeyring);

Unicode (Windows)
LPWSTR GetRecipientKeyKeyring(INT iRecipientKeyIndex);
INT SetRecipientKeyKeyring(INT iRecipientKeyIndex, LPCWSTR lpszRecipientKeyKeyring);

char* ipworksopenpgp_phtmlmailer_getrecipientkeykeyring(void* lpObj, int recipientkeyindex);
int ipworksopenpgp_phtmlmailer_setrecipientkeykeyring(void* lpObj, int recipientkeyindex, const char* lpszRecipientKeyKeyring);

QString GetRecipientKeyKeyring(int iRecipientKeyIndex);
int SetRecipientKeyKeyring(int iRecipientKeyIndex, QString qsRecipientKeyKeyring);

Default Value

""

Remarks

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 property is set the class will read the keyring and populate the Key* properties with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is not available at design time.

Data Type

String

RecipientKeyUserId Property (PHTMLMailer Class)

The user Id of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientKeyUserId(int iRecipientKeyIndex);
int SetRecipientKeyUserId(int iRecipientKeyIndex, const char* lpszRecipientKeyUserId);

Unicode (Windows)
LPWSTR GetRecipientKeyUserId(INT iRecipientKeyIndex);
INT SetRecipientKeyUserId(INT iRecipientKeyIndex, LPCWSTR lpszRecipientKeyUserId);

char* ipworksopenpgp_phtmlmailer_getrecipientkeyuserid(void* lpObj, int recipientkeyindex);
int ipworksopenpgp_phtmlmailer_setrecipientkeyuserid(void* lpObj, int recipientkeyindex, const char* lpszRecipientKeyUserId);

QString GetRecipientKeyUserId(int iRecipientKeyIndex);
int SetRecipientKeyUserId(int iRecipientKeyIndex, QString qsRecipientKeyUserId);

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property 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 property 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 property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

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

The RecipientKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientKeyCount property.

This property is not available at design time.

Data Type

String

ReplyTo Property (PHTMLMailer Class)

A mail address to which to reply (optional).

Syntax

• C++
• C
• Qt

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 non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (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)

A comma separated list of addresses for destinations (required).

Syntax

• C++
• C
• Qt

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

Sensitivity of the mail message (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSensitivity();
int SetSensitivity(int iSensitivity);

Unicode (Windows)
INT GetSensitivity();
INT SetSensitivity(INT iSensitivity);

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 is 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: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).

Data Type

Integer

SigningAlgorithm Property (PHTMLMailer Class)

The signature hash algorithm used when signing.

Syntax

• C++
• C
• Qt

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

Data Type

String

SSLAcceptServerCertEncoded Property (PHTMLMailer Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksopenpgp_phtmlmailer_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksopenpgp_phtmlmailer_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (PHTMLMailer Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksopenpgp_phtmlmailer_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksopenpgp_phtmlmailer_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (PHTMLMailer Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksopenpgp_phtmlmailer_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksopenpgp_phtmlmailer_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (PHTMLMailer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksopenpgp_phtmlmailer_getsslcertstorepassword(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (PHTMLMailer Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksopenpgp_phtmlmailer_getsslcertstoretype(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

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 property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (PHTMLMailer Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksopenpgp_phtmlmailer_getsslcertsubject(void* lpObj);
int ipworksopenpgp_phtmlmailer_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLEnabled Property (PHTMLMailer Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

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 setting 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 specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

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:

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

SSLServerCertEncoded Property (PHTMLMailer Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworksopenpgp_phtmlmailer_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

SSLStartMode Property (PHTMLMailer Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

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:

Data Type

Integer

Subject Property (PHTMLMailer Class)

The subject of the mail message (optional).

Syntax

• C++
• C
• Qt

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)

A timeout for the class.

Syntax

• C++
• C
• Qt

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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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)

A user identifier to login as in the MailServer .

Syntax

• C++
• C
• Qt

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 non-empty string, then when connecting to the MailServer an AUTH or CRAM-MD5 (depending on the value of AuthMechanism) command is sent in order 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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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 the RecipientKey* properties.

When encrypting, the following properties may be used to further configure the class:

• CompressionMethod
• EncryptingAlgorithm

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)

Interrupt the current method.

Syntax

• C++
• C
• Qt

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)

Sends the messages which have previously been queued into QueueDir .

Syntax

• C++
• C
• Qt

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 which have previously been queued into QueueDir. The PITrail event shows the interaction with the server as messages as are processed.

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

Queues the message into QueueDir .

Syntax

• C++
• C
• Qt

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.

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

Resets all the message headers to empty.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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

SetMessageHTMLStream Method (PHTMLMailer Class)

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

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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 the Key* properties.

When signing, the following properties may be used to further configure the class:

• ClearSignature
• SigningAlgorithm

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

• C++
• C
• Qt

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 the RecipientKey* properties and signed with the private key specified in the Key* properties.

When encrypting, the following properties may be used to further configure the class:

• CompressionMethod
• EncryptingAlgorithm

When signing, the following properties may be used to further configure the class:

• ClearSignature
• SigningAlgorithm

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

• C++
• C
• Qt

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:

EndTransfer Event (PHTMLMailer Class)

This event is fired when the message text completes transferring.

Syntax

• C++
• C
• Qt

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)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireKeyPassphrase(PHTMLMailerKeyPassphraseEventParams *e);

typedef struct {
  const char *UserId;
  const char *KeyId;
  char *Passphrase;
  int reserved;
} PHTMLMailerKeyPassphraseEventParams;


Unicode (Windows)
virtual INT FireKeyPassphrase(PHTMLMailerKeyPassphraseEventParams *e);

typedef struct {
  LPCWSTR UserId;
  LPCWSTR KeyId;
  LPWSTR Passphrase;
  INT reserved;
} PHTMLMailerKeyPassphraseEventParams;

#define EID_PHTMLMAILER_KEYPASSPHRASE 4

virtual INT IPWORKSOPENPGP_CALL FireKeyPassphrase(LPSTR &lpszUserId, LPSTR &lpszKeyId, LPSTR &lpszPassphrase);

class PHTMLMailerKeyPassphraseEventParams {
public:
  const QString &UserId();

  const QString &KeyId();

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

PITrail Event (PHTMLMailer Class)

Traces the commands sent to the mail server, and the respective replies.

Syntax

• C++
• C
• Qt

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

Progress Event (PHTMLMailer Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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)

Fired when the message text starts transferring.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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)

Fired while the message text gets transferred to MailServer .

Syntax

• C++
• C
• Qt

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

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.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (PHTMLMailer Class)

PHTMLMailer Config Settings

HTMLMailer Config Settings

SMTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings