list_drafts Method

Lists the drafts in a mailbox.

Syntax

def list_drafts(filter: str) -> None: ...

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, next_page_token will be populated and calling list_drafts 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");