Gmail API

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

POST

users

Creates a new draft with the DRAFT label.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gmail.googleapis.com//gmail/v1/users//drafts' \
--header 'Content-Type: text/plain' \
--data-raw ''

Response Example

{
  "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"
  }
}

Request

Path Params

userId

string

required

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

Responses

🟢200Successful response

application/json

Body

A draft email in the user's mailbox.

string

optional

The immutable ID of the draft.

message

object (Message)

optional

The message content of the draft.

historyId

string <uint64>

optional

The ID of the last history record that modified this message.

string

optional

The immutable ID of the message.

internalDate

string <int64>

optional

The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.

labelIds

array[string]

optional

List of IDs of labels applied to this message.

payload

object (MessagePart)

optional

The parsed email structure in the message parts.

raw

string <byte>

optional

The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.

sizeEstimate

integer <int32>

optional

Estimated size in bytes of the message.

snippet

string

optional

A short part of the message text.

threadId

string

optional

The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested threadId must be specified on the Message or Draft.Message you supply with your request. 2. The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. 3. The Subject headers must match.

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

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

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