IMAP Class

Properties   Methods   Events   Config Settings   Errors  

The IMAP Class is used to communicate with IMAP servers using the Internet Message Access Protocol (IMAP).

Syntax

IMAP

Remarks

The IMAP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2595). When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The IMAP Class implements a standard IMAP client as specified in RFC 1730 and RFC 2060.

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.

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 show the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent using 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 and MessageFlags.

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

The MessagePart event describes the MIME structure of the 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 RetrieveMessagePart method. This speeds up processing by avoiding the need to retrieve full messages from the server.

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 (IMAP 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 ipworks_imap_getauthmechanism(void* lpObj);
int ipworks_imap_setauthmechanism(void* lpObj, int iAuthMechanism);

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

Default Value

0

Remarks

Data Type

Integer

AutoDecodeParts Property (IMAP 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 ipworks_imap_getautodecodeparts(void* lpObj);
int ipworks_imap_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

Connected Property (IMAP Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworks_imap_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

EndByte Property (IMAP 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 ipworks_imap_getendbyte(void* lpObj);
int ipworks_imap_setendbyte(void* lpObj, int64 lEndByte);

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

Default Value

0

Remarks

StartByte and EndByte are used together with the RetrieveMessagePart 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

Firewall Property (IMAP Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int ipworks_imap_getfirewallautodetect(void* lpObj);
int ipworks_imap_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworks_imap_getfirewalltype(void* lpObj);
int ipworks_imap_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworks_imap_getfirewallhost(void* lpObj);
int ipworks_imap_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworks_imap_getfirewallpassword(void* lpObj);
int ipworks_imap_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworks_imap_getfirewallport(void* lpObj);
int ipworks_imap_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworks_imap_getfirewalluser(void* lpObj);
int ipworks_imap_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

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

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

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

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

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

Remarks

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

Data Type

IPWorksFirewall

Idle Property (IMAP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_imap_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LastReply Property (IMAP Class)

This property indicates the last reply received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastReply();

Unicode (Windows)
LPWSTR GetLastReply();

char* ipworks_imap_getlastreply(void* lpObj);

QString GetLastReply();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

LocalFile Property (IMAP Class)

This property includes the path to a local file for downloading the message body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* ipworks_imap_getlocalfile(void* lpObj);
wchar_t* ipworks_imap_getlocalfile_W(void* lpObj); // Windows only
int ipworks_imap_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_imap_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property is used when retrieving a message. If the file exists, and the Overwrite property is set to true, then the component will overwrite the file.

If this property is empty and the SetMessageStream method has not been used to set a stream, then the received data is provided through the MessageText property and the parameters for the Transfer event. The SetMessageStream method and the LocalFile property will reset each other when set.

Data Type

String

LocalHost Property (IMAP 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* ipworks_imap_getlocalhost(void* lpObj);
int ipworks_imap_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

Mailbox Property (IMAP 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* ipworks_imap_getmailbox(void* lpObj);
int ipworks_imap_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 (IMAP Class)

This property defines flags in the selected mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailboxFlags();

Unicode (Windows)
LPWSTR GetMailboxFlags();

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

MailboxList Property (IMAP Class)

The property includes the collection of mailboxes listed by the server.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksMailbox>* GetMailboxList();

int ipworks_imap_getmailboxlistcount(void* lpObj);

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

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

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

int GetMailboxListCount();

QString GetMailboxListFlags(int iMailboxListIndex);

QString GetMailboxListName(int iMailboxListIndex);

QString GetMailboxListSeparator(int iMailboxListIndex);

Remarks

This collection contains a list of mailboxes returned by the server when ListMailboxes or ListSubscribedMailboxes is called.

MailboxLimit can be used to control the number of mailboxes saved.

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

Data Type

IPWorksMailbox

MailPort Property (IMAP 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 ipworks_imap_getmailport(void* lpObj);
int ipworks_imap_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 (IMAP 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* ipworks_imap_getmailserver(void* lpObj);
int ipworks_imap_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 (IMAP 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 ipworks_imap_getmessage(void* lpObj, char** lpMessage, int* lenMessage);
int ipworks_imap_setmessage(void* lpObj, const char* lpMessage, int lenMessage);

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

Default Value

""

Remarks

This property is populated after calling RetrieveMessagePart 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 (IMAP Class)

This property includes the ContentEncoding of the selected message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageContentEncoding();

Unicode (Windows)
LPWSTR GetMessageContentEncoding();

char* ipworks_imap_getmessagecontentencoding(void* lpObj);

QString GetMessageContentEncoding();

Default Value

""

Remarks

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

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

Data Type

String

MessageContentType Property (IMAP Class)

This property includes the ContentType of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageContentType();

Unicode (Windows)
LPWSTR GetMessageContentType();

char* ipworks_imap_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 (IMAP 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 ipworks_imap_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 (IMAP Class)

The property includes the time the message was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageDate();

Unicode (Windows)
LPWSTR GetMessageDate();

char* ipworks_imap_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 (IMAP 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* ipworks_imap_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 (IMAP 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* ipworks_imap_getmessageflags(void* lpObj);
int ipworks_imap_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 (IMAP 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* ipworks_imap_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

MessageHeaders Property (IMAP Class)

This property includes the collection of RFC 822-encoded headers of the message.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHeader>* GetMessageHeaders();
int SetMessageHeaders(IPWorksList<IPWorksHeader>* val);

int ipworks_imap_getmessageheadercount(void* lpObj);
int ipworks_imap_setmessageheadercount(void* lpObj, int iMessageHeaderCount);

char* ipworks_imap_getmessageheaderfield(void* lpObj, int messageheaderindex);
int ipworks_imap_setmessageheaderfield(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderField);

char* ipworks_imap_getmessageheadervalue(void* lpObj, int messageheaderindex);
int ipworks_imap_setmessageheadervalue(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderValue);

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

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

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

Remarks

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

This property is not available at design time.

Data Type

IPWorksHeader

MessageHeadersString Property (IMAP 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* ipworks_imap_getmessageheadersstring(void* lpObj);
int ipworks_imap_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 RetrieveMessageHeaders or the RetrieveMessagePartHeaders method.

This property is not available at design time.

Data Type

String

MessageId Property (IMAP 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* ipworks_imap_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

MessageInfo Property (IMAP Class)

This property includes the collection of messages retrieved by RetrieveMessageInfo .

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksMessageInfo>* GetMessageInfo();

int ipworks_imap_getmessageinfocount(void* lpObj);

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

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

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

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

int64 ipworks_imap_getmessageinfosize(void* lpObj, int messageinfoindex);

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

int GetMessageInfoCount();

QString GetMessageInfoDate(int iMessageInfoIndex);

QString GetMessageInfoFlags(int iMessageInfoIndex);

QString GetMessageInfoFrom(int iMessageInfoIndex);

QString GetMessageInfoMessageId(int iMessageInfoIndex);

qint64 GetMessageInfoSize(int iMessageInfoIndex);

QString GetMessageInfoSubject(int iMessageInfoIndex);

Remarks

This property is populated when messages are searched or listed or when message information is received from the server. The collection contains a list of each message's MessageInfo as returned by the server.

MessageInfoLimit can be used to control the number of MessageInfos saved.

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

Data Type

IPWorksMessageInfo

MessageInReplyTo Property (IMAP 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* ipworks_imap_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 (IMAP 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* ipworks_imap_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

MessageParts Property (IMAP Class)

This property includes a collection of message parts collected by RetrieveMessageInfo .

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksMessagePart>* GetMessageParts();

int ipworks_imap_getmessagepartcount(void* lpObj);

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

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

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

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

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

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

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

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

int64 ipworks_imap_getmessagepartsize(void* lpObj, int messagepartindex);

int GetMessagePartCount();

QString GetMessagePartContentDisposition(int iMessagePartIndex);

QString GetMessagePartContentEncoding(int iMessagePartIndex);

QString GetMessagePartContentId(int iMessagePartIndex);

QString GetMessagePartContentType(int iMessagePartIndex);

QString GetMessagePartFileName(int iMessagePartIndex);

QString GetMessagePartId(int iMessagePartIndex);

QString GetMessagePartMultipartMode(int iMessagePartIndex);

QString GetMessagePartParameters(int iMessagePartIndex);

qint64 GetMessagePartSize(int iMessagePartIndex);

Remarks

This property contains a collection of message parts that is populated when you call RetrieveMessageInfo. Once the message is received from the server, the class parses the different parts and their corresponding information into the MESSAGEPARTS collection. Each MessagePart contains a unique Id.

MessagePartLimit can be used to control the number of message parts saved.

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

Data Type

IPWorksMessagePart

MessageRecipients Property (IMAP Class)

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

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksMessageRecipient>* GetMessageRecipients();

int ipworks_imap_getmessagerecipientcount(void* lpObj);

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

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

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

int ipworks_imap_getmessagerecipienttype(void* lpObj, int recipientindex);

int GetMessageRecipientCount();

QString GetMessageRecipientAddress(int iRecipientIndex);

QString GetMessageRecipientName(int iRecipientIndex);

QString GetMessageRecipientOptions(int iRecipientIndex);

int GetMessageRecipientType(int iRecipientIndex);

Remarks

This property contains a collection of the people to whom the message was sent. Each MessageRecipient contains information describing that recipient, and what type of recipient it is. This collection is populated when the RetrieveMessageInfo method is called.

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

Data Type

IPWorksMessageRecipient

MessageReplyTo Property (IMAP 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* ipworks_imap_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 (IMAP 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* ipworks_imap_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 (IMAP 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* ipworks_imap_getmessageset(void* lpObj);
int ipworks_imap_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.RetrieveMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.RetrieveMessageInfo()

Data Type

String

MessageSize Property (IMAP Class)

This property includes the size of the selected message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageSize();

Unicode (Windows)
LONG64 GetMessageSize();

int64 ipworks_imap_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 (IMAP Class)

This property includes the subject of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSubject();

Unicode (Windows)
LPWSTR GetMessageSubject();

char* ipworks_imap_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 (IMAP 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* ipworks_imap_getmessagetext(void* lpObj);
int ipworks_imap_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 RetrieveMessageText 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 (IMAP 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 ipworks_imap_getoverwrite(void* lpObj);
int ipworks_imap_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 (IMAP 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* ipworks_imap_getpassword(void* lpObj);
int ipworks_imap_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 (IMAP 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 ipworks_imap_getpeekmode(void* lpObj);
int ipworks_imap_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 (IMAP 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 ipworks_imap_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

SortCriteria Property (IMAP 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* ipworks_imap_getsortcriteria(void* lpObj);
int ipworks_imap_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 retrieve 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

SSLAcceptServerCert Property (IMAP Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworks_imap_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_imap_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_imap_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_imap_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_imap_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_imap_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_imap_getsslacceptservercertissuer(void* lpObj);

char* ipworks_imap_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_imap_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_imap_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_imap_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_imap_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_imap_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_imap_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_imap_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_imap_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_imap_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_imap_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_imap_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_imap_getsslacceptservercertstoretype(void* lpObj);
int ipworks_imap_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_imap_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_imap_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_imap_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_imap_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_imap_getsslacceptservercertusage(void* lpObj);

int ipworks_imap_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_imap_getsslacceptservercertversion(void* lpObj);

char* ipworks_imap_getsslacceptservercertsubject(void* lpObj);
int ipworks_imap_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks_imap_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_imap_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

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

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

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

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

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

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

Remarks

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

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

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

Data Type

IPWorksCertificate

SSLCert Property (IMAP Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworks_imap_getsslcerteffectivedate(void* lpObj);

char* ipworks_imap_getsslcertexpirationdate(void* lpObj);

char* ipworks_imap_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_imap_getsslcertfingerprint(void* lpObj);

char* ipworks_imap_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_imap_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_imap_getsslcertissuer(void* lpObj);

char* ipworks_imap_getsslcertprivatekey(void* lpObj);

int ipworks_imap_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_imap_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_imap_getsslcertpublickey(void* lpObj);

char* ipworks_imap_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_imap_getsslcertpublickeylength(void* lpObj);

char* ipworks_imap_getsslcertserialnumber(void* lpObj);

char* ipworks_imap_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_imap_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_imap_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_imap_getsslcertstorepassword(void* lpObj);
int ipworks_imap_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_imap_getsslcertstoretype(void* lpObj);
int ipworks_imap_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_imap_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_imap_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_imap_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_imap_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_imap_getsslcertusage(void* lpObj);

int ipworks_imap_getsslcertusageflags(void* lpObj);

char* ipworks_imap_getsslcertversion(void* lpObj);

char* ipworks_imap_getsslcertsubject(void* lpObj);
int ipworks_imap_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks_imap_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_imap_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

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

Data Type

IPWorksCertificate

SSLEnabled Property (IMAP Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C++
• C
• Qt

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

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

int ipworks_imap_getsslenabled(void* lpObj);
int ipworks_imap_setsslenabled(void* lpObj, int bSSLEnabled);

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

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (IMAP Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int ipworks_imap_getsslprovider(void* lpObj);
int ipworks_imap_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCert Property (IMAP Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_imap_getsslservercerteffectivedate(void* lpObj);

char* ipworks_imap_getsslservercertexpirationdate(void* lpObj);

char* ipworks_imap_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_imap_getsslservercertfingerprint(void* lpObj);

char* ipworks_imap_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_imap_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_imap_getsslservercertissuer(void* lpObj);

char* ipworks_imap_getsslservercertprivatekey(void* lpObj);

int ipworks_imap_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_imap_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_imap_getsslservercertpublickey(void* lpObj);

char* ipworks_imap_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_imap_getsslservercertpublickeylength(void* lpObj);

char* ipworks_imap_getsslservercertserialnumber(void* lpObj);

char* ipworks_imap_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworks_imap_getsslservercertstorepassword(void* lpObj);

int ipworks_imap_getsslservercertstoretype(void* lpObj);

char* ipworks_imap_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_imap_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_imap_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_imap_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_imap_getsslservercertusage(void* lpObj);

int ipworks_imap_getsslservercertusageflags(void* lpObj);

char* ipworks_imap_getsslservercertversion(void* lpObj);

char* ipworks_imap_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksCertificate

SSLStartMode Property (IMAP Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

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

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

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

int ipworks_imap_getsslstartmode(void* lpObj);
int ipworks_imap_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 (IMAP 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 ipworks_imap_getstartbyte(void* lpObj);
int ipworks_imap_setstartbyte(void* lpObj, int64 lStartByte);

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

Default Value

0

Remarks

StartByte and EndByte are used together with the RetrieveMessagePart 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 (IMAP Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int ipworks_imap_gettimeout(void* lpObj);
int ipworks_imap_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UIDMode Property (IMAP 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 ipworks_imap_getuidmode(void* lpObj);
int ipworks_imap_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 (IMAP 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* ipworks_imap_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 (IMAP 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* ipworks_imap_getuser(void* lpObj);
int ipworks_imap_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 (IMAP 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 ipworks_imap_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 (IMAP 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 ipworks_imap_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 (IMAP Class)

This method sends a CHECK command to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckMailbox();

Unicode (Windows)
INT CheckMailbox();

int ipworks_imap_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 (IMAP 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 ipworks_imap_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 (IMAP 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* ipworks_imap_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 (IMAP Class)

This method connects to an IMAP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworks_imap_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 (IMAP Class)

Copies the specified messages to another mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CopyToMailbox();

Unicode (Windows)
INT CopyToMailbox();

int ipworks_imap_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 (IMAP Class)

This method creates a new mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateMailbox();

Unicode (Windows)
INT CreateMailbox();

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

DeleteFromMailbox Method (IMAP 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 ipworks_imap_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 (IMAP Class)

This method deletes a mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteMailbox();

Unicode (Windows)
INT DeleteMailbox();

int ipworks_imap_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 (IMAP 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 ipworks_imap_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 (IMAP Class)

This method disconnects from an IMAP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworks_imap_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 (IMAP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_imap_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 (IMAP Class)

This method selects a mailbox in read-only mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExamineMailbox();

Unicode (Windows)
INT ExamineMailbox();

int ipworks_imap_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 (IMAP 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 ipworks_imap_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.)

GetMailboxACL Method (IMAP Class)

This method retrieves mailbox access control rights.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMailboxACL();

Unicode (Windows)
INT GetMailboxACL();

int ipworks_imap_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 (IMAP Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_imap_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 (IMAP 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 ipworks_imap_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 (IMAP 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 ipworks_imap_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 (IMAP 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* ipworks_imap_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 (IMAP Class)

Copies the specified messages to another mailbox and marks the original messages as deleted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveToMailbox();

Unicode (Windows)
INT MoveToMailbox();

int ipworks_imap_movetomailbox(void* lpObj);

int MoveToMailbox();

Remarks

This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property. Additionally, the messages in the original mailbox are marked as deleted.

Calling this method is equivalent to calling the CopyToMailbox method immediately followed by the DeleteFromMailbox method.

Error Handling (C++)

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

Noop Method (IMAP Class)

This method sends a NOOP command to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Noop();

Unicode (Windows)
INT Noop();

int ipworks_imap_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 (IMAP 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 ipworks_imap_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.)

Reset Method (IMAP Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_imap_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

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 (IMAP 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 ipworks_imap_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.)

RetrieveMessageHeaders Method (IMAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessageHeaders();

Unicode (Windows)
INT RetrieveMessageHeaders();

int ipworks_imap_retrievemessageheaders(void* lpObj);

int RetrieveMessageHeaders();

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

RetrieveMessageInfo Method (IMAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessageInfo();

Unicode (Windows)
INT RetrieveMessageInfo();

int ipworks_imap_retrievemessageinfo(void* lpObj);

int RetrieveMessageInfo();

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

RetrieveMessagePart Method (IMAP Class)

This method retrieves the message part specified by PartID.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT RetrieveMessagePart(LPCWSTR lpszPartId);

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

int RetrieveMessagePart(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 retrieval.

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

RetrieveMessagePartHeaders Method (IMAP Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT RetrieveMessagePartHeaders(LPCWSTR lpszPartId);

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

int RetrieveMessagePartHeaders(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.)

RetrieveMessageText Method (IMAP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessageText();

Unicode (Windows)
INT RetrieveMessageText();

int ipworks_imap_retrievemessagetext(void* lpObj);

int RetrieveMessageText();

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

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 (IMAP 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 ipworks_imap_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 RetrieveMessageInfo 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 (IMAP Class)

This method selects a mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SelectMailbox();

Unicode (Windows)
INT SelectMailbox();

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

SendCommand Method (IMAP Class)

This method sends the exact command directly to the server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);

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

int SendCommand(const QString& qsCommand);

Remarks

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

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

Error Handling (C++)

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

SetMailboxACL Method (IMAP 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 ipworks_imap_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:

Error Handling (C++)

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

SetMessageStream Method (IMAP Class)

This method sets the stream to which the message (or message part) downloaded from the server will be written.

Syntax

• C++
• C
• Qt

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

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

int ipworks_imap_setmessagestream(void* lpObj, IPWorksStream* sMessageStream);

int SetMessageStream(IPWorksStream* sMessageStream);

Remarks

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

Note: SetMessageStream and LocalFile will reset the other.

Error Handling (C++)

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

StartIdle Method (IMAP Class)

This method begins idling.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartIdle();

Unicode (Windows)
INT StartIdle();

int ipworks_imap_startidle(void* lpObj);

int StartIdle();

Remarks

This method sends the IDLE command to the server and begins idling. As responses are received from the server the IdleInfo event fires. To stop idling, call StopIdle.

If the class is being used in a formless application (such as a console application) be sure to call DoEvents in a loop after calling this method to ensure that incoming events are processed.

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

StopIdle Method (IMAP Class)

This method stops idling.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopIdle();

Unicode (Windows)
INT StopIdle();

int ipworks_imap_stopidle(void* lpObj);

int StopIdle();

Remarks

This method stops idling if it was previously started via StartIdle. If the class is not idling, this method does 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.)

SubscribeMailbox Method (IMAP Class)

This method subscribes to the mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SubscribeMailbox();

Unicode (Windows)
INT SubscribeMailbox();

int ipworks_imap_subscribemailbox(void* lpObj);

int SubscribeMailbox();

Remarks

This method subscribes 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.)

UnsetMessageFlags Method (IMAP Class)

This method removes the flags specified by MessageFlags from the messages specified by MessageSet .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UnsetMessageFlags();

Unicode (Windows)
INT UnsetMessageFlags();

int ipworks_imap_unsetmessageflags(void* lpObj);

int UnsetMessageFlags();

Remarks

This method removes the flags specified by the MessageFlags property from 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:

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

UnsubscribeMailbox Method (IMAP Class)

This method unsubscribes from the mailbox specified by Mailbox .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UnsubscribeMailbox();

Unicode (Windows)
INT UnsubscribeMailbox();

int ipworks_imap_unsubscribemailbox(void* lpObj);

int UnsubscribeMailbox();

Remarks

This method unsubscribes from 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.)

ConnectionStatus Event (IMAP Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_CONNECTIONSTATUS 1

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

class IMAPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

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

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

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

Remarks

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

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

EndTransfer Event (IMAP Class)

This event is fired when the message or the part data finishes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_ENDTRANSFER 2

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class IMAPEndTransferEventParams {
public:
  int Direction();

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

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

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

Remarks

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

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

Error Event (IMAP Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_ERROR 3

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

class IMAPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (IMAP Class)

This event is fired every time a header line comes in.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_HEADER 4

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

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

  const QString &Value();

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

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

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

Remarks

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

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

IdleInfo Event (IMAP Class)

This event fires whenever responses from the server are received while idling.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireIdleInfo(IMAPIdleInfoEventParams *e);

typedef struct {
  const char *Message;
  int Cancel;
  int reserved;
} IMAPIdleInfoEventParams;


Unicode (Windows)
virtual INT FireIdleInfo(IMAPIdleInfoEventParams *e);

typedef struct {
  LPCWSTR Message;
  BOOL Cancel;
  INT reserved;
} IMAPIdleInfoEventParams;

#define EID_IMAP_IDLEINFO 5

virtual INT IPWORKS_CALL FireIdleInfo(LPSTR &lpszMessage, BOOL &bCancel);

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

  bool Cancel();
  void SetCancel(bool bCancel);

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

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

// Or, subclass IMAP and override this emitter function.
virtual int FireIdleInfo(IMAPIdleInfoEventParams *e) {...}

Remarks

This event fires each time a response is received from the server after calling StartIdle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling StopIdle.

The following are possible values returned by the server:

+ idling
* 43 EXISTS
* 1 RECENT

MailboxACL Event (IMAP Class)

This event fires for each set of access control rights returned by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMailboxACL(IMAPMailboxACLEventParams *e);

typedef struct {
  const char *Mailbox;
  const char *User;
  const char *Rights;
  int reserved;
} IMAPMailboxACLEventParams;


Unicode (Windows)
virtual INT FireMailboxACL(IMAPMailboxACLEventParams *e);

typedef struct {
  LPCWSTR Mailbox;
  LPCWSTR User;
  LPCWSTR Rights;
  INT reserved;
} IMAPMailboxACLEventParams;

#define EID_IMAP_MAILBOXACL 6

virtual INT IPWORKS_CALL FireMailboxACL(LPSTR &lpszMailbox, LPSTR &lpszUser, LPSTR &lpszRights);

class IMAPMailboxACLEventParams {
public:
  const QString &Mailbox();

  const QString &User();

  const QString &Rights();

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

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

// Or, subclass IMAP and override this emitter function.
virtual int FireMailboxACL(IMAPMailboxACLEventParams *e) {...}

Remarks

The event fires for each set of access control rights returned by the server after a call to GetMailboxACL. Standard rights include the following:

MailboxList Event (IMAP Class)

This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMailboxList(IMAPMailboxListEventParams *e);

typedef struct {
  const char *Mailbox;
  const char *Separator;
  const char *Flags;
  int reserved;
} IMAPMailboxListEventParams;


Unicode (Windows)
virtual INT FireMailboxList(IMAPMailboxListEventParams *e);

typedef struct {
  LPCWSTR Mailbox;
  LPCWSTR Separator;
  LPCWSTR Flags;
  INT reserved;
} IMAPMailboxListEventParams;

#define EID_IMAP_MAILBOXLIST 7

virtual INT IPWORKS_CALL FireMailboxList(LPSTR &lpszMailbox, LPSTR &lpszSeparator, LPSTR &lpszFlags);

class IMAPMailboxListEventParams {
public:
  const QString &Mailbox();

  const QString &Separator();

  const QString &Flags();

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

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

// Or, subclass IMAP and override this emitter function.
virtual int FireMailboxList(IMAPMailboxListEventParams *e) {...}

Remarks

This method is fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. The Separator parameter contains the character that separates the different parts in the mailbox path hierarchy.

MessageInfo Event (IMAP Class)

This event is fired with information for the messages retrieved by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageInfo(IMAPMessageInfoEventParams *e);

typedef struct {
  const char *MessageId;
  const char *Subject;
  const char *MessageDate;
  const char *From;
  const char *Flags;
  int64 Size;
  int reserved;
} IMAPMessageInfoEventParams;


Unicode (Windows)
virtual INT FireMessageInfo(IMAPMessageInfoEventParams *e);

typedef struct {
  LPCWSTR MessageId;
  LPCWSTR Subject;
  LPCWSTR MessageDate;
  LPCWSTR From;
  LPCWSTR Flags;
  LONG64 Size;
  INT reserved;
} IMAPMessageInfoEventParams;

#define EID_IMAP_MESSAGEINFO 8

virtual INT IPWORKS_CALL FireMessageInfo(LPSTR &lpszMessageId, LPSTR &lpszSubject, LPSTR &lpszMessageDate, LPSTR &lpszFrom, LPSTR &lpszFlags, LONG64 &lSize);

class IMAPMessageInfoEventParams {
public:
  const QString &MessageId();

  const QString &Subject();

  const QString &MessageDate();

  const QString &From();

  const QString &Flags();

  qint64 Size();

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

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

// Or, subclass IMAP and override this emitter function.
virtual int FireMessageInfo(IMAPMessageInfoEventParams *e) {...}

Remarks

The MessageInfo event is fired when messages are searched, listed, or message information is received.

Id is the Id of the message.

Subject is the message subject.

MessageDate is the date of the message.

From is the email address of the sender.

Flags is a list of flags associated with this message.

Size is the size of the message.

More information may be received from the respective properties, such as the following: MessageContentType, MessageContentEncoding, MessageRecipients, MessageDeliveryTime, MessageFlags, MessageHeaders, MessageInReplyTo, MessageNetId, MessageReplyTo, MessageSender, MessageSize, MessageSubject, MessageText, etc.

MessagePart Event (IMAP Class)

This event is fired for each message part when RetrieveMessageInfo is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessagePart(IMAPMessagePartEventParams *e);

typedef struct {
  const char *PartId;
  int64 Size;
  const char *ContentType;
  const char *FileName;
  const char *ContentEncoding;
  const char *Parameters;
  const char *MultipartMode;
  const char *ContentId;
  const char *ContentDisposition;
  int reserved;
} IMAPMessagePartEventParams;


Unicode (Windows)
virtual INT FireMessagePart(IMAPMessagePartEventParams *e);

typedef struct {
  LPCWSTR PartId;
  LONG64 Size;
  LPCWSTR ContentType;
  LPCWSTR FileName;
  LPCWSTR ContentEncoding;
  LPCWSTR Parameters;
  LPCWSTR MultipartMode;
  LPCWSTR ContentId;
  LPCWSTR ContentDisposition;
  INT reserved;
} IMAPMessagePartEventParams;

#define EID_IMAP_MESSAGEPART 9

virtual INT IPWORKS_CALL FireMessagePart(LPSTR &lpszPartId, LONG64 &lSize, LPSTR &lpszContentType, LPSTR &lpszFileName, LPSTR &lpszContentEncoding, LPSTR &lpszParameters, LPSTR &lpszMultipartMode, LPSTR &lpszContentId, LPSTR &lpszContentDisposition);

class IMAPMessagePartEventParams {
public:
  const QString &PartId();

  qint64 Size();

  const QString &ContentType();

  const QString &FileName();

  const QString &ContentEncoding();

  const QString &Parameters();

  const QString &MultipartMode();

  const QString &ContentId();

  const QString &ContentDisposition();

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

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

// Or, subclass IMAP and override this emitter function.
virtual int FireMessagePart(IMAPMessagePartEventParams *e) {...}

Remarks

The PartId parameter denotes the PartId that may be identified in other parts or messages. The format of PartIds is specified by the IMAP RFCs.

The Size parameter gives the size of this part.

The ContentType parameter shows the type of data contained in the part.

The ContentEncoding parameter shows how data are encoded.

The FileName parameter shows the filename corresponding to the part (if the part was included in the message as an attached file).

The Parameters parameter contains the additional parameters passed to the ContentType header, such as the part charset.

The MultipartMode parameter shows the how this part relates to the message's whole multipart structure (e.g., 'mixed', 'alternative', etc.).

The ContentId parameter shows the value of the Content-Id header for the part.

The ContentDisposition parameter shows the value of the Content-Disposition header for the part.

PITrail Event (IMAP Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_PITRAIL 10

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

class IMAPPITrailEventParams {
public:
  int Direction();

  const QString &Message();

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

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

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

Remarks

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

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

SSLServerAuthentication Event (IMAP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_SSLSERVERAUTHENTICATION 11

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

class IMAPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

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

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

// Or, subclass IMAP and override this emitter function.
virtual int FireSSLServerAuthentication(IMAPSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IMAP Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_SSLSTATUS 12

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartTransfer Event (IMAP Class)

This event is fired when the message body or the part data start transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_IMAP_STARTTRANSFER 13

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);

class IMAPStartTransferEventParams {
public:
  int Direction();

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

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

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

Remarks

The StartTransfer event is fired when the message body or the part data start transferring from the server to the local host. Further progress information is provided by the Transfer and EndTransfer events.

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

Transfer Event (IMAP Class)

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

Syntax

• C++
• C
• Qt

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

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int reserved;
} IMAPTransferEventParams;


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

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCWSTR Text;
  INT reserved;
} IMAPTransferEventParams;

#define EID_IMAP_TRANSFER 14

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpszText);

class IMAPTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QString &Text();

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

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

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

Remarks

The Transfer event is fired for every incoming line when receiving a message or part data from the MailServer

The Text parameter contains the portion of the message or the part data being retrieved.

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

The Transfer event is fired for every line of the message. There is no terminating newline at the end of the Text parameter. A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event to check the progress only rather than to get the actual data.

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksCertificate (declared in ipworks.h)

Remarks

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

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

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

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksFirewall (declared in ipworks.h)

Remarks

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

Fields

Constructors

Firewall()

Header Type

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

Syntax

IPWorksHeader (declared in ipworks.h)

Remarks

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

Fields

Constructors

Header()

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

Mailbox Type

This type includes mailboxes collected when calling ListMailboxes or ListSubscribedMailboxes .

Syntax

IPWorksMailbox (declared in ipworks.h)

Remarks

This type includes the information for each mailbox as it is returned by the server after either ListMailboxes or ListSubscribedMailboxes have been called.