ListMessages Method
Lists the messages in a mailbox.
Syntax
gmail.listMessages(filter, threadId, [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 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");