Stay organized with collections Save and categorize content based on your preferences.
Lists the drafts in the user's mailbox.
HTTP requestGET https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts
The URL uses gRPC Transcoding syntax.
Path parameters ParametersuserId
string
The user's email address. The special value me
can be used to indicate the authenticated user.
maxResults
integer (uint32 format)
Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.
pageToken
string
Page token to retrieve a specific page of results in the list.
q
string
Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"
.
includeSpamTrash
boolean
Include drafts from SPAM
and TRASH
in the results.
The request body must be empty.
Response bodyIf successful, the response body contains data with the following structure:
JSON representation{
"drafts": [
{
object (Draft
)
}
],
"nextPageToken": string,
"resultSizeEstimate": integer
}
Fields drafts[]
object (
Draft
)
List of drafts. Note that the Message
property in each Draft
resource only contains an id
and a threadId
. The messages.get
method can fetch additional message details.
nextPageToken
string
Token to retrieve the next page of results in the list.
resultSizeEstimate
integer (uint32 format)
Estimated total number of results.
Requires one of the following OAuth scopes:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.compose
https://www.googleapis.com/auth/gmail.readonly
For more information, see the Authorization guide.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4