Google: Gmail users drafts schemas
5 Google schemas with complete fields and constraints.
← Gmail users drafts operations · All schemas
Gets the specified draft For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A draft email in the user's mailbox. |
id | string | Optional | The immutable ID of the draft. |
message | Model | Optional | Expand Gets the specified message — response body The message content of the draft. |
Referenced models: Gets the specified message — response body
Lists the drafts in the user's mailbox For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
drafts | array | Optional | List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The [`messages.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/messages/get) method can fetch additional message details. |
drafts[] | Model | Each item | Expand Gets the specified draft For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — response body |
nextPageToken | string | Optional | Token to retrieve the next page of results in the list. |
resultSizeEstimate | JSON | Optional | |
resultSizeEstimate (anyOf 1) | integer | Alternative | Estimated total number of results. Format: uint32 |
resultSizeEstimate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Gets the specified draft For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — response body
Replaces a draft's content For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A draft email in the user's mailbox. |
id | string | Optional | The immutable ID of the draft. |
message | Model | Required within parent | Expand Replaces a draft's content For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — request body — body message |
Replaces a draft's content For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — request body — body message
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An email message. |
classificationLabelValues | array | Optional | Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts. There's a limit of 20 Classification Label values per request. If the Classification Label values exceeds the maximum allowed number, the request fails. |
classificationLabelValues[] | Model | Each item | Expand Gets the specified message — response body — classification Label Values item |
historyId | string | Optional | The ID of the last history record that modified this message. Format: uint64 |
id | string | Optional | The immutable ID of the message. |
internalDate | string | 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. Format: int64 |
labelIds | array | Optional | List of IDs of labels applied to this message. |
labelIds[] | string | Each item | |
payload | Model | Optional | Expand Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers For more information, see Create and send email messages (https: developers google com workspace gmail api guides sending) — request body — body payload The parsed email structure in the message parts. |
raw | string | Required within parent | 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. @required gmail.users.drafts.create gmail.users.drafts.update Format: byte |
sizeEstimate | integer | Optional | Estimated size in bytes of the message. Format: int32 |
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](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. |
Referenced models: Gets the specified message — response body — classification Label Values item, Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers For more information, see Create and send email messages (https: developers google com workspace gmail api guides sending) — request body — body payload
Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers For more information, see Create and send draft emails (https: developers google com workspace gmail api guides drafts) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A draft email in the user's mailbox. |
id | string | Required within parent | The immutable ID of the draft. |
message | Model | Optional | Expand Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing This method does not send a message Note that the maximum size of the message is 150 MB — request body — body The message content of the draft. |