ListDrafts Method

Lists the drafts in a mailbox.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ListDrafts(const char* lpszfilter);

Unicode (Windows)
INT ListDrafts(LPCWSTR lpszfilter);

- (void)listDrafts:(NSString*)filter;

#define MID_GMAIL_LISTDRAFTS 15

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 drafts found in the mailbox. This method populates the MessageInfo* properties.

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

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

Example (List all drafts in a mailbox)

gmail.ListDrafts("");

Example (List drafts from a specific address)

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

Example (List drafts with the 'Unread' label)

gmail.ListDrafts("is:unread");

Example (List drafts with a specific message ID)

gmail.ListDrafts("rfc822msgid:123456");

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