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.messages.html b/docs/dyn/gmail_v1.users.messages.html
index 2294eda..17e1b71 100644
--- a/docs/dyn/gmail_v1.users.messages.html
+++ b/docs/dyn/gmail_v1.users.messages.html
@@ -95,13 +95,13 @@
<code><a href="#get">get(userId, id, metadataHeaders=None, format=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified message.</p>
<p class="toc_element">
- <code><a href="#import_">import_(userId, body=None, processForCalendar=None, internalDateSource=None, deleted=None, neverMarkSpam=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
+ <code><a href="#import_">import_(userId, body=None, neverMarkSpam=None, internalDateSource=None, deleted=None, processForCalendar=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user.</p>
<p class="toc_element">
<code><a href="#insert">insert(userId, body=None, internalDateSource=None, deleted=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.</p>
<p class="toc_element">
- <code><a href="#list">list(userId, labelIds=None, maxResults=None, q=None, includeSpamTrash=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(userId, q=None, pageToken=None, maxResults=None, labelIds=None, includeSpamTrash=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the messages in the user's mailbox.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -151,15 +151,15 @@
The object takes the form of:
{
+ "ids": [ # The IDs of the messages to modify. There is a limit of 1000 ids per request.
+ "A String",
+ ],
"removeLabelIds": [ # A list of label IDs to remove from messages.
"A String",
],
"addLabelIds": [ # A list of label IDs to add to messages.
"A String",
],
- "ids": [ # The IDs of the messages to modify. There is a limit of 1000 ids per request.
- "A String",
- ],
}
x__xgafv: string, V1 error format.
@@ -211,40 +211,40 @@
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>
<div class="method">
- <code class="details" id="import_">import_(userId, body=None, processForCalendar=None, internalDateSource=None, deleted=None, neverMarkSpam=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
+ <code class="details" id="import_">import_(userId, body=None, neverMarkSpam=None, internalDateSource=None, deleted=None, processForCalendar=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
<pre>Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user.
Args:
@@ -253,44 +253,44 @@
The object takes the form of:
{ # 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.
}
- processForCalendar: boolean, Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
+ neverMarkSpam: boolean, Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
internalDateSource: string, Source for Gmail's internal date of the message.
Allowed values
receivedTime - Internal message date set to current time when received by Gmail.
dateHeader - Internal message time based on 'Date' header in email, when valid.
deleted: boolean, Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.
- neverMarkSpam: boolean, Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
+ processForCalendar: boolean, Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -302,35 +302,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>
@@ -344,35 +344,35 @@
The object takes the form of:
{ # 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.
}
internalDateSource: string, Source for Gmail's internal date of the message.
@@ -391,49 +391,49 @@
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>
<div class="method">
- <code class="details" id="list">list(userId, labelIds=None, maxResults=None, q=None, includeSpamTrash=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(userId, q=None, pageToken=None, maxResults=None, labelIds=None, includeSpamTrash=None, x__xgafv=None)</code>
<pre>Lists the messages 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)
- labelIds: string, Only return messages with labels that match all of the specified label IDs. (repeated)
- maxResults: integer, Maximum number of messages to return.
q: string, Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.
- includeSpamTrash: boolean, Include messages from `SPAM` and `TRASH` in the results.
pageToken: string, Page token to retrieve a specific page of results in the list.
+ maxResults: integer, Maximum number of messages to return.
+ labelIds: string, Only return messages with labels that match all of the specified label IDs. (repeated)
+ includeSpamTrash: boolean, Include messages from `SPAM` and `TRASH` in the results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -443,41 +443,41 @@
An object of the form:
{
+ "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
+ "resultSizeEstimate": 42, # Estimated total number of results.
"messages": [ # List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method.
{ # 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.
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
- "resultSizeEstimate": 42, # Estimated total number of results.
}</pre>
</div>
@@ -506,10 +506,10 @@
The object takes the form of:
{
- "removeLabelIds": [ # A list IDs of labels to remove from this message.
+ "addLabelIds": [ # A list of IDs of labels to add to this message.
"A String",
],
- "addLabelIds": [ # A list of IDs of labels to add to this message.
+ "removeLabelIds": [ # A list IDs of labels to remove from this message.
"A String",
],
}
@@ -523,35 +523,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>
@@ -565,35 +565,35 @@
The object takes the form of:
{ # 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.
}
x__xgafv: string, V1 error format.
@@ -607,35 +607,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>
@@ -655,35 +655,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>
@@ -703,35 +703,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>