SPOP Class

Properties   Methods   Events   Config Settings   Errors  

The SPOP Class is used to easily retrieve electronic mail from internet post office servers (POP).

Syntax

SPOP

Remarks

The SPOP Class is the S/MIME-enabled equivalent of the IPWorks POP Class. In addition to standard POP functions, the SPOP class can decrypt and verify message signatures. The methods and properties for decrypting and verifying signatures are identical to those provided with the S/MIME Class. When attempting to verify a signed message or when decrypting a message call, the Decrypt, VerifySignature, or DecryptAndVerifySignature methods and the resulting text will be replaced in Message.

The SPOP Class implements a standard internet post office (POP3) client as specified in RFC 1725.

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 headers are received by calling the Retrieve method.

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 body of the message is also saved in the file specified by the LocalFile property. 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).

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 (SPOP 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 ipworkssmime_spop_getauthmechanism(void* lpObj);
int ipworkssmime_spop_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

Certificate Property (SPOP Class)

This property includes the current selected certificate.

Syntax

• C++
• C
• Qt

IPWorksSMIMECertificate* GetCertificate();
int SetCertificate(IPWorksSMIMECertificate* val);

char* ipworkssmime_spop_getcerteffectivedate(void* lpObj);

char* ipworkssmime_spop_getcertexpirationdate(void* lpObj);

char* ipworkssmime_spop_getcertextendedkeyusage(void* lpObj);

char* ipworkssmime_spop_getcertfingerprint(void* lpObj);

char* ipworkssmime_spop_getcertfingerprintsha1(void* lpObj);

char* ipworkssmime_spop_getcertfingerprintsha256(void* lpObj);

char* ipworkssmime_spop_getcertissuer(void* lpObj);

char* ipworkssmime_spop_getcertprivatekey(void* lpObj);

int ipworkssmime_spop_getcertprivatekeyavailable(void* lpObj);

char* ipworkssmime_spop_getcertprivatekeycontainer(void* lpObj);

char* ipworkssmime_spop_getcertpublickey(void* lpObj);

char* ipworkssmime_spop_getcertpublickeyalgorithm(void* lpObj);

int ipworkssmime_spop_getcertpublickeylength(void* lpObj);

char* ipworkssmime_spop_getcertserialnumber(void* lpObj);

char* ipworkssmime_spop_getcertsignaturealgorithm(void* lpObj);

int ipworkssmime_spop_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworkssmime_spop_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

char* ipworkssmime_spop_getcertstorepassword(void* lpObj);
int ipworkssmime_spop_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

int ipworkssmime_spop_getcertstoretype(void* lpObj);
int ipworkssmime_spop_setcertstoretype(void* lpObj, int iCertStoreType);

char* ipworkssmime_spop_getcertsubjectaltnames(void* lpObj);

char* ipworkssmime_spop_getcertthumbprintmd5(void* lpObj);

char* ipworkssmime_spop_getcertthumbprintsha1(void* lpObj);

char* ipworkssmime_spop_getcertthumbprintsha256(void* lpObj);

char* ipworkssmime_spop_getcertusage(void* lpObj);

int ipworkssmime_spop_getcertusageflags(void* lpObj);

char* ipworkssmime_spop_getcertversion(void* lpObj);

char* ipworkssmime_spop_getcertsubject(void* lpObj);
int ipworkssmime_spop_setcertsubject(void* lpObj, const char* lpszCertSubject);

int ipworkssmime_spop_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworkssmime_spop_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QString GetCertEffectiveDate();

QString GetCertExpirationDate();

QString GetCertExtendedKeyUsage();

QString GetCertFingerprint();

QString GetCertFingerprintSHA1();

QString GetCertFingerprintSHA256();

QString GetCertIssuer();

QString GetCertPrivateKey();

bool GetCertPrivateKeyAvailable();

QString GetCertPrivateKeyContainer();

QString GetCertPublicKey();

QString GetCertPublicKeyAlgorithm();

int GetCertPublicKeyLength();

QString GetCertSerialNumber();

QString GetCertSignatureAlgorithm();

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

QString GetCertSubjectAltNames();

QString GetCertThumbprintMD5();

QString GetCertThumbprintSHA1();

QString GetCertThumbprintSHA256();

QString GetCertUsage();

int GetCertUsageFlags();

QString GetCertVersion();

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Remarks

This property is populated when a specified certificate is found or loaded by the class. This property is used to specify private keys. Set this property to a valid Certificate object to perform different operations, such as Sign, Decrypt, SignAndEncrypt, or DecryptAndVerifySignature.

Data Type

IPWorksSMIMECertificate

Connected Property (SPOP Class)

This property shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworkssmime_spop_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 (SPOP Class)

This property includes a set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int ipworkssmime_spop_getfirewallautodetect(void* lpObj);
int ipworkssmime_spop_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworkssmime_spop_getfirewalltype(void* lpObj);
int ipworkssmime_spop_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworkssmime_spop_getfirewallhost(void* lpObj);
int ipworkssmime_spop_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworkssmime_spop_getfirewallpassword(void* lpObj);
int ipworkssmime_spop_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworkssmime_spop_getfirewallport(void* lpObj);
int ipworkssmime_spop_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworkssmime_spop_getfirewalluser(void* lpObj);
int ipworkssmime_spop_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

IPWorksSMIMEFirewall

Idle Property (SPOP Class)

This property specifies the current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworkssmime_spop_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

IncludeHeaders Property (SPOP 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 ipworkssmime_spop_getincludeheaders(void* lpObj);
int ipworkssmime_spop_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

LastReply Property (SPOP 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* ipworkssmime_spop_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 (SPOP Class)

This property includes 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* ipworkssmime_spop_getlocalhost(void* lpObj);
int ipworkssmime_spop_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for 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 (SPOP 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 ipworkssmime_spop_getmailport(void* lpObj);
int ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_getmailserver(void* lpObj);
int ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_getmaxlines(void* lpObj);
int ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP Class)

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

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMEHeader>* GetMessageHeaders();

int ipworkssmime_spop_getmessageheadercount(void* lpObj);

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

char* ipworkssmime_spop_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

IPWorksSMIMEHeader

MessageHeadersString Property (SPOP 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* ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_getmessagenumber(void* lpObj);
int ipworkssmime_spop_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 (SPOP Class)

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

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMEMessageRecipient>* GetMessageRecipients();

int ipworkssmime_spop_getmessagerecipientcount(void* lpObj);

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

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

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

int ipworkssmime_spop_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

IPWorksSMIMEMessageRecipient

MessageReplyTo Property (SPOP 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* ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_getpassword(void* lpObj);
int ipworkssmime_spop_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

SignerCert Property (SPOP Class)

This property contains the certificate of the message signer.

Syntax

• C++
• C
• Qt

IPWorksSMIMECertificate* GetSignerCert();
int SetSignerCert(IPWorksSMIMECertificate* val);

char* ipworkssmime_spop_getsignercerteffectivedate(void* lpObj);

char* ipworkssmime_spop_getsignercertexpirationdate(void* lpObj);

char* ipworkssmime_spop_getsignercertextendedkeyusage(void* lpObj);

char* ipworkssmime_spop_getsignercertfingerprint(void* lpObj);

char* ipworkssmime_spop_getsignercertfingerprintsha1(void* lpObj);

char* ipworkssmime_spop_getsignercertfingerprintsha256(void* lpObj);

char* ipworkssmime_spop_getsignercertissuer(void* lpObj);

char* ipworkssmime_spop_getsignercertprivatekey(void* lpObj);

int ipworkssmime_spop_getsignercertprivatekeyavailable(void* lpObj);

char* ipworkssmime_spop_getsignercertprivatekeycontainer(void* lpObj);

char* ipworkssmime_spop_getsignercertpublickey(void* lpObj);

char* ipworkssmime_spop_getsignercertpublickeyalgorithm(void* lpObj);

int ipworkssmime_spop_getsignercertpublickeylength(void* lpObj);

char* ipworkssmime_spop_getsignercertserialnumber(void* lpObj);

char* ipworkssmime_spop_getsignercertsignaturealgorithm(void* lpObj);

int ipworkssmime_spop_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworkssmime_spop_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

char* ipworkssmime_spop_getsignercertstorepassword(void* lpObj);
int ipworkssmime_spop_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

int ipworkssmime_spop_getsignercertstoretype(void* lpObj);
int ipworkssmime_spop_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

char* ipworkssmime_spop_getsignercertsubjectaltnames(void* lpObj);

char* ipworkssmime_spop_getsignercertthumbprintmd5(void* lpObj);

char* ipworkssmime_spop_getsignercertthumbprintsha1(void* lpObj);

char* ipworkssmime_spop_getsignercertthumbprintsha256(void* lpObj);

char* ipworkssmime_spop_getsignercertusage(void* lpObj);

int ipworkssmime_spop_getsignercertusageflags(void* lpObj);

char* ipworkssmime_spop_getsignercertversion(void* lpObj);

char* ipworkssmime_spop_getsignercertsubject(void* lpObj);
int ipworkssmime_spop_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

int ipworkssmime_spop_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworkssmime_spop_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QString GetSignerCertEffectiveDate();

QString GetSignerCertExpirationDate();

QString GetSignerCertExtendedKeyUsage();

QString GetSignerCertFingerprint();

QString GetSignerCertFingerprintSHA1();

QString GetSignerCertFingerprintSHA256();

QString GetSignerCertIssuer();

QString GetSignerCertPrivateKey();

bool GetSignerCertPrivateKeyAvailable();

QString GetSignerCertPrivateKeyContainer();

QString GetSignerCertPublicKey();

QString GetSignerCertPublicKeyAlgorithm();

int GetSignerCertPublicKeyLength();

QString GetSignerCertSerialNumber();

QString GetSignerCertSignatureAlgorithm();

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

QString GetSignerCertSubjectAltNames();

QString GetSignerCertThumbprintMD5();

QString GetSignerCertThumbprintSHA1();

QString GetSignerCertThumbprintSHA256();

QString GetSignerCertUsage();

int GetSignerCertUsageFlags();

QString GetSignerCertVersion();

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

Remarks

This property contains the certificate of the message signer. When calling VerifySignature or DecryptAndVerifySignature, this property will contain the certificate of the sender, if attached.

To verify messages without an attached certificate, set this property before calling VerifySignature or DecryptAndVerifySignature.

Data Type

IPWorksSMIMECertificate

SignerCertChain Property (SPOP Class)

This property includes the certificate chain of the signing certificate.

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMECertificate>* GetSignerCertChain();

int ipworkssmime_spop_getsignercertchaincount(void* lpObj);

char* ipworkssmime_spop_getsignercertchaineffectivedate(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainexpirationdate(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainextendedkeyusage(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainfingerprint(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainfingerprintsha1(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainfingerprintsha256(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainissuer(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainprivatekey(void* lpObj, int signercertchainindex);

int ipworkssmime_spop_getsignercertchainprivatekeyavailable(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainprivatekeycontainer(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainpublickey(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainpublickeyalgorithm(void* lpObj, int signercertchainindex);

int ipworkssmime_spop_getsignercertchainpublickeylength(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainserialnumber(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainsignaturealgorithm(void* lpObj, int signercertchainindex);

int ipworkssmime_spop_getsignercertchainstore(void* lpObj, int signercertchainindex, char** lpSignerCertChainStore, int* lenSignerCertChainStore);

char* ipworkssmime_spop_getsignercertchainstorepassword(void* lpObj, int signercertchainindex);

int ipworkssmime_spop_getsignercertchainstoretype(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainsubjectaltnames(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainthumbprintmd5(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainthumbprintsha1(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainthumbprintsha256(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainusage(void* lpObj, int signercertchainindex);

int ipworkssmime_spop_getsignercertchainusageflags(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainversion(void* lpObj, int signercertchainindex);

char* ipworkssmime_spop_getsignercertchainsubject(void* lpObj, int signercertchainindex);

int ipworkssmime_spop_getsignercertchainencoded(void* lpObj, int signercertchainindex, char** lpSignerCertChainEncoded, int* lenSignerCertChainEncoded);

int GetSignerCertChainCount();

QString GetSignerCertChainEffectiveDate(int iSignerCertChainIndex);

QString GetSignerCertChainExpirationDate(int iSignerCertChainIndex);

QString GetSignerCertChainExtendedKeyUsage(int iSignerCertChainIndex);

QString GetSignerCertChainFingerprint(int iSignerCertChainIndex);

QString GetSignerCertChainFingerprintSHA1(int iSignerCertChainIndex);

QString GetSignerCertChainFingerprintSHA256(int iSignerCertChainIndex);

QString GetSignerCertChainIssuer(int iSignerCertChainIndex);

QString GetSignerCertChainPrivateKey(int iSignerCertChainIndex);

bool GetSignerCertChainPrivateKeyAvailable(int iSignerCertChainIndex);

QString GetSignerCertChainPrivateKeyContainer(int iSignerCertChainIndex);

QString GetSignerCertChainPublicKey(int iSignerCertChainIndex);

QString GetSignerCertChainPublicKeyAlgorithm(int iSignerCertChainIndex);

int GetSignerCertChainPublicKeyLength(int iSignerCertChainIndex);

QString GetSignerCertChainSerialNumber(int iSignerCertChainIndex);

QString GetSignerCertChainSignatureAlgorithm(int iSignerCertChainIndex);

QByteArray GetSignerCertChainStore(int iSignerCertChainIndex);

QString GetSignerCertChainStorePassword(int iSignerCertChainIndex);

int GetSignerCertChainStoreType(int iSignerCertChainIndex);

QString GetSignerCertChainSubjectAltNames(int iSignerCertChainIndex);

QString GetSignerCertChainThumbprintMD5(int iSignerCertChainIndex);

QString GetSignerCertChainThumbprintSHA1(int iSignerCertChainIndex);

QString GetSignerCertChainThumbprintSHA256(int iSignerCertChainIndex);

QString GetSignerCertChainUsage(int iSignerCertChainIndex);

int GetSignerCertChainUsageFlags(int iSignerCertChainIndex);

QString GetSignerCertChainVersion(int iSignerCertChainIndex);

QString GetSignerCertChainSubject(int iSignerCertChainIndex);

QByteArray GetSignerCertChainEncoded(int iSignerCertChainIndex);

Remarks

This property contains the certificate chain of the signing certificate. When calling VerifySignature or DecryptAndVerifySignature, this property will be populated with the certificate chain of the sender if attached.

Note: The SignerCert property will contain the signing certificate. The certificates in the signing certificate's chain will be placed in this property's collection.

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

Data Type

IPWorksSMIMECertificate

SigningAlgorithm Property (SPOP Class)

This property includes a textual description of the signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSigningAlgorithm();
int SetSigningAlgorithm(const char* lpszSigningAlgorithm);

Unicode (Windows)
LPWSTR GetSigningAlgorithm();
INT SetSigningAlgorithm(LPCWSTR lpszSigningAlgorithm);

char* ipworkssmime_spop_getsigningalgorithm(void* lpObj);
int ipworkssmime_spop_setsigningalgorithm(void* lpObj, const char* lpszSigningAlgorithm);

QString GetSigningAlgorithm();
int SetSigningAlgorithm(QString qsSigningAlgorithm);

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm used to prepare the message digest for signature.

This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:

• sha1
• md5
• sha-256 (default)
• sha-384
• sha-512
• sha-224

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

Data Type

String

SSLAcceptServerCert Property (SPOP Class)

This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

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

char* ipworkssmime_spop_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertfingerprint(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertissuer(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertprivatekey(void* lpObj);

int ipworkssmime_spop_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertpublickey(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworkssmime_spop_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertserialnumber(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworkssmime_spop_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworkssmime_spop_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworkssmime_spop_getsslacceptservercertstorepassword(void* lpObj);
int ipworkssmime_spop_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworkssmime_spop_getsslacceptservercertstoretype(void* lpObj);
int ipworkssmime_spop_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworkssmime_spop_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertusage(void* lpObj);

int ipworkssmime_spop_getsslacceptservercertusageflags(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertversion(void* lpObj);

char* ipworkssmime_spop_getsslacceptservercertsubject(void* lpObj);
int ipworkssmime_spop_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworkssmime_spop_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworkssmime_spop_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

IPWorksSMIMECertificate

SSLCert Property (SPOP Class)

This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

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

char* ipworkssmime_spop_getsslcerteffectivedate(void* lpObj);

char* ipworkssmime_spop_getsslcertexpirationdate(void* lpObj);

char* ipworkssmime_spop_getsslcertextendedkeyusage(void* lpObj);

char* ipworkssmime_spop_getsslcertfingerprint(void* lpObj);

char* ipworkssmime_spop_getsslcertfingerprintsha1(void* lpObj);

char* ipworkssmime_spop_getsslcertfingerprintsha256(void* lpObj);

char* ipworkssmime_spop_getsslcertissuer(void* lpObj);

char* ipworkssmime_spop_getsslcertprivatekey(void* lpObj);

int ipworkssmime_spop_getsslcertprivatekeyavailable(void* lpObj);

char* ipworkssmime_spop_getsslcertprivatekeycontainer(void* lpObj);

char* ipworkssmime_spop_getsslcertpublickey(void* lpObj);

char* ipworkssmime_spop_getsslcertpublickeyalgorithm(void* lpObj);

int ipworkssmime_spop_getsslcertpublickeylength(void* lpObj);

char* ipworkssmime_spop_getsslcertserialnumber(void* lpObj);

char* ipworkssmime_spop_getsslcertsignaturealgorithm(void* lpObj);

int ipworkssmime_spop_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworkssmime_spop_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworkssmime_spop_getsslcertstorepassword(void* lpObj);
int ipworkssmime_spop_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworkssmime_spop_getsslcertstoretype(void* lpObj);
int ipworkssmime_spop_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworkssmime_spop_getsslcertsubjectaltnames(void* lpObj);

char* ipworkssmime_spop_getsslcertthumbprintmd5(void* lpObj);

char* ipworkssmime_spop_getsslcertthumbprintsha1(void* lpObj);

char* ipworkssmime_spop_getsslcertthumbprintsha256(void* lpObj);

char* ipworkssmime_spop_getsslcertusage(void* lpObj);

int ipworkssmime_spop_getsslcertusageflags(void* lpObj);

char* ipworkssmime_spop_getsslcertversion(void* lpObj);

char* ipworkssmime_spop_getsslcertsubject(void* lpObj);
int ipworkssmime_spop_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworkssmime_spop_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworkssmime_spop_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 field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksSMIMECertificate

SSLEnabled Property (SPOP 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 ipworkssmime_spop_getsslenabled(void* lpObj);
int ipworkssmime_spop_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 (SPOP Class)

This property specifies 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 ipworkssmime_spop_getsslprovider(void* lpObj);
int ipworkssmime_spop_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 (SPOP Class)

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

Syntax

• C++
• C
• Qt

IPWorksSMIMECertificate* GetSSLServerCert();

char* ipworkssmime_spop_getsslservercerteffectivedate(void* lpObj);

char* ipworkssmime_spop_getsslservercertexpirationdate(void* lpObj);

char* ipworkssmime_spop_getsslservercertextendedkeyusage(void* lpObj);

char* ipworkssmime_spop_getsslservercertfingerprint(void* lpObj);

char* ipworkssmime_spop_getsslservercertfingerprintsha1(void* lpObj);

char* ipworkssmime_spop_getsslservercertfingerprintsha256(void* lpObj);

char* ipworkssmime_spop_getsslservercertissuer(void* lpObj);

char* ipworkssmime_spop_getsslservercertprivatekey(void* lpObj);

int ipworkssmime_spop_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworkssmime_spop_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworkssmime_spop_getsslservercertpublickey(void* lpObj);

char* ipworkssmime_spop_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworkssmime_spop_getsslservercertpublickeylength(void* lpObj);

char* ipworkssmime_spop_getsslservercertserialnumber(void* lpObj);

char* ipworkssmime_spop_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworkssmime_spop_getsslservercertstorepassword(void* lpObj);

int ipworkssmime_spop_getsslservercertstoretype(void* lpObj);

char* ipworkssmime_spop_getsslservercertsubjectaltnames(void* lpObj);

char* ipworkssmime_spop_getsslservercertthumbprintmd5(void* lpObj);

char* ipworkssmime_spop_getsslservercertthumbprintsha1(void* lpObj);

char* ipworkssmime_spop_getsslservercertthumbprintsha256(void* lpObj);

char* ipworkssmime_spop_getsslservercertusage(void* lpObj);

int ipworkssmime_spop_getsslservercertusageflags(void* lpObj);

char* ipworkssmime_spop_getsslservercertversion(void* lpObj);

char* ipworkssmime_spop_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksSMIMECertificate

SSLStartMode Property (SPOP 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 ipworkssmime_spop_getsslstartmode(void* lpObj);
int ipworkssmime_spop_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 (SPOP Class)

This property includes 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 ipworkssmime_spop_gettimeout(void* lpObj);
int ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_getuser(void* lpObj);
int ipworkssmime_spop_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

CheckMessageEncrypted Method (SPOP Class)

This method checks whether or not the current message is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool CheckMessageEncrypted();

Unicode (Windows)
INT CheckMessageEncrypted();

bool ipworkssmime_spop_checkmessageencrypted(void* lpObj);

bool CheckMessageEncrypted();

Remarks

This method is used to check whether or not the current message is encrypted. This method will return True, if the current message appears to be encrypted, according to the value of OutputMessageHeaders.

Error Handling (C++)

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

CheckMessageSigned Method (SPOP Class)

This method checks whether or not the current message is signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool CheckMessageSigned();

Unicode (Windows)
INT CheckMessageSigned();

bool ipworkssmime_spop_checkmessagesigned(void* lpObj);

bool CheckMessageSigned();

Remarks

This method is used to check whether or not the current message is signed. This method will return True, if the current message appears to be signed, according to the value of OutputMessageHeaders.

Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.

Error Handling (C++)

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

Config Method (SPOP Class)

This method 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* ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP Class)

This method decrypts the current Message .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworkssmime_spop_decrypt(void* lpObj);

int Decrypt();

Remarks

This method attempts to decrypt the encrypted message using the certificate in Certificate.

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

This method decrypts and verifies the signature of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptAndVerifySignature();

Unicode (Windows)
INT DecryptAndVerifySignature();

int ipworkssmime_spop_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.

Note: This function does not attempt to check the validity of the signing certificate.

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 (SPOP 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 ipworkssmime_spop_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 (SPOP Class)

This method disconnects from the mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworkssmime_spop_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 (SPOP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworkssmime_spop_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 (SPOP Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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* ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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 ipworkssmime_spop_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 (SPOP 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(IPWorksSMIMEStream* sMessageStream);

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

int ipworkssmime_spop_setmessagestream(void* lpObj, IPWorksSMIMEStream* sMessageStream);

int SetMessageStream(IPWorksSMIMEStream* 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 (SPOP Class)

This method verifies the signature of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworkssmime_spop_verifysignature(void* lpObj);

int VerifySignature();

Remarks

This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the class will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the class fails with an error.

If this method is successful, the SignerCert property will contain the certificate information of the message signer.

Note: This function does not attempt to check the validity of the signing certificate.

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

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_CONNECTIONSTATUS 1

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

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

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

Remarks

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

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

EndTransfer Event (SPOP Class)

This event is fired when the message completes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_ENDTRANSFER 2

virtual INT IPWORKSSMIME_CALL FireEndTransfer(INT &iDirection);

class SPOPEndTransferEventParams {
public:
  int Direction();

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

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

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

This event is fired for information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_ERROR 3

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

class SPOPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass SPOP and override this emitter function.
virtual int FireError(SPOPErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description 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 (SPOP Class)

This event is fired for every message header being retrieved.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_HEADER 4

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

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

// Or, subclass SPOP and override this emitter function.
virtual int FireHeader(SPOPHeaderEventParams *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).

MessageList Event (SPOP Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_MESSAGELIST 5

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

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

// Or, subclass SPOP and override this emitter function.
virtual int FireMessageList(SPOPMessageListEventParams *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 (SPOP 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(SPOPPITrailEventParams *e);

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


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

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

#define EID_SPOP_PITRAIL 6

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

class SPOPPITrailEventParams {
public:
  int Direction();

  const QString &Message();

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

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

// Or, subclass SPOP and override this emitter function.
virtual int FirePITrail(SPOPPITrailEventParams *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:

SSLServerAuthentication Event (SPOP Class)

This event is fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_SSLSERVERAUTHENTICATION 7

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

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

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

This event shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_SSLSTATUS 8

virtual INT IPWORKSSMIME_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartTransfer Event (SPOP Class)

This event is fired when the message starts transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_STARTTRANSFER 9

virtual INT IPWORKSSMIME_CALL FireStartTransfer(INT &iDirection);

class SPOPStartTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass SPOP and override this emitter function.
virtual int FireStartTransfer(SPOPStartTransferEventParams *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.

Transfer Event (SPOP Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SPOP_TRANSFER 10

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

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

// Or, subclass SPOP and override this emitter function.
virtual int FireTransfer(SPOPTransferEventParams *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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSMIMECertificate (declared in ipworkssmime.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()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X509 public key.

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

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

Firewall Type

This is the firewall the component will connect through.

Syntax

IPWorksSMIMEFirewall (declared in ipworkssmime.h)

Remarks

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

Fields

Constructors

Firewall()

Header Type

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

Syntax

IPWorksSMIMEHeader (declared in ipworkssmime.h)

Remarks

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

Fields

Constructors

Header()

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

MessageRecipient Type

This types describes the message recipient.

Syntax

IPWorksSMIMEMessageRecipient (declared in ipworkssmime.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)

IPWorksSMIMEList Type

Syntax

IPWorksSMIMEList<T> (declared in ipworkssmime.h)

Remarks

IPWorksSMIMEList 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 SPOP class.

int GetCount() {}

int SetCount() {}

T* Get(int index) {}

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

IPWorksSMIMEStream Type

Syntax

IPWorksSMIMEStream (declared in ipworkssmime.h)

Remarks

The SPOP 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 IPWorksSMIMEStream interface and pass the SPOP class an instance of that concrete class.

When implementing the IPWorksSMIMEStream 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 (SPOP Class)

POP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (SPOP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

POP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors