Gmail API

/gmail/v1/users/{userId}/drafts

GET

users

Lists the drafts in the user's mailbox.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//drafts'

Response Example

{
  "drafts": [
    {
      "id": "string",
      "message": {
        "historyId": "string",
        "id": "string",
        "internalDate": "string",
        "labelIds": [
          "string"
        ],
        "payload": {
          "body": {
            "attachmentId": "string",
            "data": "string",
            "size": 0
          },
          "filename": "string",
          "headers": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "mimeType": "string",
          "partId": "string",
          "parts": [
            {}
          ]
        },
        "raw": "string",
        "sizeEstimate": 0,
        "snippet": "string",
        "threadId": "string"
      }
    }
  ],
  "nextPageToken": "string",
  "resultSizeEstimate": 0
}

Request

Path Params

userId

string

required

The user's email address. The special value me can be used to indicate the authenticated user.

Query Params

includeSpamTrash

string

optional

Include drafts from SPAM and TRASH in the results.

maxResults

integer

optional

Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.

pageToken

string

optional

Page token to retrieve a specific page of results in the list.

string

optional

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: is:unread".

Responses

🟢200Successful response

application/json

Body

drafts

array[object (Draft) {2}]

optional

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.

string

optional

The immutable ID of the draft.

message

object (Message)

optional

The message content of the draft.

nextPageToken

string

optional

Token to retrieve the next page of results in the list.

resultSizeEstimate

integer <uint32>

optional

Estimated total number of results.

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/drafts