gmail.users.drafts.list
Lists drafts in a user's Gmail mailbox, with optional search query and pagination, so you can review saved draft emails before sending.
Instructions
Lists the drafts in the user's mailbox. For more information, see Create and send draft emails [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, send, update.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | [query parameter] Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822 | |
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] The user's email address. The special value `me` can be used to indicate the authenticated user. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. | |
| pageToken | No | [query parameter] Page token to retrieve a specific page of results in the list. | |
| maxResults | No | [query parameter] Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500. | 100 |
| includeSpamTrash | No | [query parameter] Include drafts from `SPAM` and `TRASH` in the results. | false |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| drafts | No | ||
| nextPageToken | No | ||
| resultSizeEstimate | No |