ListDrafts Method

Lists the drafts in a mailbox.

Syntax

gmail.listDrafts(filter, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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");