PPOP Class

Properties   Methods   Events   Config Settings   Errors  

The PPOP class is used retrieve and process OpenPGP encrypted and/or signed messages from Internet Post Office servers (POP).

Syntax

PPOP

Remarks

The PPOP class implements a standard internet post office (POP3) client, as specified in RFC 1725, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. You can send an OpenPGP signed and encrypted message using the PSMTP class by calling the Encrypt, Sign, and SignAndEncrypt methods.

Connect to the Server

To connect to a MailServer, first set the appropriate User and Password and then connect by calling the Connect method. Upon successful connection to the MailServer, the number of waiting messages is shown by the MessageCount property. A message is selected by setting the MessageNumber property to a number between 1 and MessageCount (inclusive). Then, the message text and/or headers are received by calling the Retrieve method.

Receive Messages

The message text is received through the Transfer event, whereas the message headers are received through the Header event. Additionally, up to MaxLines from the message body are provided in the MessageText property. The StartTransfer and EndTransfer events are fired at the beginning and end of message transmission. The PITrail event provides a trace of the interaction between the client and server (excluding message transfers).

Verify

To verify the signature of a message specify the public key to be used for signature verification by setting the SignerKey* properties. For instance: PPOP1.SignerKeyCount = 1 PPOP1.SignerKeyKeyring(0) = "c:\my_keyring_dir" PPOP1.SignerKeyUserId(0) = "sender@nsoftware.com" The specified public key will be used to verify the signature when calling VerifySignature.

Decrypt

To process an encrypted or signed message first retrieve the message text and headers by calling Retrieve. To decrypt a message specify the private key to be used for decryption by setting the Key* properties. For instance: PPOP1.KeyCount = 1 PPOP1.KeyKeyring(0) = "c:\my_keyring_dir" PPOP1.KeyUserId(0) = "recipient@nsoftware.com" PPOP1.KeyPassphrase(0) = "password" The specified private key will be used to decrypt the message when calling Decrypt.

Decrypt and Verify

To decrypt and verify in one step, you can call DecryptAndVerifySignature. Set the public key of the sender in the and the private key to be used for decryption in the Key* properties .

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.

AuthMechanism Property (PPOP Class)

This property includes the authentication mechanism to be 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_ppop_getauthmechanism(void* lpObj);
int ipworksopenpgp_ppop_setauthmechanism(void* lpObj, int iAuthMechanism);

int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism);

Default Value

0

Remarks

This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to log in to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.

amSASLPlain (4) is also available, but most servers require a Secure Sockets Layer (SSL) connection when utilizing this authentication mechanism.

amKerberos (6) is for Kerberos authentication. Note: This functionality is available only in Windows.

Data Type

Integer

Connected Property (PPOP Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksopenpgp_ppop_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Data Type

Boolean

Firewall Property (PPOP Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksOpenPGPFirewall* GetFirewall();
int SetFirewall(IPWorksOpenPGPFirewall* val);

int ipworksopenpgp_ppop_getfirewallautodetect(void* lpObj);
int ipworksopenpgp_ppop_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksopenpgp_ppop_getfirewalltype(void* lpObj);
int ipworksopenpgp_ppop_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksopenpgp_ppop_getfirewallhost(void* lpObj);
int ipworksopenpgp_ppop_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksopenpgp_ppop_getfirewallpassword(void* lpObj);
int ipworksopenpgp_ppop_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksopenpgp_ppop_getfirewallport(void* lpObj);
int ipworksopenpgp_ppop_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksopenpgp_ppop_getfirewalluser(void* lpObj);
int ipworksopenpgp_ppop_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

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

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

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

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

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

Remarks

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

Data Type

IPWorksOpenPGPFirewall

Idle Property (PPOP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksopenpgp_ppop_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

IncludeHeaders Property (PPOP Class)

This property instructs the class to include the headers in the MessageText and LocalFile.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeHeaders();
int SetIncludeHeaders(int bIncludeHeaders);

Unicode (Windows)
BOOL GetIncludeHeaders();
INT SetIncludeHeaders(BOOL bIncludeHeaders);

int ipworksopenpgp_ppop_getincludeheaders(void* lpObj);
int ipworksopenpgp_ppop_setincludeheaders(void* lpObj, int bIncludeHeaders);

bool GetIncludeHeaders();
int SetIncludeHeaders(bool bIncludeHeaders);

Default Value

FALSE

Remarks

This property instructs the component to include the headers in the MessageText and LocalFile. If set to True, the headers for the message being retrieved will be placed before the message body in the MessageText property;. If LocalFile is set, then the headers will be written to that file before the message body. In this manner, the whole content of a MIME-encoded message can be passed to the MIME class for further message processing.

Data Type

Boolean

Keys Property (PPOP Class)

A collection of keys used for cryptographic operations.

Syntax

• C++
• C
• Qt

IPWorksOpenPGPList<IPWorksOpenPGPKey>* GetKeys();
int SetKeys(IPWorksOpenPGPList<IPWorksOpenPGPKey>* val);

int ipworksopenpgp_ppop_getkeycount(void* lpObj);
int ipworksopenpgp_ppop_setkeycount(void* lpObj, int iKeyCount);

int ipworksopenpgp_ppop_getkeyencoded(void* lpObj, int keyindex, char** lpKeyEncoded, int* lenKeyEncoded);
int ipworksopenpgp_ppop_setkeyencoded(void* lpObj, int keyindex, const char* lpKeyEncoded, int lenKeyEncoded);

char* ipworksopenpgp_ppop_getkeykeyring(void* lpObj, int keyindex);
int ipworksopenpgp_ppop_setkeykeyring(void* lpObj, int keyindex, const char* lpszKeyKeyring);

char* ipworksopenpgp_ppop_getkeypassphrase(void* lpObj, int keyindex);
int ipworksopenpgp_ppop_setkeypassphrase(void* lpObj, int keyindex, const char* lpszKeyPassphrase);

char* ipworksopenpgp_ppop_getkeyuserid(void* lpObj, int keyindex);
int ipworksopenpgp_ppop_setkeyuserid(void* lpObj, int keyindex, const char* lpszKeyUserId);

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

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

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

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

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

Remarks

This collection holds keys that are used for signing and decrypting. In most cases only one key will be specified, however multiple keys may be needed in some cases.

This property is not available at design time.

Data Type

IPWorksOpenPGPKey

LastReply Property (PPOP Class)

This property indicates the last reply received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastReply();

Unicode (Windows)
LPWSTR GetLastReply();

char* ipworksopenpgp_ppop_getlastreply(void* lpObj);

QString GetLastReply();

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalHost Property (PPOP 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_ppop_getlocalhost(void* lpObj);
int ipworksopenpgp_ppop_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MailPort Property (PPOP Class)

This property includes the server port for POP (default 110).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailPort();
int SetMailPort(int iMailPort);

Unicode (Windows)
INT GetMailPort();
INT SetMailPort(INT iMailPort);

int ipworksopenpgp_ppop_getmailport(void* lpObj);
int ipworksopenpgp_ppop_setmailport(void* lpObj, int iMailPort);

int GetMailPort();
int SetMailPort(int iMailPort);

Default Value

110

Remarks

This property contains the server port for POP (default 110). 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 Secure Sockets Layer (SSL), use port 995 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

MailServer Property (PPOP Class)

This property includes the name or address of a mail server (internet post office server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailServer();
int SetMailServer(const char* lpszMailServer);

Unicode (Windows)
LPWSTR GetMailServer();
INT SetMailServer(LPCWSTR lpszMailServer);

char* ipworksopenpgp_ppop_getmailserver(void* lpObj);
int ipworksopenpgp_ppop_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 the domain name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

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.

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

MaxLines Property (PPOP Class)

This property includes the maximum number of message lines other than headers to retrieve.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMaxLines();
int SetMaxLines(int iMaxLines);

Unicode (Windows)
INT GetMaxLines();
INT SetMaxLines(INT iMaxLines);

int ipworksopenpgp_ppop_getmaxlines(void* lpObj);
int ipworksopenpgp_ppop_setmaxlines(void* lpObj, int iMaxLines);

int GetMaxLines();
int SetMaxLines(int iMaxLines);

Default Value

0

Remarks

This property is used to limit the number of text lines other than headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.

The default value of the property is 0. In this case, the entire message will be retrieved, without interruptions. Note: If you are not retrieving the entire message (MaxLines is nonzero), no data will be written to LocalFile.

Data Type

Integer

Message Property (PPOP Class)

This property provides the raw message content.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessage(char* &lpMessage, int &lenMessage);

Unicode (Windows)
INT GetMessage(LPSTR &lpMessage, INT &lenMessage);

int ipworksopenpgp_ppop_getmessage(void* lpObj, char** lpMessage, int* lenMessage);

QByteArray GetMessage();

Default Value

""

Remarks

This property is populated after calling Retrieve and holds the raw message content. This can be used to access the data before any processing is done by the class.

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

Data Type

Binary String

MessageCc Property (PPOP Class)

This property includes the value of the CC header of the last retrieved message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageCc();

Unicode (Windows)
LPWSTR GetMessageCc();

char* ipworksopenpgp_ppop_getmessagecc(void* lpObj);

QString GetMessageCc();

Default Value

""

Remarks

This property contains the value of the CC header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageCount Property (PPOP Class)

This property includes the number of messages in the mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageCount();

Unicode (Windows)
INT GetMessageCount();

int ipworksopenpgp_ppop_getmessagecount(void* lpObj);

int GetMessageCount();

Default Value

0

Remarks

This property contains the number of messages in the mailbox. When the class is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mailbox as reported by the POP server.

This property is read-only.

Data Type

Integer

MessageDate Property (PPOP Class)

This property includes the value of the date header of the last retrieved message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageDate();

Unicode (Windows)
LPWSTR GetMessageDate();

char* ipworksopenpgp_ppop_getmessagedate(void* lpObj);

QString GetMessageDate();

Default Value

""

Remarks

This property contains the value of the date header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageFrom Property (PPOP Class)

This property includes the value of the from header of the last retrieved message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageFrom();

Unicode (Windows)
LPWSTR GetMessageFrom();

char* ipworksopenpgp_ppop_getmessagefrom(void* lpObj);

QString GetMessageFrom();

Default Value

""

Remarks

This property contains the value of the from header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageHeaders Property (PPOP Class)

This property includes a collection of the message headers as retrieved from the server.

Syntax

• C++
• C
• Qt

IPWorksOpenPGPList<IPWorksOpenPGPHeader>* GetMessageHeaders();

int ipworksopenpgp_ppop_getmessageheadercount(void* lpObj);

char* ipworksopenpgp_ppop_getmessageheaderfield(void* lpObj, int messageheaderindex);

char* ipworksopenpgp_ppop_getmessageheadervalue(void* lpObj, int messageheaderindex);

int GetMessageHeaderCount();

QString GetMessageHeaderField(int iMessageHeaderIndex);

QString GetMessageHeaderValue(int iMessageHeaderIndex);

Remarks

This property contains a collection of the message headers as retrieved from the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty collection. Otherwise, it contains a parsed collection of the full headers of the mail message as reported by the server.

The MailServer is asked about the headers of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

This property is read-only.

Data Type

IPWorksOpenPGPHeader

MessageHeadersString Property (PPOP Class)

This property includes a string representation of the full headers of the message as retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHeadersString();

Unicode (Windows)
LPWSTR GetMessageHeadersString();

char* ipworksopenpgp_ppop_getmessageheadersstring(void* lpObj);

QString GetMessageHeadersString();

Default Value

""

Remarks

This property contains a string representation of the full headers of the message as retrieved from the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the full headers of the mail message as reported by the server.

The MailServer is asked about the headers of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeadersString = POPControl.MessageHeadersString

This property is read-only.

Data Type

String

MessageNumber Property (PPOP Class)

This property includes the current (selected) message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageNumber();
int SetMessageNumber(int iMessageNumber);

Unicode (Windows)
INT GetMessageNumber();
INT SetMessageNumber(INT iMessageNumber);

int ipworksopenpgp_ppop_getmessagenumber(void* lpObj);
int ipworksopenpgp_ppop_setmessagenumber(void* lpObj, int iMessageNumber);

int GetMessageNumber();
int SetMessageNumber(int iMessageNumber);

Default Value

1

Remarks

This property indicates the current (selected) message. This property specifies a message number in between 1 and MessageCount. The various class methods related to single messages use this property as a message pointer (see method descriptions and the QueryMessageSize method).

Data Type

Integer

MessageRecipients Property (PPOP Class)

This property includes a collection of recipients for the current message.

Syntax

• C++
• C
• Qt

IPWorksOpenPGPList<IPWorksOpenPGPMessageRecipient>* GetMessageRecipients();

int ipworksopenpgp_ppop_getmessagerecipientcount(void* lpObj);

char* ipworksopenpgp_ppop_getmessagerecipientaddress(void* lpObj, int recipientindex);

char* ipworksopenpgp_ppop_getmessagerecipientname(void* lpObj, int recipientindex);

char* ipworksopenpgp_ppop_getmessagerecipientoptions(void* lpObj, int recipientindex);

int ipworksopenpgp_ppop_getmessagerecipienttype(void* lpObj, int recipientindex);

int GetMessageRecipientCount();

QString GetMessageRecipientAddress(int iRecipientIndex);

QString GetMessageRecipientName(int iRecipientIndex);

QString GetMessageRecipientOptions(int iRecipientIndex);

int GetMessageRecipientType(int iRecipientIndex);

Remarks

This property contains a collection of recipients for the current message. This collection describes all of the people to whom the last retrieved message was sent. Each MessageRecipient contains information describing that recipient, and what type of recipient it is.

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

Data Type

IPWorksOpenPGPMessageRecipient

MessageReplyTo Property (PPOP Class)

This property includes the value of the Reply-To header of the last retrieved message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageReplyTo();

Unicode (Windows)
LPWSTR GetMessageReplyTo();

char* ipworksopenpgp_ppop_getmessagereplyto(void* lpObj);

QString GetMessageReplyTo();

Default Value

""

Remarks

This property contains the value of the Reply-To header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageSubject Property (PPOP Class)

This property includes the value of the Subject header of the last retrieved message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSubject();

Unicode (Windows)
LPWSTR GetMessageSubject();

char* ipworksopenpgp_ppop_getmessagesubject(void* lpObj);

QString GetMessageSubject();

Default Value

""

Remarks

This property contains the value of the Subject header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

MessageText Property (PPOP Class)

This property includes the full text of the message as retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageText();

Unicode (Windows)
LPWSTR GetMessageText();

char* ipworksopenpgp_ppop_getmessagetext(void* lpObj);

QString GetMessageText();

Default Value

""

Remarks

This property contains the full text of the message as retrieved from the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the text of the mail message as reported by the server (a maximum of MaxLines).

The MailServer is asked about the text of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

This property is read-only.

Data Type

String

MessageTo Property (PPOP Class)

This property includes the value of the To header of the last retrieved message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageTo();

Unicode (Windows)
LPWSTR GetMessageTo();

char* ipworksopenpgp_ppop_getmessageto(void* lpObj);

QString GetMessageTo();

Default Value

""

Remarks

This property contains the value of the To header of the last retrieved message. The same information also may be retrieved through the Header event.

This property is read-only.

Data Type

String

Password Property (PPOP Class)

This property includes the password for the mailbox user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksopenpgp_ppop_getpassword(void* lpObj);
int ipworksopenpgp_ppop_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property contains the password for the mailbox user. This property must be set before the class connects to the MailServer.

Data Type

String

SignerKeys Property (PPOP Class)

The collection of keys belonging to the signer of the message.

Syntax

• C++
• C
• Qt

IPWorksOpenPGPList<IPWorksOpenPGPKey>* GetSignerKeys();
int SetSignerKeys(IPWorksOpenPGPList<IPWorksOpenPGPKey>* val);

int ipworksopenpgp_ppop_getsignerkeycount(void* lpObj);
int ipworksopenpgp_ppop_setsignerkeycount(void* lpObj, int iSignerKeyCount);

int ipworksopenpgp_ppop_getsignerkeyencoded(void* lpObj, int signerkeyindex, char** lpSignerKeyEncoded, int* lenSignerKeyEncoded);
int ipworksopenpgp_ppop_setsignerkeyencoded(void* lpObj, int signerkeyindex, const char* lpSignerKeyEncoded, int lenSignerKeyEncoded);

char* ipworksopenpgp_ppop_getsignerkeykeyring(void* lpObj, int signerkeyindex);
int ipworksopenpgp_ppop_setsignerkeykeyring(void* lpObj, int signerkeyindex, const char* lpszSignerKeyKeyring);

char* ipworksopenpgp_ppop_getsignerkeyuserid(void* lpObj, int signerkeyindex);
int ipworksopenpgp_ppop_setsignerkeyuserid(void* lpObj, int signerkeyindex, const char* lpszSignerKeyUserId);

int GetSignerKeyCount();
int SetSignerKeyCount(int iSignerKeyCount);

QByteArray GetSignerKeyEncoded(int iSignerKeyIndex);
int SetSignerKeyEncoded(int iSignerKeyIndex, QByteArray qbaSignerKeyEncoded);

QString GetSignerKeyKeyring(int iSignerKeyIndex);
int SetSignerKeyKeyring(int iSignerKeyIndex, QString qsSignerKeyKeyring);

QString GetSignerKeyUserId(int iSignerKeyIndex);
int SetSignerKeyUserId(int iSignerKeyIndex, QString qsSignerKeyUserId);

Remarks

This property contains the keys of the message signer.

Set this property before calling VerifySignature or DecryptAndVerifySignature.

This property is not available at design time.

Data Type

IPWorksOpenPGPKey

SSLAcceptServerCert Property (PPOP Class)

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

Syntax

• C++
• C
• Qt

IPWorksOpenPGPCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksOpenPGPCertificate* val);

char* ipworksopenpgp_ppop_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertissuer(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertprivatekey(void* lpObj);

int ipworksopenpgp_ppop_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertpublickey(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksopenpgp_ppop_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksopenpgp_ppop_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksopenpgp_ppop_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksopenpgp_ppop_getsslacceptservercertstorepassword(void* lpObj);
int ipworksopenpgp_ppop_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksopenpgp_ppop_getsslacceptservercertstoretype(void* lpObj);
int ipworksopenpgp_ppop_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksopenpgp_ppop_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertusage(void* lpObj);

int ipworksopenpgp_ppop_getsslacceptservercertusageflags(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertversion(void* lpObj);

char* ipworksopenpgp_ppop_getsslacceptservercertsubject(void* lpObj);
int ipworksopenpgp_ppop_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksopenpgp_ppop_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksopenpgp_ppop_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksOpenPGPCertificate

SSLCert Property (PPOP Class)

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

Syntax

• C++
• C
• Qt

IPWorksOpenPGPCertificate* GetSSLCert();
int SetSSLCert(IPWorksOpenPGPCertificate* val);

char* ipworksopenpgp_ppop_getsslcerteffectivedate(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertexpirationdate(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertextendedkeyusage(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertfingerprint(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertfingerprintsha1(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertfingerprintsha256(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertissuer(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertprivatekey(void* lpObj);

int ipworksopenpgp_ppop_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertpublickey(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksopenpgp_ppop_getsslcertpublickeylength(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertserialnumber(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertsignaturealgorithm(void* lpObj);

int ipworksopenpgp_ppop_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksopenpgp_ppop_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksopenpgp_ppop_getsslcertstorepassword(void* lpObj);
int ipworksopenpgp_ppop_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksopenpgp_ppop_getsslcertstoretype(void* lpObj);
int ipworksopenpgp_ppop_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksopenpgp_ppop_getsslcertsubjectaltnames(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertthumbprintmd5(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertthumbprintsha1(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertthumbprintsha256(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertusage(void* lpObj);

int ipworksopenpgp_ppop_getsslcertusageflags(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertversion(void* lpObj);

char* ipworksopenpgp_ppop_getsslcertsubject(void* lpObj);
int ipworksopenpgp_ppop_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksopenpgp_ppop_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksopenpgp_ppop_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksOpenPGPCertificate

SSLEnabled Property (PPOP Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (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_ppop_getsslenabled(void* lpObj);
int ipworksopenpgp_ppop_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (PPOP Class)

The Secure Sockets Layer/Transport Layer Security (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_ppop_getsslprovider(void* lpObj);
int ipworksopenpgp_ppop_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (PPOP Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksOpenPGPCertificate* GetSSLServerCert();

char* ipworksopenpgp_ppop_getsslservercerteffectivedate(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertexpirationdate(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertfingerprint(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertissuer(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertprivatekey(void* lpObj);

int ipworksopenpgp_ppop_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertpublickey(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksopenpgp_ppop_getsslservercertpublickeylength(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertserialnumber(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksopenpgp_ppop_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksopenpgp_ppop_getsslservercertstorepassword(void* lpObj);

int ipworksopenpgp_ppop_getsslservercertstoretype(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertusage(void* lpObj);

int ipworksopenpgp_ppop_getsslservercertusageflags(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertversion(void* lpObj);

char* ipworksopenpgp_ppop_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksOpenPGPCertificate

SSLStartMode Property (PPOP Class)

This property determines how the class starts the Secure Sockets Layer (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_ppop_getsslstartmode(void* lpObj);
int ipworksopenpgp_ppop_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

Timeout Property (PPOP Class)

The 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_ppop_gettimeout(void* lpObj);
int ipworksopenpgp_ppop_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (PPOP Class)

This property includes the user identifier for the mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksopenpgp_ppop_getuser(void* lpObj);
int ipworksopenpgp_ppop_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property contains the user identifier for the mailbox. This property must be set before the class connects to the MailServer.

Data Type

String

Config Method (PPOP 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_ppop_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 (PPOP Class)

This method connects to the mail server and attempts to log in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksopenpgp_ppop_connect(void* lpObj);

int Connect();

Remarks

This method connects to the mail server and attempts to log in using the current User and Password. Then it retrieves the initial statistics about the mailbox contents (MessageCount and QueryTotalSize).

Example. Connect to POP Mailbox:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve() MessageText = POPControl.MessageText MessageHeaders = POPControl.MessageHeaders

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

Decrypt Method (PPOP Class)

Decrypts the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworksopenpgp_ppop_decrypt(void* lpObj);

int Decrypt();

Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

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

DecryptAndVerifySignature Method (PPOP Class)

Decrypts and verifies the signature of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptAndVerifySignature();

Unicode (Windows)
INT DecryptAndVerifySignature();

int ipworksopenpgp_ppop_decryptandverifysignature(void* lpObj);

int DecryptAndVerifySignature();

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.

This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the class will perform the decryption without error.

The message will be decrypted using the keys specified in Keys. Before decryption begins the class will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the class fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

NOTE: This method does not attempt to check the validity of the signing key itself.

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

Delete Method (PPOP Class)

This method deletes a message specified by MessageNumber on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int ipworksopenpgp_ppop_delete(void* lpObj);

int Delete();

Remarks

This method asks the MailServer to delete the message specified by MessageNumber. The message will not actually be deleted from the server until the connection is closed. To cancel a previous Delete, use the Reset method.

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 (PPOP Class)

This method disconnects from the mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksopenpgp_ppop_disconnect(void* lpObj);

int Disconnect();

Remarks

This method makes the class disconnect from the MailServer by sending the QUIT command. If successful, all changes to the mailbox are committed by the server. Otherwise, changes are rolled back to the initial state that the server was in before the connection.

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 (PPOP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

Interrupt Method (PPOP Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

ListMessageSizes Method (PPOP Class)

This method retrieves a list of all message sizes from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMessageSizes();

Unicode (Windows)
INT ListMessageSizes();

int ipworksopenpgp_ppop_listmessagesizes(void* lpObj);

int ListMessageSizes();

Remarks

This message retrieves a list of all message sizes from the server. For each message listed, a MessageList event will fire containing the number and size of the message.

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

ListMessageUIDs Method (PPOP Class)

This method retrieves a list of all message UIDs from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMessageUIDs();

Unicode (Windows)
INT ListMessageUIDs();

int ipworksopenpgp_ppop_listmessageuids(void* lpObj);

int ListMessageUIDs();

Remarks

This method retrieves a list of all message UIDs from the server. For each message listed, a MessageList event will fire containing the number and UID of the message.

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

LocalizeDate Method (PPOP Class)

This method converts a valid RFC 822 message date to a local date and time.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* LocalizeDate(const char* lpszDateTime);

Unicode (Windows)
LPWSTR LocalizeDate(LPCWSTR lpszDateTime);

char* ipworksopenpgp_ppop_localizedate(void* lpObj, const char* lpszDateTime);

QString LocalizeDate(const QString& qsDateTime);

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

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.

QueryMessageSize Method (PPOP Class)

This method returns the size in bytes of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 QueryMessageSize();

Unicode (Windows)
LONG64 QueryMessageSize();

int64 ipworksopenpgp_ppop_querymessagesize(void* lpObj);

qint64 QueryMessageSize();

Remarks

This method queries the server for the size in bytes of the message specified by MessageNumber. The method returns the size (in bytes) of the message.

If the class is not connected, or MessageNumber does not contain a valid message number, the return value is 0. Otherwise, it returns the size of the mail message (including headers) as reported by the server.

The MailServer is asked about the size of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

Error Handling (C++)

This method returns a Long64 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.

QueryMessageUID Method (PPOP Class)

This method returns the unique identifier (UID) of the message as specified by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* QueryMessageUID();

Unicode (Windows)
LPWSTR QueryMessageUID();

char* ipworksopenpgp_ppop_querymessageuid(void* lpObj);

QString QueryMessageUID();

Remarks

This method returns the unique identifier (UID) of the message specified by MessageNumber. If the class is not connected, or MessageNumber does not contain a valid message number, the return value of this method is an empty string. Otherwise, it returns the UID of the mail message as reported by the server.

The MailServer is asked about the UID of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.

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.

QueryTotalSize Method (PPOP Class)

This method returns the cumulative size in bytes of messages in the mailbox (including headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 QueryTotalSize();

Unicode (Windows)
LONG64 QueryTotalSize();

int64 ipworksopenpgp_ppop_querytotalsize(void* lpObj);

qint64 QueryTotalSize();

Remarks

This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the class is not connected to the server, the return value of this method is 0. When connected, it returns the cumulative size of all the messages in the mail box as reported by the POP server.

Error Handling (C++)

This method returns a Long64 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.

Reset Method (PPOP Class)

This method resets all changes and revert back to the state when the user first connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksopenpgp_ppop_reset(void* lpObj);

int Reset();

Remarks

This method is used to reset all changes and revert back to the state when the user first connected. Asks the MailServer to reset all changes and revert back to the state it was when connected.

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

Retrieve Method (PPOP Class)

This method retrieves a message specified by MessageNumber from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Retrieve();

Unicode (Windows)
INT Retrieve();

int ipworksopenpgp_ppop_retrieve(void* lpObj);

int Retrieve();

Remarks

This method is used to retrieve a message specified by MessageNumber from the server. It asks the MailServer to retrieve the message specified by MessageNumber. The message headers will arrive in the Header event, and the message text will arrive in the Transfer event.

The MaxLines property defines the number of lines retrieved.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve()

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

RetrieveHeaders Method (PPOP Class)

This method retrieves headers for a message specified by MessageNumber .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveHeaders();

Unicode (Windows)
INT RetrieveHeaders();

int ipworksopenpgp_ppop_retrieveheaders(void* lpObj);

int RetrieveHeaders();

Remarks

Calling this method will retrieve the headers for the message specified by the MessageNumber property. The message headers will be provided by the Header event and also stored in the MessageHeaders property.

Example. Connect and Retrieve Message Headers:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.RetrieveHeaders()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCommand Method (PPOP Class)

This method sends the exact command directly to the server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);

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

int SendCommand(const QString& qsCommand);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetMessageStream Method (PPOP Class)

This method sets the stream to which the message downloaded from the server will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetMessageStream(IPWorksOpenPGPStream* sMessageStream);

Unicode (Windows)
INT SetMessageStream(IPWorksOpenPGPStream* sMessageStream);

int ipworksopenpgp_ppop_setmessagestream(void* lpObj, IPWorksOpenPGPStream* sMessageStream);

int SetMessageStream(IPWorksOpenPGPStream* sMessageStream);

Remarks

This method sets the stream to which the message downloaded from the server will be written. If a download stream is set before the Retrieve method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is set to True (default). If the stream is closed, you will need to call SetMessageStream again before calling Retrieve again. The downloaded content will be written starting at the current position in the stream.

Note: SetMessageStream and LocalFile will reset the other.

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

VerifySignature Method (PPOP Class)

Verifies the signature of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworksopenpgp_ppop_verifysignature(void* lpObj);

int VerifySignature();

Remarks

This method verifies the signature of the message.

The message will be verified using the keys specified in SignerKeys. Before verification begins the class will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the class fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

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 (PPOP Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(PPOPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} PPOPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(PPOPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} PPOPConnectionStatusEventParams;

#define EID_PPOP_CONNECTIONSTATUS 1

virtual INT IPWORKSOPENPGP_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class PPOPConnectionStatusEventParams {
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(PPOPConnectionStatusEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireConnectionStatus(PPOPConnectionStatusEventParams *e) {...}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

EndTransfer Event (PPOP Class)

This event is fired when the message completes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(PPOPEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} PPOPEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(PPOPEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} PPOPEndTransferEventParams;

#define EID_PPOP_ENDTRANSFER 2

virtual INT IPWORKSOPENPGP_CALL FireEndTransfer(INT &iDirection);

class PPOPEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(PPOPEndTransferEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireEndTransfer(PPOPEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the message body completes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (PPOP Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PPOPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PPOPErrorEventParams;


Unicode (Windows)
virtual INT FireError(PPOPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PPOPErrorEventParams;

#define EID_PPOP_ERROR 3

virtual INT IPWORKSOPENPGP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PPOPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PPOPErrorEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireError(PPOPErrorEventParams *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.

Header Event (PPOP Class)

This event is fired for every message header being retrieved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(PPOPHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} PPOPHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(PPOPHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} PPOPHeaderEventParams;

#define EID_PPOP_HEADER 4

virtual INT IPWORKSOPENPGP_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class PPOPHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(PPOPHeaderEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireHeader(PPOPHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the header (in the same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

KeyPassphrase Event (PPOP Class)

Fired if the passphrase of current key is incorrect or empty.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PPOP_KEYPASSPHRASE 5

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

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

  const QString &KeyId();

  const QString &Fingerprint();

  const QString &Passphrase();
  void SetPassphrase(const QString &qsPassphrase);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void KeyPassphrase(PPOPKeyPassphraseEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireKeyPassphrase(PPOPKeyPassphraseEventParams *e) {...}

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the Passphrase field before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

UserId holds the user Id of the key the passphrase is required for.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

MessageList Event (PPOP Class)

This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageList(PPOPMessageListEventParams *e);

typedef struct {
  int MessageNumber;
  const char *MessageUID;
  int MessageSize;
  int reserved;
} PPOPMessageListEventParams;


Unicode (Windows)
virtual INT FireMessageList(PPOPMessageListEventParams *e);

typedef struct {
  INT MessageNumber;
  LPCWSTR MessageUID;
  INT MessageSize;
  INT reserved;
} PPOPMessageListEventParams;

#define EID_PPOP_MESSAGELIST 6

virtual INT IPWORKSOPENPGP_CALL FireMessageList(INT &iMessageNumber, LPSTR &lpszMessageUID, INT &iMessageSize);

class PPOPMessageListEventParams {
public:
  int MessageNumber();

  const QString &MessageUID();

  int MessageSize();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageList(PPOPMessageListEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireMessageList(PPOPMessageListEventParams *e) {...}

Remarks

When ListMessageSizes is called, MessageSize is valid, and MessageUID is always an empty string.

When ListMessageUIDs is called, MessageUID is valid, and MessageSize is 0.

PITrail Event (PPOP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(PPOPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Message;
  int reserved;
} PPOPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(PPOPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Message;
  INT reserved;
} PPOPPITrailEventParams;

#define EID_PPOP_PITRAIL 7

virtual INT IPWORKSOPENPGP_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);

class PPOPPITrailEventParams {
public:
  int Direction();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(PPOPPITrailEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FirePITrail(PPOPPITrailEventParams *e) {...}

Remarks

The PITrail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

Progress Event (PPOP Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(PPOPProgressEventParams *e);

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} PPOPProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(PPOPProgressEventParams *e);

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} PPOPProgressEventParams;

#define EID_PPOP_PROGRESS 8

virtual INT IPWORKSOPENPGP_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);

class PPOPProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(PPOPProgressEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireProgress(PPOPProgressEventParams *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.

RecipientInfo Event (PPOP Class)

Fired for each recipient key of the encrypted message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientInfo(PPOPRecipientInfoEventParams *e);

typedef struct {
  const char *KeyId;
  const char *Fingerprint;
  const char *PublicKeyAlgorithm;
  int reserved;
} PPOPRecipientInfoEventParams;


Unicode (Windows)
virtual INT FireRecipientInfo(PPOPRecipientInfoEventParams *e);

typedef struct {
  LPCWSTR KeyId;
  LPCWSTR Fingerprint;
  LPCWSTR PublicKeyAlgorithm;
  INT reserved;
} PPOPRecipientInfoEventParams;

#define EID_PPOP_RECIPIENTINFO 9

virtual INT IPWORKSOPENPGP_CALL FireRecipientInfo(LPSTR &lpszKeyId, LPSTR &lpszFingerprint, LPSTR &lpszPublicKeyAlgorithm);

class PPOPRecipientInfoEventParams {
public:
  const QString &KeyId();

  const QString &Fingerprint();

  const QString &PublicKeyAlgorithm();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RecipientInfo(PPOPRecipientInfoEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireRecipientInfo(PPOPRecipientInfoEventParams *e) {...}

Remarks

This event fires when the Decrypt or DecryptAndVerifySignature method is called.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in Keys. Keys can be set from within this event as this event fires directly before the decryption process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

PublicKeyAlgorithm is the algorithm of the public key used to encrypt the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

SignatureInfo Event (PPOP Class)

Fired during verification of the signed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureInfo(PPOPSignatureInfoEventParams *e);

typedef struct {
  const char *KeyId;
  const char *Fingerprint;
  const char *SigningAlgorithm;
  const char *PublicKeyAlgorithm;
  int reserved;
} PPOPSignatureInfoEventParams;


Unicode (Windows)
virtual INT FireSignatureInfo(PPOPSignatureInfoEventParams *e);

typedef struct {
  LPCWSTR KeyId;
  LPCWSTR Fingerprint;
  LPCWSTR SigningAlgorithm;
  LPCWSTR PublicKeyAlgorithm;
  INT reserved;
} PPOPSignatureInfoEventParams;

#define EID_PPOP_SIGNATUREINFO 10

virtual INT IPWORKSOPENPGP_CALL FireSignatureInfo(LPSTR &lpszKeyId, LPSTR &lpszFingerprint, LPSTR &lpszSigningAlgorithm, LPSTR &lpszPublicKeyAlgorithm);

class PPOPSignatureInfoEventParams {
public:
  const QString &KeyId();

  const QString &Fingerprint();

  const QString &SigningAlgorithm();

  const QString &PublicKeyAlgorithm();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureInfo(PPOPSignatureInfoEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireSignatureInfo(PPOPSignatureInfoEventParams *e) {...}

Remarks

This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in SignerKeys. SignerKeys can be set from within this event as this event fires directly before the verification process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:

• SHA1
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

SSLServerAuthentication Event (PPOP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(PPOPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} PPOPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(PPOPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} PPOPSSLServerAuthenticationEventParams;

#define EID_PPOP_SSLSERVERAUTHENTICATION 11

virtual INT IPWORKSOPENPGP_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class PPOPSSLServerAuthenticationEventParams {
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(PPOPSSLServerAuthenticationEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireSSLServerAuthentication(PPOPSSLServerAuthenticationEventParams *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 (PPOP Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(PPOPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} PPOPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(PPOPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} PPOPSSLStatusEventParams;

#define EID_PPOP_SSLSTATUS 12

virtual INT IPWORKSOPENPGP_CALL FireSSLStatus(LPSTR &lpszMessage);

class PPOPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(PPOPSSLStatusEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireSSLStatus(PPOPSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (PPOP Class)

This event is fired when the message starts transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(PPOPStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} PPOPStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(PPOPStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} PPOPStartTransferEventParams;

#define EID_PPOP_STARTTRANSFER 13

virtual INT IPWORKSOPENPGP_CALL FireStartTransfer(INT &iDirection);

class PPOPStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(PPOPStartTransferEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireStartTransfer(PPOPStartTransferEventParams *e) {...}

Remarks

The StartTransfer event is fired when the message body starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (PPOP Class)

Shows the progress of the operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(PPOPStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} PPOPStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(PPOPStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} PPOPStatusEventParams;

#define EID_PPOP_STATUS 14

virtual INT IPWORKSOPENPGP_CALL FireStatus(LPSTR &lpszMessage);

class PPOPStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(PPOPStatusEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireStatus(PPOPStatusEventParams *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 (PPOP Class)

This event is fired when the message is transferred from MailServer .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(PPOPTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int EOL;
  int reserved;
} PPOPTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(PPOPTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  BOOL EOL;
  INT reserved;
} PPOPTransferEventParams;

#define EID_PPOP_TRANSFER 15

virtual INT IPWORKSOPENPGP_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bEOL);

class PPOPTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  bool EOL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(PPOPTransferEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireTransfer(PPOPTransferEventParams *e) {...}

Remarks

The Text parameter contains the portion of the message data to be retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last Transfer event is fired), BytesTransferred equals the value of the QueryMessageSize method.

The Transfer event is fired for every line of the message. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event to check the progress rather than to get the actual data.

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.

Note: For the PercentDone parameter value to be correct, the GetMessageSize configuration setting must be set to True.

VerificationStatus Event (PPOP Class)

Fired after verification of the signed message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireVerificationStatus(PPOPVerificationStatusEventParams *e);

typedef struct {
  const char *KeyId;
  const char *Fingerprint;
  int Status;
  int reserved;
} PPOPVerificationStatusEventParams;


Unicode (Windows)
virtual INT FireVerificationStatus(PPOPVerificationStatusEventParams *e);

typedef struct {
  LPCWSTR KeyId;
  LPCWSTR Fingerprint;
  INT Status;
  INT reserved;
} PPOPVerificationStatusEventParams;

#define EID_PPOP_VERIFICATIONSTATUS 16

virtual INT IPWORKSOPENPGP_CALL FireVerificationStatus(LPSTR &lpszKeyId, LPSTR &lpszFingerprint, INT &iStatus);

class PPOPVerificationStatusEventParams {
public:
  const QString &KeyId();

  const QString &Fingerprint();

  int Status();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void VerificationStatus(PPOPVerificationStatusEventParams *e);

// Or, subclass PPOP and override this emitter function.
virtual int FireVerificationStatus(PPOPVerificationStatusEventParams *e) {...}

Remarks

This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Status holds the result of the operation. Possible values are:

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksOpenPGPCertificate (declared in ipworksopenpgp.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksOpenPGPFirewall (declared in ipworksopenpgp.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

Header Type

This is an HTTP header as it is received from the server.

Syntax

IPWorksOpenPGPHeader (declared in ipworksopenpgp.h)

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

Header()

Header(const char* lpszField, const char* lpszValue)

Key Type

The OpenPGP key being used.

Syntax

IPWorksOpenPGPKey (declared in ipworksopenpgp.h)

Remarks

This type describes the current key. The key may be a public or secret key. The fields are used to identify or select the key.

Fields

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

5E70662EA810E768

FirstName LastName (Comment) <Email>

MessageRecipient Type

This types describes the message recipient.

Syntax

IPWorksOpenPGPMessageRecipient (declared in ipworksopenpgp.h)

Remarks

This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the class is sending the message.

Fields

Constructors

MessageRecipient()

MessageRecipient(const char* lpszAddress)

IPWorksOpenPGPList Type

Syntax

IPWorksOpenPGPList<T> (declared in ipworksopenpgp.h)

Remarks

IPWorksOpenPGPList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the PPOP class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

IPWorksOpenPGPStream Type

Syntax

IPWorksOpenPGPStream (declared in ipworksopenpgp.h)

Remarks

The PPOP 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 PPOP 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 (PPOP Class)

PPOP Config Settings

POP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings