chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/gmail_v1.users.drafts.html b/docs/dyn/gmail_v1.users.drafts.html
index ba14536..f5b8abc 100644
--- a/docs/dyn/gmail_v1.users.drafts.html
+++ b/docs/dyn/gmail_v1.users.drafts.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(userId, id, format=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified draft.</p>
<p class="toc_element">
- <code><a href="#list">list(userId, q=None, includeSpamTrash=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(userId, maxResults=None, includeSpamTrash=None, q=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the drafts in the user's mailbox.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -114,39 +114,39 @@
The object takes the form of:
{ # A draft email in the user's mailbox.
- "message": { # An email message. # The message content of the draft.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
+ "id": "A String", # The immutable ID of the draft.
+ "message": { # An email message. # The message content of the draft.
+ "threadId": "A String", # 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.
+ "labelIds": [ # List of IDs of labels applied to this message.
+ "A String",
+ ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
+ "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
+ # Object with schema name: MessagePart
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
+ {
+ "name": "A String", # The name of the header before the `:` separator. For example, `To`.
+ "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
- "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
- # Object with schema name: MessagePart
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
- "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
- {
- "name": "A String", # The name of the header before the `:` separator. For example, `To`.
- "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
- },
- ],
+ ],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
},
- "raw": "A String", # 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.
- "snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
- "historyId": "A String", # The ID of the last history record that modified this message.
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "id": "A String", # The immutable ID of the draft.
- }
+ "snippet": "A String", # A short part of the message text.
+ "historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -159,39 +159,39 @@
An object of the form:
{ # A draft email in the user's mailbox.
- "message": { # An email message. # The message content of the draft.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
+ "id": "A String", # The immutable ID of the draft.
+ "message": { # An email message. # The message content of the draft.
+ "threadId": "A String", # 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.
+ "labelIds": [ # List of IDs of labels applied to this message.
+ "A String",
+ ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
+ "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
+ # Object with schema name: MessagePart
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
+ {
+ "name": "A String", # The name of the header before the `:` separator. For example, `To`.
+ "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
- "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
- # Object with schema name: MessagePart
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
- "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
- {
- "name": "A String", # The name of the header before the `:` separator. For example, `To`.
- "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
- },
- ],
+ ],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
},
- "raw": "A String", # 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.
- "snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
- "historyId": "A String", # The ID of the last history record that modified this message.
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "id": "A String", # The immutable ID of the draft.
- }</pre>
+ "snippet": "A String", # A short part of the message text.
+ "historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
+ },
+ }</pre>
</div>
<div class="method">
@@ -230,50 +230,50 @@
An object of the form:
{ # A draft email in the user's mailbox.
- "message": { # An email message. # The message content of the draft.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
+ "id": "A String", # The immutable ID of the draft.
+ "message": { # An email message. # The message content of the draft.
+ "threadId": "A String", # 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.
+ "labelIds": [ # List of IDs of labels applied to this message.
+ "A String",
+ ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
+ "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
+ # Object with schema name: MessagePart
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
+ {
+ "name": "A String", # The name of the header before the `:` separator. For example, `To`.
+ "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
- "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
- # Object with schema name: MessagePart
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
- "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
- {
- "name": "A String", # The name of the header before the `:` separator. For example, `To`.
- "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
- },
- ],
+ ],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
},
- "raw": "A String", # 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.
- "snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
- "historyId": "A String", # The ID of the last history record that modified this message.
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "id": "A String", # The immutable ID of the draft.
- }</pre>
+ "snippet": "A String", # A short part of the message text.
+ "historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(userId, q=None, includeSpamTrash=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(userId, maxResults=None, includeSpamTrash=None, q=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the drafts in the user's mailbox.
Args:
userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
- 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: is:unread"`.
- includeSpamTrash: boolean, Include drafts from `SPAM` and `TRASH` in the results.
maxResults: integer, Maximum number of drafts to return.
+ includeSpamTrash: boolean, Include drafts from `SPAM` and `TRASH` in the results.
+ 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: is:unread"`.
pageToken: string, Page token to retrieve a specific page of results in the list.
x__xgafv: string, V1 error format.
Allowed values
@@ -284,44 +284,44 @@
An object of the form:
{
- "resultSizeEstimate": 42, # Estimated total number of results.
+ "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
"drafts": [ # 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.
{ # A draft email in the user's mailbox.
- "message": { # An email message. # The message content of the draft.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
+ "id": "A String", # The immutable ID of the draft.
+ "message": { # An email message. # The message content of the draft.
+ "threadId": "A String", # 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.
+ "labelIds": [ # List of IDs of labels applied to this message.
+ "A String",
+ ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
+ "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
+ # Object with schema name: MessagePart
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
+ {
+ "name": "A String", # The name of the header before the `:` separator. For example, `To`.
+ "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
- "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
- # Object with schema name: MessagePart
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
- "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
- {
- "name": "A String", # The name of the header before the `:` separator. For example, `To`.
- "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
- },
- ],
+ ],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
},
- "raw": "A String", # 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.
- "snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
- "historyId": "A String", # The ID of the last history record that modified this message.
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "id": "A String", # The immutable ID of the draft.
+ "snippet": "A String", # A short part of the message text.
+ "historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
},
+ },
],
- "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
+ "resultSizeEstimate": 42, # Estimated total number of results.
}</pre>
</div>
@@ -349,39 +349,39 @@
The object takes the form of:
{ # A draft email in the user's mailbox.
- "message": { # An email message. # The message content of the draft.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
+ "id": "A String", # The immutable ID of the draft.
+ "message": { # An email message. # The message content of the draft.
+ "threadId": "A String", # 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.
+ "labelIds": [ # List of IDs of labels applied to this message.
+ "A String",
+ ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
+ "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
+ # Object with schema name: MessagePart
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
+ {
+ "name": "A String", # The name of the header before the `:` separator. For example, `To`.
+ "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
- "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
- # Object with schema name: MessagePart
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
- "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
- {
- "name": "A String", # The name of the header before the `:` separator. For example, `To`.
- "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
- },
- ],
+ ],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
},
- "raw": "A String", # 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.
- "snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
- "historyId": "A String", # The ID of the last history record that modified this message.
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "id": "A String", # The immutable ID of the draft.
- }
+ "snippet": "A String", # A short part of the message text.
+ "historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -394,35 +394,35 @@
An object of the form:
{ # An email message.
+ "threadId": "A String", # 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.
"labelIds": [ # List of IDs of labels applied to this message.
"A String",
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
"sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
- },
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
"parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
# Object with schema name: MessagePart
],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
"headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
{
"name": "A String", # The name of the header before the `:` separator. For example, `To`.
"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
+ },
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "raw": "A String", # 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.
"snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
"historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
}</pre>
</div>
@@ -437,39 +437,39 @@
The object takes the form of:
{ # A draft email in the user's mailbox.
- "message": { # An email message. # The message content of the draft.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
+ "id": "A String", # The immutable ID of the draft.
+ "message": { # An email message. # The message content of the draft.
+ "threadId": "A String", # 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.
+ "labelIds": [ # List of IDs of labels applied to this message.
+ "A String",
+ ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
+ "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
+ # Object with schema name: MessagePart
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
+ {
+ "name": "A String", # The name of the header before the `:` separator. For example, `To`.
+ "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
- "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
- # Object with schema name: MessagePart
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
- "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
- {
- "name": "A String", # The name of the header before the `:` separator. For example, `To`.
- "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
- },
- ],
+ ],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
},
- "raw": "A String", # 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.
- "snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
- "historyId": "A String", # The ID of the last history record that modified this message.
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "id": "A String", # The immutable ID of the draft.
- }
+ "snippet": "A String", # A short part of the message text.
+ "historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -482,39 +482,39 @@
An object of the form:
{ # A draft email in the user's mailbox.
- "message": { # An email message. # The message content of the draft.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
+ "id": "A String", # The immutable ID of the draft.
+ "message": { # An email message. # The message content of the draft.
+ "threadId": "A String", # 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.
+ "labelIds": [ # List of IDs of labels applied to this message.
+ "A String",
+ ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "id": "A String", # The immutable ID of the message.
+ "raw": "A String", # 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.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "mimeType": "A String", # The MIME type of the message part.
+ "partId": "A String", # The immutable ID of the message part.
+ "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
+ # Object with schema name: MessagePart
],
- "internalDate": "A String", # 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.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
- "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
- "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
+ {
+ "name": "A String", # The name of the header before the `:` separator. For example, `To`.
+ "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
},
- "parts": [ # The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.
- # Object with schema name: MessagePart
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
- "mimeType": "A String", # The MIME type of the message part.
- "partId": "A String", # The immutable ID of the message part.
- "headers": [ # List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.
- {
- "name": "A String", # The name of the header before the `:` separator. For example, `To`.
- "value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
- },
- ],
+ ],
+ "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
+ "data": "A String", # The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.
},
- "raw": "A String", # 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.
- "snippet": "A String", # A short part of the message text.
- "threadId": "A String", # 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.
- "historyId": "A String", # The ID of the last history record that modified this message.
+ "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
},
- "id": "A String", # The immutable ID of the draft.
- }</pre>
+ "snippet": "A String", # A short part of the message text.
+ "historyId": "A String", # The ID of the last history record that modified this message.
+ "internalDate": "A String", # 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.
+ },
+ }</pre>
</div>
</body></html>
\ No newline at end of file