PIMAP Class

Properties   Methods   Events   Config Settings   Errors  

The PIMAP class is used to communicate with IMAP servers to retrieve and process OpenPGP encrypted and/or signed messages and any attachments.

Syntax

PIMAP

Remarks

The PIMAP class offers an easy-to-use interface: it implements a standard IMAP client, as specified in RFC 1730 and RFC 2060, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. Additionally, it enables you to create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.

Connect to a Mail Server

The first step in using the class is specifying a MailServer, a User to connect as, and a Password to authenticate with. After that, one or more requests may be sent to the server via the class's methods. Results are retrieved through events and a number of key properties.

Examine a Mailbox

Normally, after connecting to the server a Mailbox is selected (or examined) using the ExamineMailbox method. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags shows the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent via the class's methods. The primary arguments for most commands are the Mailbox property and the MessageSet property. The MessageSet property denotes either a single message or a range of messages. Other arguments are specified through other properties such as SortCriteria, MessageFlags, etc.

Responses are received through events such as MessageInfo and MailboxList, and are also reflected in properties such as MessageText, MessageSubject, etc.

Decrypt

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

Verify

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

Retrieve MIME Message Parts

The MessagePart event describes the MIME structure of retrieved messages. One MessagePart event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the FetchMessagePart method. This speeds up processing by avoiding the need to retrieve full messages from the server.

Trace Client and Server Communication

The PITrail event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers.

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

This property includes the authentication mechanism to be used when connecting to the mail server.

Syntax

• C++
• C
• Qt

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

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

AM_USER_PASSWORD(0), 
AM_CRAMMD5(1), 
AM_NTLM(2), 
AM_APOP(3), 
AM_SASLPLAIN(4), 
AM_SASLDIGEST_MD5(5), 
AM_KERBEROS(6), 
AM_XOAUTH2(7)

int ipworksopenpgp_pimap_getauthmechanism(void* lpObj);
int ipworksopenpgp_pimap_setauthmechanism(void* lpObj, int iAuthMechanism);

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

Default Value

0

Remarks

Data Type

Integer

AutoDecodeParts Property (PIMAP Class)

This property determines whether or not to automatically decode message parts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAutoDecodeParts();
int SetAutoDecodeParts(int bAutoDecodeParts);

Unicode (Windows)
BOOL GetAutoDecodeParts();
INT SetAutoDecodeParts(BOOL bAutoDecodeParts);

int ipworksopenpgp_pimap_getautodecodeparts(void* lpObj);
int ipworksopenpgp_pimap_setautodecodeparts(void* lpObj, int bAutoDecodeParts);

bool GetAutoDecodeParts();
int SetAutoDecodeParts(bool bAutoDecodeParts);

Default Value

FALSE

Remarks

This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is True, the parts are automatically decoded while being received.

Data Type

Boolean

Command Property (PIMAP Class)

This property can be used to send additional commands directly to the server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SetCommand(LPCWSTR lpszCommand);

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

int SetCommand(QString qsCommand);

Default Value

""

Remarks

Setting this property directs the class to send the assigned command to the MailServer.

Check the LastReply property or trap the PITrail events coming from the server to get the responses.

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

Data Type

String

Connected Property (PIMAP Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getconnected(void* lpObj);
int ipworksopenpgp_pimap_setconnected(void* lpObj, int bConnected);

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

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

EndByte Property (PIMAP Class)

This property includes the byte index of the position where the transfer should end.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetEndByte();
int SetEndByte(int64 lEndByte);

Unicode (Windows)
LONG64 GetEndByte();
INT SetEndByte(LONG64 lEndByte);

int64 ipworksopenpgp_pimap_getendbyte(void* lpObj);
int ipworksopenpgp_pimap_setendbyte(void* lpObj, int64 lEndByte);

qint64 GetEndByte();
int SetEndByte(qint64 lEndByte);

Default Value

0

Remarks

StartByte and EndByte are used together with the FetchMessagePart method to specify the portion of the message to be retrieved from the server.

When StartByte or EndByte contain values other than the default (0), only the corresponding portion of the message is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Data Type

Long64

FirewallAutoDetect Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getfirewallautodetect(void* lpObj);
int ipworksopenpgp_pimap_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (PIMAP Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksopenpgp_pimap_getfirewalltype(void* lpObj);
int ipworksopenpgp_pimap_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getfirewallhost(void* lpObj);
int ipworksopenpgp_pimap_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getfirewallpassword(void* lpObj);
int ipworksopenpgp_pimap_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getfirewallport(void* lpObj);
int ipworksopenpgp_pimap_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getfirewalluser(void* lpObj);
int ipworksopenpgp_pimap_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

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

Data Type

String

Idle Property (PIMAP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksopenpgp_pimap_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

KeyCount Property (PIMAP Class)

The number of records in the Key arrays.

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getkeycount(void* lpObj);
int ipworksopenpgp_pimap_setkeycount(void* lpObj, int iKeyCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyEncoded
• KeyKeyring
• KeyPassphrase
• KeyUserId

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

This property is not available at design time.

Data Type

Integer

KeyEncoded Property (PIMAP Class)

The key.

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getkeyencoded(void* lpObj, int keyindex, char** lpKeyEncoded, int* lenKeyEncoded);
int ipworksopenpgp_pimap_setkeyencoded(void* lpObj, int keyindex, const char* lpKeyEncoded, int lenKeyEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

KeyKeyring Property (PIMAP Class)

The location of the keyring.

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getkeykeyring(void* lpObj, int keyindex);
int ipworksopenpgp_pimap_setkeykeyring(void* lpObj, int keyindex, const char* lpszKeyKeyring);

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

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the class will read the keyring and populate the Key* properties with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

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

This property is not available at design time.

Data Type

String

KeyPassphrase Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getkeypassphrase(void* lpObj, int keyindex);
int ipworksopenpgp_pimap_setkeypassphrase(void* lpObj, int keyindex, const char* lpszKeyPassphrase);

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

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

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

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

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

• Decrypt
• Sign
• SignAndEncrypt

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

This property is not available at design time.

Data Type

String

KeyUserId Property (PIMAP Class)

The user Id of the key.

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getkeyuserid(void* lpObj, int keyindex);
int ipworksopenpgp_pimap_setkeyuserid(void* lpObj, int keyindex, const char* lpszKeyUserId);

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

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.

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

This property is not available at design time.

Data Type

String

LastReply Property (PIMAP Class)

The last reply from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastReply();

Unicode (Windows)
LPWSTR GetLastReply();

char* ipworksopenpgp_pimap_getlastreply(void* lpObj);

QString GetLastReply();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

LocalHost Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksopenpgp_pimap_getlocalhost(void* lpObj);
int ipworksopenpgp_pimap_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

Mailbox Property (PIMAP Class)

This property includes the name of the mailbox selected on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailbox();
int SetMailbox(const char* lpszMailbox);

Unicode (Windows)
LPWSTR GetMailbox();
INT SetMailbox(LPCWSTR lpszMailbox);

char* ipworksopenpgp_pimap_getmailbox(void* lpObj);
int ipworksopenpgp_pimap_setmailbox(void* lpObj, const char* lpszMailbox);

QString GetMailbox();
int SetMailbox(QString qsMailbox);

Default Value

"Inbox"

Remarks

This method contains the name of the mailbox selected on the server and also is used as argument to most methods. Please refer to the class methods for more information.

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

Data Type

String

MailboxFlags Property (PIMAP Class)

This property defines flags in the selected mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailboxFlags();

Unicode (Windows)
LPWSTR GetMailboxFlags();

char* ipworksopenpgp_pimap_getmailboxflags(void* lpObj);

QString GetMailboxFlags();

Default Value

""

Remarks

This property defines flags in the selected mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

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

Data Type

String

MailboxListCount Property (PIMAP Class)

The number of records in the MailboxList arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxListCount();

Unicode (Windows)
INT GetMailboxListCount();

int ipworksopenpgp_pimap_getmailboxlistcount(void* lpObj);

int GetMailboxListCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MailboxListFlags
• MailboxListName
• MailboxListSeparator

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

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

Data Type

Integer

MailboxListFlags Property (PIMAP Class)

This property contains the mailbox flags in a mailbox listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailboxListFlags(int iMailboxListIndex);

Unicode (Windows)
LPWSTR GetMailboxListFlags(INT iMailboxListIndex);

char* ipworksopenpgp_pimap_getmailboxlistflags(void* lpObj, int mailboxlistindex);

QString GetMailboxListFlags(int iMailboxListIndex);

Default Value

""

Remarks

This property contains the mailbox flags in a mailbox listing.

Examples of possible flag values are server dependent, but they can include the following:

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailboxListName Property (PIMAP Class)

This property contains the mailbox name in a mailbox listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailboxListName(int iMailboxListIndex);

Unicode (Windows)
LPWSTR GetMailboxListName(INT iMailboxListIndex);

char* ipworksopenpgp_pimap_getmailboxlistname(void* lpObj, int mailboxlistindex);

QString GetMailboxListName(int iMailboxListIndex);

Default Value

""

Remarks

This property contains the mailbox name in a mailbox listing.

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailboxListSeparator Property (PIMAP Class)

The Separator property contains the character that separates the different parts in the mailbox path hierarchy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailboxListSeparator(int iMailboxListIndex);

Unicode (Windows)
LPWSTR GetMailboxListSeparator(INT iMailboxListIndex);

char* ipworksopenpgp_pimap_getmailboxlistseparator(void* lpObj, int mailboxlistindex);

QString GetMailboxListSeparator(int iMailboxListIndex);

Default Value

""

Remarks

The MailboxListSeparator property contains the character that separates the different parts in the mailbox path hierarchy.

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailPort Property (PIMAP Class)

This property includes the port of the IMAP server (default is 143).

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getmailport(void* lpObj);
int ipworksopenpgp_pimap_setmailport(void* lpObj, int iMailPort);

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

Default Value

143

Remarks

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 the implicit Secure Sockets Layer (SSL), use port 993 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

Data Type

Integer

MailServer Property (PIMAP Class)

This property includes the name or address of the mail server (IMAP server).

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getmailserver(void* lpObj);
int ipworksopenpgp_pimap_setmailserver(void* lpObj, const char* lpszMailServer);

QString GetMailServer();
int SetMailServer(QString qsMailServer);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or domain name of the mail server. It must be 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, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

Message Property (PIMAP Class)

This property provides the raw message content.

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getmessage(void* lpObj, char** lpMessage, int* lenMessage);
int ipworksopenpgp_pimap_setmessage(void* lpObj, const char* lpMessage, int lenMessage);

QByteArray GetMessage();
int SetMessage(QByteArray qbaMessage);

Default Value

""

Remarks

This property is populated after calling FetchMessagePart 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 not available at design time.

Data Type

Binary String

MessageContentEncoding Property (PIMAP Class)

This property includes the ContentEncoding of the selected message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageContentEncoding();

Unicode (Windows)
LPWSTR GetMessageContentEncoding();

char* ipworksopenpgp_pimap_getmessagecontentencoding(void* lpObj);

QString GetMessageContentEncoding();

Default Value

""

Remarks

The property is automatically set by the class when message information is retrieved through the FetchMessageInfo method.

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

Data Type

String

MessageContentType Property (PIMAP Class)

This property includes the ContentType of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageContentType();

Unicode (Windows)
LPWSTR GetMessageContentType();

char* ipworksopenpgp_pimap_getmessagecontenttype(void* lpObj);

QString GetMessageContentType();

Default Value

""

Remarks

This property denotes the type of content contained in the message, such as plain, multipart, or multipart/alternative. You also may need to check the MessageContentEncoding property or read the individual message parts.

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

Data Type

String

MessageCount Property (PIMAP Class)

This property includes the total number of messages on the Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageCount();

Unicode (Windows)
INT GetMessageCount();

int ipworksopenpgp_pimap_getmessagecount(void* lpObj);

int GetMessageCount();

Default Value

0

Remarks

This property contains the total number of messages on the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

Data Type

Integer

MessageDate Property (PIMAP Class)

The property includes the time the message was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageDate();

Unicode (Windows)
LPWSTR GetMessageDate();

char* ipworksopenpgp_pimap_getmessagedate(void* lpObj);

QString GetMessageDate();

Default Value

""

Remarks

This property contains the date and time when the message was created. This value is taken from the ENVELOPE structure of the message corresponding to the date.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".

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

Data Type

String

MessageDeliveryTime Property (PIMAP Class)

This property includes the time the message was delivered to the mail server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageDeliveryTime();

Unicode (Windows)
LPWSTR GetMessageDeliveryTime();

char* ipworksopenpgp_pimap_getmessagedeliverytime(void* lpObj);

QString GetMessageDeliveryTime();

Default Value

""

Remarks

This property contains the time the message was delivered to the mail server. This value is taken from the INTERNALDATE property of the message. The time format is defined in RFC 821.

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

Data Type

String

MessageFlags Property (PIMAP Class)

This property contains the flags of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageFlags();
int SetMessageFlags(const char* lpszMessageFlags);

Unicode (Windows)
LPWSTR GetMessageFlags();
INT SetMessageFlags(LPCWSTR lpszMessageFlags);

char* ipworksopenpgp_pimap_getmessageflags(void* lpObj);
int ipworksopenpgp_pimap_setmessageflags(void* lpObj, const char* lpszMessageFlags);

QString GetMessageFlags();
int SetMessageFlags(QString qsMessageFlags);

Default Value

""

Remarks

This property contains the flags of the current message. It also is used to specify flags when AppendToMailbox is called.

Examples of possible flag values are server dependent, but they can include the following:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

This property is not available at design time.

Data Type

String

MessageFrom Property (PIMAP Class)

This property includes the address of the author of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageFrom();

Unicode (Windows)
LPWSTR GetMessageFrom();

char* ipworksopenpgp_pimap_getmessagefrom(void* lpObj);

QString GetMessageFrom();

Default Value

""

Remarks

This property normally has the same value as MessageSender.

In some cases, a message may have more than one From address. If this is the case, the addresses are provided in the MessageFrom property and are separated by commas.

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

Data Type

String

MessageHeaderCount Property (PIMAP Class)

The number of records in the MessageHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageHeaderCount();
int SetMessageHeaderCount(int iMessageHeaderCount);

Unicode (Windows)
INT GetMessageHeaderCount();
INT SetMessageHeaderCount(INT iMessageHeaderCount);

int ipworksopenpgp_pimap_getmessageheadercount(void* lpObj);
int ipworksopenpgp_pimap_setmessageheadercount(void* lpObj, int iMessageHeaderCount);

int GetMessageHeaderCount();
int SetMessageHeaderCount(int iMessageHeaderCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

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

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (PIMAP Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHeaderField(int iMessageHeaderIndex);
int SetMessageHeaderField(int iMessageHeaderIndex, const char* lpszMessageHeaderField);

Unicode (Windows)
LPWSTR GetMessageHeaderField(INT iMessageHeaderIndex);
INT SetMessageHeaderField(INT iMessageHeaderIndex, LPCWSTR lpszMessageHeaderField);

char* ipworksopenpgp_pimap_getmessageheaderfield(void* lpObj, int messageheaderindex);
int ipworksopenpgp_pimap_setmessageheaderfield(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderField);

QString GetMessageHeaderField(int iMessageHeaderIndex);
int SetMessageHeaderField(int iMessageHeaderIndex, QString qsMessageHeaderField);

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeaderValue Property (PIMAP Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHeaderValue(int iMessageHeaderIndex);
int SetMessageHeaderValue(int iMessageHeaderIndex, const char* lpszMessageHeaderValue);

Unicode (Windows)
LPWSTR GetMessageHeaderValue(INT iMessageHeaderIndex);
INT SetMessageHeaderValue(INT iMessageHeaderIndex, LPCWSTR lpszMessageHeaderValue);

char* ipworksopenpgp_pimap_getmessageheadervalue(void* lpObj, int messageheaderindex);
int ipworksopenpgp_pimap_setmessageheadervalue(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderValue);

QString GetMessageHeaderValue(int iMessageHeaderIndex);
int SetMessageHeaderValue(int iMessageHeaderIndex, QString qsMessageHeaderValue);

Default Value

""

Remarks

This property contains the Header contents.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeadersString Property (PIMAP Class)

This property includes the string version of the RFC 822-encoded headers in the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHeadersString();
int SetMessageHeadersString(const char* lpszMessageHeadersString);

Unicode (Windows)
LPWSTR GetMessageHeadersString();
INT SetMessageHeadersString(LPCWSTR lpszMessageHeadersString);

char* ipworksopenpgp_pimap_getmessageheadersstring(void* lpObj);
int ipworksopenpgp_pimap_setmessageheadersstring(void* lpObj, const char* lpszMessageHeadersString);

QString GetMessageHeadersString();
int SetMessageHeadersString(QString qsMessageHeadersString);

Default Value

""

Remarks

This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the FetchMessageHeaders or the FetchMessagePartHeaders method.

This property is not available at design time.

Data Type

String

MessageId Property (PIMAP Class)

This property includes the message identifier of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageId();

Unicode (Windows)
LPWSTR GetMessageId();

char* ipworksopenpgp_pimap_getmessageid(void* lpObj);

QString GetMessageId();

Default Value

""

Remarks

The class fills out this property when message information is retrieved from the MailServer.

This Id is permanent if UIDMode is set, and otherwise is temporary.

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

Data Type

String

MessageInfoCount Property (PIMAP Class)

The number of records in the MessageInfo arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageInfoCount();

Unicode (Windows)
INT GetMessageInfoCount();

int ipworksopenpgp_pimap_getmessageinfocount(void* lpObj);

int GetMessageInfoCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageInfoDate
• MessageInfoFlags
• MessageInfoFrom
• MessageInfoMessageId
• MessageInfoSize
• MessageInfoSubject

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

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

Data Type

Integer

MessageInfoDate Property (PIMAP Class)

This property contains the date of a message in a message information listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageInfoDate(int iMessageInfoIndex);

Unicode (Windows)
LPWSTR GetMessageInfoDate(INT iMessageInfoIndex);

char* ipworksopenpgp_pimap_getmessageinfodate(void* lpObj, int messageinfoindex);

QString GetMessageInfoDate(int iMessageInfoIndex);

Default Value

""

Remarks

This property contains the date of a message in a message information listing. This date is taken from the ENVELOPE structure of the message.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoFlags Property (PIMAP Class)

This property contains a message flag in a message information listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageInfoFlags(int iMessageInfoIndex);

Unicode (Windows)
LPWSTR GetMessageInfoFlags(INT iMessageInfoIndex);

char* ipworksopenpgp_pimap_getmessageinfoflags(void* lpObj, int messageinfoindex);

QString GetMessageInfoFlags(int iMessageInfoIndex);

Default Value

""

Remarks

This property contains a message flag in a message information listing.

Examples of possible flag values are server dependent, but they can include the following:

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoFrom Property (PIMAP Class)

This property contains the sender of a message in a message information listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageInfoFrom(int iMessageInfoIndex);

Unicode (Windows)
LPWSTR GetMessageInfoFrom(INT iMessageInfoIndex);

char* ipworksopenpgp_pimap_getmessageinfofrom(void* lpObj, int messageinfoindex);

QString GetMessageInfoFrom(int iMessageInfoIndex);

Default Value

""

Remarks

This property contains the sender of a message in a message information listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoMessageId Property (PIMAP Class)

The unique identifier of a message in a message information listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageInfoMessageId(int iMessageInfoIndex);

Unicode (Windows)
LPWSTR GetMessageInfoMessageId(INT iMessageInfoIndex);

char* ipworksopenpgp_pimap_getmessageinfomessageid(void* lpObj, int messageinfoindex);

QString GetMessageInfoMessageId(int iMessageInfoIndex);

Default Value

""

Remarks

The unique identifier of a message in a message information listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoSize Property (PIMAP Class)

This property contains the size of a message in a message information listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageInfoSize(int iMessageInfoIndex);

Unicode (Windows)
LONG64 GetMessageInfoSize(INT iMessageInfoIndex);

int64 ipworksopenpgp_pimap_getmessageinfosize(void* lpObj, int messageinfoindex);

qint64 GetMessageInfoSize(int iMessageInfoIndex);

Default Value

0

Remarks

This property contains the size of a message in a message information listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

Long64

MessageInfoSubject Property (PIMAP Class)

This property contains the subject of a message in a message information listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageInfoSubject(int iMessageInfoIndex);

Unicode (Windows)
LPWSTR GetMessageInfoSubject(INT iMessageInfoIndex);

char* ipworksopenpgp_pimap_getmessageinfosubject(void* lpObj, int messageinfoindex);

QString GetMessageInfoSubject(int iMessageInfoIndex);

Default Value

""

Remarks

This property contains the subject of a message in a message information listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInReplyTo Property (PIMAP Class)

This property includes the unique message identifier of the message being replied to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageInReplyTo();

Unicode (Windows)
LPWSTR GetMessageInReplyTo();

char* ipworksopenpgp_pimap_getmessageinreplyto(void* lpObj);

QString GetMessageInReplyTo();

Default Value

""

Remarks

The class fills out this property with the value of the In-Reply-To: message header.

This value can be useful when threading messages by referring to the message being replied to.

The unique message identifier of the message itself is given by the MessageNetId property.

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

Data Type

String

MessageNetId Property (PIMAP Class)

This property includes the globally unique identifier of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageNetId();

Unicode (Windows)
LPWSTR GetMessageNetId();

char* ipworksopenpgp_pimap_getmessagenetid(void* lpObj);

QString GetMessageNetId();

Default Value

""

Remarks

This property contains the globally unique identifier of the message. The class fills the MessageNetId with the value of the Message-Id: header. This is a globally unique value normally created by the first mail server the message is sent to.

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

Data Type

String

MessagePartCount Property (PIMAP Class)

The number of records in the MessagePart arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessagePartCount();

Unicode (Windows)
INT GetMessagePartCount();

int ipworksopenpgp_pimap_getmessagepartcount(void* lpObj);

int GetMessagePartCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessagePartContentDisposition
• MessagePartContentEncoding
• MessagePartContentId
• MessagePartContentType
• MessagePartFilename
• MessagePartId
• MessagePartMultipartMode
• MessagePartParameters
• MessagePartSize

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

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

Data Type

Integer

MessagePartContentDisposition Property (PIMAP Class)

This property shows the value of the Content-Disposition header of the message part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartContentDisposition(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartContentDisposition(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartcontentdisposition(void* lpObj, int messagepartindex);

QString GetMessagePartContentDisposition(int iMessagePartIndex);

Default Value

""

Remarks

This property shows the value of the Content-Disposition header of the message part.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentEncoding Property (PIMAP Class)

This property shows how the data are encoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartContentEncoding(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartContentEncoding(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartcontentencoding(void* lpObj, int messagepartindex);

QString GetMessagePartContentEncoding(int iMessagePartIndex);

Default Value

""

Remarks

This property shows how the data are encoded.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentId Property (PIMAP Class)

This property shows the value of the Content-Id header of the message part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartContentId(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartContentId(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartcontentid(void* lpObj, int messagepartindex);

QString GetMessagePartContentId(int iMessagePartIndex);

Default Value

""

Remarks

This property shows the value of the Content-Id header of the message part.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentType Property (PIMAP Class)

This property shows the type of data contained in the message part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartContentType(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartContentType(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartcontenttype(void* lpObj, int messagepartindex);

QString GetMessagePartContentType(int iMessagePartIndex);

Default Value

""

Remarks

This property shows the type of data contained in the message part.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartFilename Property (PIMAP Class)

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartFilename(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartFilename(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartfilename(void* lpObj, int messagepartindex);

QString GetMessagePartFilename(int iMessagePartIndex);

Default Value

""

Remarks

This property shows the filename corresponding to the part (if the part was included in the message as an attached file).

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartId Property (PIMAP Class)

This property contains the identifier of a part listing that may be identified in other parts or messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartId(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartId(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartid(void* lpObj, int messagepartindex);

QString GetMessagePartId(int iMessagePartIndex);

Default Value

""

Remarks

This property contains the identifier of a part listing that may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartMultipartMode Property (PIMAP Class)

This property shows how this part relates to the message's whole multipart structure (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartMultipartMode(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartMultipartMode(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartmultipartmode(void* lpObj, int messagepartindex);

QString GetMessagePartMultipartMode(int iMessagePartIndex);

Default Value

""

Remarks

This property shows how this part relates to the message's whole multipart structure (e.g., 'mixed' or 'alternative').

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartParameters Property (PIMAP Class)

This property contains the additional parameters passed to the ContentType header, such as the part charset.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessagePartParameters(int iMessagePartIndex);

Unicode (Windows)
LPWSTR GetMessagePartParameters(INT iMessagePartIndex);

char* ipworksopenpgp_pimap_getmessagepartparameters(void* lpObj, int messagepartindex);

QString GetMessagePartParameters(int iMessagePartIndex);

Default Value

""

Remarks

This property contains the additional parameters passed to the ContentType header, such as the part charset.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartSize Property (PIMAP Class)

This property contains the size of a part in a message part listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessagePartSize(int iMessagePartIndex);

Unicode (Windows)
LONG64 GetMessagePartSize(INT iMessagePartIndex);

int64 ipworksopenpgp_pimap_getmessagepartsize(void* lpObj, int messagepartindex);

qint64 GetMessagePartSize(int iMessagePartIndex);

Default Value

0

Remarks

This property contains the size of a part in a message part listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

Long64

MessageRecipientCount Property (PIMAP Class)

The number of records in the MessageRecipient arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageRecipientCount();

Unicode (Windows)
INT GetMessageRecipientCount();

int ipworksopenpgp_pimap_getmessagerecipientcount(void* lpObj);

int GetMessageRecipientCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageRecipientAddress
• MessageRecipientName
• MessageRecipientOptions
• MessageRecipientType

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

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

Data Type

Integer

MessageRecipientAddress Property (PIMAP Class)

This property contains the email address of the recipient.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageRecipientAddress(int iRecipientIndex);

Unicode (Windows)
LPWSTR GetMessageRecipientAddress(INT iRecipientIndex);

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

QString GetMessageRecipientAddress(int iRecipientIndex);

Default Value

""

Remarks

This property contains the email address of the recipient.

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

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

Data Type

String

MessageRecipientName Property (PIMAP Class)

This property contains the name of the recipient.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageRecipientName(int iRecipientIndex);

Unicode (Windows)
LPWSTR GetMessageRecipientName(INT iRecipientIndex);

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

QString GetMessageRecipientName(int iRecipientIndex);

Default Value

""

Remarks

This property contains the name of the recipient.

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

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

Data Type

String

MessageRecipientOptions Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageRecipientOptions(int iRecipientIndex);

Unicode (Windows)
LPWSTR GetMessageRecipientOptions(INT iRecipientIndex);

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

QString GetMessageRecipientOptions(int iRecipientIndex);

Default Value

""

Remarks

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

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

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

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

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

Data Type

String

MessageRecipientType Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageRecipientType(int iRecipientIndex);

Unicode (Windows)
INT GetMessageRecipientType(INT iRecipientIndex);

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

int ipworksopenpgp_pimap_getmessagerecipienttype(void* lpObj, int recipientindex);

int GetMessageRecipientType(int iRecipientIndex);

Default Value

0

Remarks

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

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

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

Data Type

Integer

MessageReplyTo Property (PIMAP Class)

This property includes the email addresses to which replies to the message should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageReplyTo();

Unicode (Windows)
LPWSTR GetMessageReplyTo();

char* ipworksopenpgp_pimap_getmessagereplyto(void* lpObj);

QString GetMessageReplyTo();

Default Value

""

Remarks

This property contains the email addresses to which replies to the message should be sent. In some cases, a message may have more than one Reply-To address. If this is the case, the addresses are provided in this property and are separated by commas.

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

Data Type

String

MessageSender Property (PIMAP Class)

This property includes the address of the sender of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSender();

Unicode (Windows)
LPWSTR GetMessageSender();

char* ipworksopenpgp_pimap_getmessagesender(void* lpObj);

QString GetMessageSender();

Default Value

""

Remarks

This property contains the address of the sender of the message. This normally is the same value as MessageFrom.

In some cases, a message may have more than one sender. If this is the case, the addresses are provided in the MessageSender property and are separated by commas.

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

Data Type

String

MessageSet Property (PIMAP Class)

This property includes the set of messages to operate on.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSet();
int SetMessageSet(const char* lpszMessageSet);

Unicode (Windows)
LPWSTR GetMessageSet();
INT SetMessageSet(LPCWSTR lpszMessageSet);

char* ipworksopenpgp_pimap_getmessageset(void* lpObj);
int ipworksopenpgp_pimap_setmessageset(void* lpObj, const char* lpszMessageSet);

QString GetMessageSet();
int SetMessageSet(QString qsMessageSet);

Default Value

""

Remarks

This property indicates the set of messages to operate on. This is used as an argument to most method calls.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").

Example 1. Setting MessageSet:

IMAPControl.MessageSet = "1" IMAPControl.FetchMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.FetchMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.FetchMessageInfo()

Data Type

String

MessageSize Property (PIMAP Class)

This property includes the size of the selected message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageSize();

Unicode (Windows)
LONG64 GetMessageSize();

int64 ipworksopenpgp_pimap_getmessagesize(void* lpObj);

qint64 GetMessageSize();

Default Value

0

Remarks

The class fills out this property with the size of the selected message when message information is retrieved from the MailServer.

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

Data Type

Long64

MessageSubject Property (PIMAP Class)

This property includes the subject of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSubject();

Unicode (Windows)
LPWSTR GetMessageSubject();

char* ipworksopenpgp_pimap_getmessagesubject(void* lpObj);

QString GetMessageSubject();

Default Value

""

Remarks

The class fills out this property with the subject of the message when message information is retrieved from the MailServer.

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

Data Type

String

MessageText Property (PIMAP Class)

This property includes the body of the retrieved message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageText();
int SetMessageText(const char* lpszMessageText);

Unicode (Windows)
LPWSTR GetMessageText();
INT SetMessageText(LPCWSTR lpszMessageText);

char* ipworksopenpgp_pimap_getmessagetext(void* lpObj);
int ipworksopenpgp_pimap_setmessagetext(void* lpObj, const char* lpszMessageText);

QString GetMessageText();
int SetMessageText(QString qsMessageText);

Default Value

""

Remarks

The class fills out this property with the contents of the message body (in RFC 822 format) when a call to FetchMessageText completes successfully and the LocalFile property is not set or the SetMessageStream method has not been used to set a stream.

This property is not available at design time.

Data Type

String

Overwrite Property (PIMAP Class)

This property indicates whether or not the class should overwrite files during transfer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworksopenpgp_pimap_getoverwrite(void* lpObj);
int ipworksopenpgp_pimap_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property is a value indicating whether or not the class should overwrite files when downloading the message text or a message part and LocalFile is set. If Overwrite is False, an error will be thrown whenever LocalFile exists.

Data Type

Boolean

Password Property (PIMAP Class)

This property includes the password to be used to authenticate to the MailServer .

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getpassword(void* lpObj);
int ipworksopenpgp_pimap_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

This property contains the password used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

Data Type

String

PeekMode Property (PIMAP Class)

When set to True, the message Seen flag is not changed during reading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPeekMode();
int SetPeekMode(int bPeekMode);

Unicode (Windows)
BOOL GetPeekMode();
INT SetPeekMode(BOOL bPeekMode);

int ipworksopenpgp_pimap_getpeekmode(void* lpObj);
int ipworksopenpgp_pimap_setpeekmode(void* lpObj, int bPeekMode);

bool GetPeekMode();
int SetPeekMode(bool bPeekMode);

Default Value

FALSE

Remarks

This property contains a True or False to determine whether or not this message should be seen. When this property is set to True, a PEEK option is added to all IMAP FETCH commands sent to the server. In this case, an RFC-compliant IMAP server should not set the Seen flag on the message.

This property is not available at design time.

Data Type

Boolean

RecentMessageCount Property (PIMAP Class)

This property includes the number of new messages in the Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecentMessageCount();

Unicode (Windows)
INT GetRecentMessageCount();

int ipworksopenpgp_pimap_getrecentmessagecount(void* lpObj);

int GetRecentMessageCount();

Default Value

0

Remarks

This property contains the number of new messages that are in the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

Data Type

Integer

SignerKeyCount Property (PIMAP Class)

The number of records in the SignerKey arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyCount();
int SetSignerKeyCount(int iSignerKeyCount);

Unicode (Windows)
INT GetSignerKeyCount();
INT SetSignerKeyCount(INT iSignerKeyCount);

int ipworksopenpgp_pimap_getsignerkeycount(void* lpObj);
int ipworksopenpgp_pimap_setsignerkeycount(void* lpObj, int iSignerKeyCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignerKeyEncoded
• SignerKeyKeyring
• SignerKeyUserId

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

This property is not available at design time.

Data Type

Integer

SignerKeyEncoded Property (PIMAP Class)

The key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyEncoded(int iSignerKeyIndex, char* &lpSignerKeyEncoded, int &lenSignerKeyEncoded);
int SetSignerKeyEncoded(int iSignerKeyIndex, const char* lpSignerKeyEncoded, int lenSignerKeyEncoded);

Unicode (Windows)
INT GetSignerKeyEncoded(INT iSignerKeyIndex, LPSTR &lpSignerKeyEncoded, INT &lenSignerKeyEncoded);
INT SetSignerKeyEncoded(INT iSignerKeyIndex, LPCSTR lpSignerKeyEncoded, INT lenSignerKeyEncoded);

int ipworksopenpgp_pimap_getsignerkeyencoded(void* lpObj, int signerkeyindex, char** lpSignerKeyEncoded, int* lenSignerKeyEncoded);
int ipworksopenpgp_pimap_setsignerkeyencoded(void* lpObj, int signerkeyindex, const char* lpSignerKeyEncoded, int lenSignerKeyEncoded);

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

Default Value

""

Remarks

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

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is not available at design time.

Data Type

Binary String

SignerKeyKeyring Property (PIMAP Class)

The location of the keyring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerKeyKeyring(int iSignerKeyIndex);
int SetSignerKeyKeyring(int iSignerKeyIndex, const char* lpszSignerKeyKeyring);

Unicode (Windows)
LPWSTR GetSignerKeyKeyring(INT iSignerKeyIndex);
INT SetSignerKeyKeyring(INT iSignerKeyIndex, LPCWSTR lpszSignerKeyKeyring);

char* ipworksopenpgp_pimap_getsignerkeykeyring(void* lpObj, int signerkeyindex);
int ipworksopenpgp_pimap_setsignerkeykeyring(void* lpObj, int signerkeyindex, const char* lpszSignerKeyKeyring);

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

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the class will read the keyring and populate the Key* properties with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is not available at design time.

Data Type

String

SignerKeyUserId Property (PIMAP Class)

The user Id of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerKeyUserId(int iSignerKeyIndex);
int SetSignerKeyUserId(int iSignerKeyIndex, const char* lpszSignerKeyUserId);

Unicode (Windows)
LPWSTR GetSignerKeyUserId(INT iSignerKeyIndex);
INT SetSignerKeyUserId(INT iSignerKeyIndex, LPCWSTR lpszSignerKeyUserId);

char* ipworksopenpgp_pimap_getsignerkeyuserid(void* lpObj, int signerkeyindex);
int ipworksopenpgp_pimap_setsignerkeyuserid(void* lpObj, int signerkeyindex, const char* lpszSignerKeyUserId);

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

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is not available at design time.

Data Type

String

SortCriteria Property (PIMAP Class)

This property sorts criteria to use for message retrieval operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSortCriteria();
int SetSortCriteria(const char* lpszSortCriteria);

Unicode (Windows)
LPWSTR GetSortCriteria();
INT SetSortCriteria(LPCWSTR lpszSortCriteria);

char* ipworksopenpgp_pimap_getsortcriteria(void* lpObj);
int ipworksopenpgp_pimap_setsortcriteria(void* lpObj, const char* lpszSortCriteria);

QString GetSortCriteria();
int SetSortCriteria(QString qsSortCriteria);

Default Value

""

Remarks

This property sorts criteria to use for message retrieval operations. When set, the class will send the SORT command to the server before any retrieval. If the server supports the SORT command, the results from the fetch operation will be sorted according to SortCriteria. The format of the SortCriteria property consists of a parenthesized list of one or more sort keys.

Example. Setting SortCriteria:

IMAPControl.SortCriteria = "DATE" IMAPControl.SortCriteria = "SUBJECT FROM" IMAPControl.SortCriteria = "REVERSE SUBJECT"

Possible sort keys include the following:

Note: IMAP SORT functionality is relatively new and not all servers may implement it.

Data Type

String

SSLAcceptServerCertEncoded Property (PIMAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksopenpgp_pimap_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (PIMAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksopenpgp_pimap_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksopenpgp_pimap_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksopenpgp_pimap_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getsslcertstorepassword(void* lpObj);
int ipworksopenpgp_pimap_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (PIMAP Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksopenpgp_pimap_getsslcertstoretype(void* lpObj);
int ipworksopenpgp_pimap_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (PIMAP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getsslcertsubject(void* lpObj);
int ipworksopenpgp_pimap_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLEnabled Property (PIMAP Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworksopenpgp_pimap_getsslenabled(void* lpObj);
int ipworksopenpgp_pimap_setsslenabled(void* lpObj, int bSSLEnabled);

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

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (PIMAP Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksopenpgp_pimap_getsslprovider(void* lpObj);
int ipworksopenpgp_pimap_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (PIMAP Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

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

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

SSLStartMode Property (PIMAP Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

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

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

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworksopenpgp_pimap_getsslstartmode(void* lpObj);
int ipworksopenpgp_pimap_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

StartByte Property (PIMAP Class)

This property includes the byte index of the position where the transfer should start.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);

int64 ipworksopenpgp_pimap_getstartbyte(void* lpObj);
int ipworksopenpgp_pimap_setstartbyte(void* lpObj, int64 lStartByte);

qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

Default Value

0

Remarks

StartByte and EndByte are used together with the FetchMessagePart method to specify the portion of the message to be retrieved from the server.

When StartByte or EndByte contain values other than the default (0), only the corresponding portion of the message is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Data Type

Long64

Timeout Property (PIMAP Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksopenpgp_pimap_gettimeout(void* lpObj);
int ipworksopenpgp_pimap_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UIDMode Property (PIMAP Class)

If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUIDMode();
int SetUIDMode(int bUIDMode);

Unicode (Windows)
BOOL GetUIDMode();
INT SetUIDMode(BOOL bUIDMode);

int ipworksopenpgp_pimap_getuidmode(void* lpObj);
int ipworksopenpgp_pimap_setuidmode(void* lpObj, int bUIDMode);

bool GetUIDMode();
int SetUIDMode(bool bUIDMode);

Default Value

FALSE

Remarks

This property indicates if a permanent identifier should be used. Normally, the IMAP server uses temporary message identifiers that are valid only during the current session. If UIDMode is True, permanent message identifiers are used instead.

The following IMAP protocol operations use the UID mode: COPY, FETCH, STORE, and SEARCH.

This property is not available at design time.

Data Type

Boolean

UIDValidity Property (PIMAP Class)

This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUIDValidity();

Unicode (Windows)
LPWSTR GetUIDValidity();

char* ipworksopenpgp_pimap_getuidvalidity(void* lpObj);

QString GetUIDValidity();

Default Value

""

Remarks

Every time a mailbox is selected, a UIDValidity is returned from the server. Most of the time, this value will not change from call to call. If it does change, this means that all previously returned UIDs for messages inside this mailbox are now invalid.

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

Data Type

String

User Property (PIMAP Class)

This property includes the username used to authenticate to the MailServer .

Syntax

• C++
• C
• Qt

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

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

char* ipworksopenpgp_pimap_getuser(void* lpObj);
int ipworksopenpgp_pimap_setuser(void* lpObj, const char* lpszUser);

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

Default Value

""

Remarks

This property contains the username used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

Data Type

String

AddMessageFlags Method (PIMAP Class)

This method adds the specified flags to the messages specified by MessageSet .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddMessageFlags(const char* lpszFlags);

Unicode (Windows)
INT AddMessageFlags(LPCWSTR lpszFlags);

int ipworksopenpgp_pimap_addmessageflags(void* lpObj, const char* lpszFlags);

int AddMessageFlags(const QString& qsFlags);

Remarks

This method adds the specified flags to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

Error Handling (C++)

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

AppendToMailbox Method (PIMAP Class)

This method appends the message in MessageText to the mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AppendToMailbox();

Unicode (Windows)
INT AppendToMailbox();

int ipworksopenpgp_pimap_appendtomailbox(void* lpObj);

int AppendToMailbox();

Remarks

This method appends the RFC 822-encoded message in MessageText to the mailbox specified by Mailbox. If the MessageFlags property is not an empty string, its contents are supplied with the APPEND command sent to the server.

Example. Append Message to Mailbox:

IMAPControl.MessageText = MessageHeaders + CRLF + CRLF + MessageBody + CRLF IMAPControl.Mailbox = "INBOX" IMAPControl.MessageFlags = "\Deleted" IMAPControl.AppendToMailbox()

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

CheckMailbox Method (PIMAP Class)

This method sends a CHECK command to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckMailbox();

Unicode (Windows)
INT CheckMailbox();

int ipworksopenpgp_pimap_checkmailbox(void* lpObj);

int CheckMailbox();

Remarks

This method sends a CHECK command to the server, asking it to perform any necessary housekeeping operations on and to update the state of the currently selected mailbox.

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

CloseMailbox Method (PIMAP Class)

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseMailbox();

Unicode (Windows)
INT CloseMailbox();

int ipworksopenpgp_pimap_closemailbox(void* lpObj);

int CloseMailbox();

Remarks

This method permanently removes all messages that have a 'Deleted' flag that have been set from the current (selected) mailbox. It then closes (deselected) the mailbox.

Error Handling (C++)

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

Config Method (PIMAP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksopenpgp_pimap_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 (PIMAP Class)

This method connects to an IMAP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksopenpgp_pimap_connect(void* lpObj);

int Connect();

Remarks

This method connects to the IMAP server specified by MailServer and authenticates it using the username and password supplied in the User and Password properties.

Example. Connect IMAP Server:

IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect() IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "DOMAIN/USERNT/INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect()

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

CopyToMailbox Method (PIMAP Class)

This method copies the messages specified by MessageSet to the mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CopyToMailbox();

Unicode (Windows)
INT CopyToMailbox();

int ipworksopenpgp_pimap_copytomailbox(void* lpObj);

int CopyToMailbox();

Remarks

This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

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

CreateMailbox Method (PIMAP Class)

This method creates a new mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateMailbox();

Unicode (Windows)
INT CreateMailbox();

int ipworksopenpgp_pimap_createmailbox(void* lpObj);

int CreateMailbox();

Remarks

This method creates a new mailbox. The mailbox name is specified by the Mailbox property.

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

Decrypts the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworksopenpgp_pimap_decrypt(void* lpObj);

int Decrypt();

Remarks

This method decrypts the specified message.

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

Error Handling (C++)

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

DecryptAndVerifySignature Method (PIMAP Class)

Decrypts and verifies the signature of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptAndVerifySignature();

Unicode (Windows)
INT DecryptAndVerifySignature();

int ipworksopenpgp_pimap_decryptandverifysignature(void* lpObj);

int DecryptAndVerifySignature();

Remarks

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

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

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

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

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

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

Error Handling (C++)

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

DeleteFromMailbox Method (PIMAP Class)

The method marks the messages specified by MessageSet as deleted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteFromMailbox();

Unicode (Windows)
INT DeleteFromMailbox();

int ipworksopenpgp_pimap_deletefrommailbox(void* lpObj);

int DeleteFromMailbox();

Remarks

This method marks the messages specified by MessageSet as deleted. Calling this method is equivalent to calling AddMessageFlags with "\Deleted" as the Flags parameter.

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

DeleteMailbox Method (PIMAP Class)

This method deletes a mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteMailbox();

Unicode (Windows)
INT DeleteMailbox();

int ipworksopenpgp_pimap_deletemailbox(void* lpObj);

int DeleteMailbox();

Remarks

This method deletes a mailbox. The mailbox name is specified by the Mailbox property.

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

DeleteMailboxACL Method (PIMAP Class)

This method deletes mailbox access control rights for a specific user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteMailboxACL(const char* lpszUser);

Unicode (Windows)
INT DeleteMailboxACL(LPCWSTR lpszUser);

int ipworksopenpgp_pimap_deletemailboxacl(void* lpObj, const char* lpszUser);

int DeleteMailboxACL(const QString& qsUser);

Remarks

This message asks the server to remove all rights associated with User from the mailbox specified in the Mailbox property. Refer to SetMailboxACL and GetMailboxACL for more information on mailbox access rights.

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

This method disconnects from an IMAP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksopenpgp_pimap_disconnect(void* lpObj);

int Disconnect();

Remarks

This method logs out and disconnects from the IMAP server.

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

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

ExamineMailbox Method (PIMAP Class)

This method selects a mailbox in read-only mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExamineMailbox();

Unicode (Windows)
INT ExamineMailbox();

int ipworksopenpgp_pimap_examinemailbox(void* lpObj);

int ExamineMailbox();

Remarks

This method asks the server to select the mailbox specified in the Mailbox property in read-only mode.

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

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

ExpungeMailbox Method (PIMAP Class)

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExpungeMailbox();

Unicode (Windows)
INT ExpungeMailbox();

int ipworksopenpgp_pimap_expungemailbox(void* lpObj);

int ExpungeMailbox();

Remarks

This method permanently removes all messages that have a 'Deleted' flag from the current (selected) mailbox. Example. Set "Deleted" Flag and Expunge:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") IMAPControl.ExpungeMailbox()

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

FetchMessageHeaders Method (PIMAP Class)

This method retrieves the message headers of the messages specified by the MessageSet property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchMessageHeaders();

Unicode (Windows)
INT FetchMessageHeaders();

int ipworksopenpgp_pimap_fetchmessageheaders(void* lpObj);

int FetchMessageHeaders();

Remarks

This method retrieves RFC 822 headers of the messages specified by MessageSet and stores them in the MessageHeaders property.

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

FetchMessageInfo Method (PIMAP Class)

This method retrieves information about messages specified by the MessageSet property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchMessageInfo();

Unicode (Windows)
INT FetchMessageInfo();

int ipworksopenpgp_pimap_fetchmessageinfo(void* lpObj);

int FetchMessageInfo();

Remarks

This method retrieves information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties, such as the following: MessageSubject, MessageFrom, and MessageRecipients. If the message is a multipart message, one or more MessagePart events will be fired before the MessageInfo event (one for each message part).

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

FetchMessagePart Method (PIMAP Class)

This method retrieves the message part specified by PartID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchMessagePart(const char* lpszPartId);

Unicode (Windows)
INT FetchMessagePart(LPCWSTR lpszPartId);

int ipworksopenpgp_pimap_fetchmessagepart(void* lpObj, const char* lpszPartId);

int FetchMessagePart(const QString& qsPartId);

Remarks

This method retrieves the contents of the message part specified by the PartId property of the messages specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile. If the SetMessageStream property has been used to set a stream, the message part will be stored in the specified stream. If the LocalFile property is set to an empty string and the SetMessageStream property has not been set to a stream, then the message part is stored in the MessageText property. Additionally, the Transfer will also provide the message part and denote the progress of the fetch.

The part identifiers for each message part (if any) are provided through the corresponding MessagePart events. This method retrieves the RFC 822-encoded text of the messages specified by MessageSet.

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

FetchMessagePartHeaders Method (PIMAP Class)

This method retrieves the headers of message part specified by PartID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchMessagePartHeaders(const char* lpszPartId);

Unicode (Windows)
INT FetchMessagePartHeaders(LPCWSTR lpszPartId);

int ipworksopenpgp_pimap_fetchmessagepartheaders(void* lpObj, const char* lpszPartId);

int FetchMessagePartHeaders(const QString& qsPartId);

Remarks

This method retrieves RFC 822 headers of the message part specified by PartID and stores them in the MessageHeaders property.

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

FetchMessageText Method (PIMAP Class)

This method retrieves the message text of the messages specified by the MessageSet property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchMessageText();

Unicode (Windows)
INT FetchMessageText();

int ipworksopenpgp_pimap_fetchmessagetext(void* lpObj);

int FetchMessageText();

Remarks

This method retrieves the RFC 822-encoded text of the messages specified by MessageSet. If the LocalFile property contains a file name, the text is stored in LocalFile. If the SetMessageStream property has been used to set a stream, the text will be stored in the specified stream. If the LocalFile property is set to an empty string and the SetMessageStream property has not been set to a stream, then the text is stored in the MessageText property. Additionally, the Transfer event will also provide the text and denote the progress of the fetch.

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

GetMailboxACL Method (PIMAP Class)

This method retrieves mailbox access control rights.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxACL();

Unicode (Windows)
INT GetMailboxACL();

int ipworksopenpgp_pimap_getmailboxacl(void* lpObj);

int GetMailboxACL();

Remarks

This method retrieves the mailbox access control rights, which are provided through one or more MailboxACL events. Standard rights include the following:

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

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

ListMailboxes Method (PIMAP Class)

This method lists all of the mailboxes matching all criteria in the Mailbox property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMailboxes();

Unicode (Windows)
INT ListMailboxes();

int ipworksopenpgp_pimap_listmailboxes(void* lpObj);

int ListMailboxes();

Remarks

This method lists all of the mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.

Example 1. List All Mailboxes:

IMAPControl.Mailbox = "*" IMAPControl.ListMailboxes()

Example 2. List All Mailboxes Inside INBOX:

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListMailboxes()

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

ListSubscribedMailboxes Method (PIMAP Class)

This method lists all subscribed mailboxes matching all criteria in the Mailbox property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListSubscribedMailboxes();

Unicode (Windows)
INT ListSubscribedMailboxes();

int ipworksopenpgp_pimap_listsubscribedmailboxes(void* lpObj);

int ListSubscribedMailboxes();

Remarks

This method lists all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.

Example 1. List All Subscribed Mailboxes:

IMAPControl.Mailbox = "*" IMAPControl.ListSubscribedMailboxes()

Example 2. List All Subscribed Mailboxes Inside INBOX:

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListSubscribedMailboxes()

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

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR LocalizeDate(LPCWSTR lpszDateTime);

char* ipworksopenpgp_pimap_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.

MoveToMailbox Method (PIMAP Class)

This method moves the messages specified by MessageSet to the mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveToMailbox();

Unicode (Windows)
INT MoveToMailbox();

int ipworksopenpgp_pimap_movetomailbox(void* lpObj);

int MoveToMailbox();

Remarks

This method moves the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

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

Noop Method (PIMAP Class)

This method sends a NOOP command to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Noop();

Unicode (Windows)
INT Noop();

int ipworksopenpgp_pimap_noop(void* lpObj);

int Noop();

Remarks

This method sends an IMAP NOOP command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity.)

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

RenameMailbox Method (PIMAP Class)

This method changes the name of Mailbox to NewName .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RenameMailbox(const char* lpszNewName);

Unicode (Windows)
INT RenameMailbox(LPCWSTR lpszNewName);

int ipworksopenpgp_pimap_renamemailbox(void* lpObj, const char* lpszNewName);

int RenameMailbox(const QString& qsNewName);

Remarks

This method allows a mailbox to be renamed. The mailbox is specified by the Mailbox property, and the new name is specified by the NewName parameter.

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

ResetMessageFlags Method (PIMAP Class)

This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetMessageFlags();

Unicode (Windows)
INT ResetMessageFlags();

int ipworksopenpgp_pimap_resetmessageflags(void* lpObj);

int ResetMessageFlags();

Remarks

This method replaces the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

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

SearchMailbox Method (PIMAP Class)

This method searches the selected mailbox for specified text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SearchMailbox(const char* lpszSearchCriteria);

Unicode (Windows)
INT SearchMailbox(LPCWSTR lpszSearchCriteria);

int ipworksopenpgp_pimap_searchmailbox(void* lpObj, const char* lpszSearchCriteria);

int SearchMailbox(const QString& qsSearchCriteria);

Remarks

This method searches the selected mailbox using the criteria specified in the SearchCriteria parameter. For every message matching the criteria, the FetchMessageInfo method is called and a MessageInfo event is fired.

The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include the following:

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

SelectMailbox Method (PIMAP Class)

This method selects a mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SelectMailbox();

Unicode (Windows)
INT SelectMailbox();

int ipworksopenpgp_pimap_selectmailbox(void* lpObj);

int SelectMailbox();

Remarks

This method asks the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

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

SetMailboxACL Method (PIMAP Class)

This method sets mailbox access control rights for a specific user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetMailboxACL(const char* lpszUser, const char* lpszRights);

Unicode (Windows)
INT SetMailboxACL(LPCWSTR lpszUser, LPCWSTR lpszRights);

int ipworksopenpgp_pimap_setmailboxacl(void* lpObj, const char* lpszUser, const char* lpszRights);

int SetMailboxACL(const QString& qsUser, const QString& qsRights);

Remarks

This method changes the access control list for the mailbox specified in the Mailbox property so that User is granted the permissions specified in Rights.

Rights is a string containing an optional plus ("+") or minus ("-") prefix, followed by zero or more rights characters. If the string starts with a plus, the rights are added to any existing rights for the identifier. If the string starts with a minus, the rights are removed from any existing rights for the identifier. If the string does not start with a plus or minus, the rights replace any existing rights for the identifier.

Standard rights include the following: