ListMessages Method

Lists the messages in a mailbox.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ListMessages(const char* lpszfilter, const char* lpszthreadId);

Unicode (Windows)
INT ListMessages(LPCWSTR lpszfilter, LPCWSTR lpszthreadId);

- (void)listMessages:(NSString*)filter :(NSString*)threadId;

#define MID_GMAIL_LISTMESSAGES 16

CLOUDMAIL_EXTERNAL int CLOUDMAIL_CALL CloudMail_GMail_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method lists the messages found in the mailbox. This method populates the MessageInfo* properties.

If the number of messages is greater than the message page size, NextPageToken will be populated and calling ListMessages again will list the next page of messages.

filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a mailbox.

threadId can be used to retrieve a specific subset of messages from a specific thread, or it can be left as an empty string to retrieve all messages in a mailbox.

Example (List all messages in a mailbox)

gmail.ListMessages("", "");

Example (List messages from a specific address)

gmail.ListMessages("from:someuser@example.com", "");

Example (List messages with the 'Unread' label)

gmail.ListMessages("is:unread", "");

Example (List messages with a specific message ID)

gmail.ListMessages("rfc822msgid:123456", "");

Example (List Messages from a specific thread)

gmail.ListMessages("", "123456789");

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