chore: regens API reference docs (#889)
diff --git a/docs/dyn/gmail_v1.users.threads.html b/docs/dyn/gmail_v1.users.threads.html
index ce96c73..465ad26 100644
--- a/docs/dyn/gmail_v1.users.threads.html
+++ b/docs/dyn/gmail_v1.users.threads.html
@@ -75,49 +75,56 @@
<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.threads.html">threads</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(userId, id)</a></code></p>
-<p class="firstline">Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.</p>
+ <code><a href="#delete">delete(userId, id, x__xgafv=None)</a></code></p>
+<p class="firstline">Immediately and permanently deletes the specified thread. This operation</p>
<p class="toc_element">
- <code><a href="#get">get(userId, id, format=None, metadataHeaders=None)</a></code></p>
+ <code><a href="#get">get(userId, id, format=None, x__xgafv=None, metadataHeaders=None)</a></code></p>
<p class="firstline">Gets the specified thread.</p>
<p class="toc_element">
- <code><a href="#list">list(userId, labelIds=None, q=None, pageToken=None, maxResults=None, includeSpamTrash=None)</a></code></p>
+ <code><a href="#list">list(userId, labelIds=None, pageToken=None, includeSpamTrash=None, maxResults=None, q=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the threads in the user's mailbox.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#modify">modify(userId, id, body)</a></code></p>
-<p class="firstline">Modifies the labels applied to the thread. This applies to all messages in the thread.</p>
+ <code><a href="#modify">modify(userId, id, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Modifies the labels applied to the thread. This applies to all messages</p>
<p class="toc_element">
- <code><a href="#trash">trash(userId, id)</a></code></p>
+ <code><a href="#trash">trash(userId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Moves the specified thread to the trash.</p>
<p class="toc_element">
- <code><a href="#untrash">untrash(userId, id)</a></code></p>
+ <code><a href="#untrash">untrash(userId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Removes the specified thread from the trash.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(userId, id)</code>
- <pre>Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead.
+ <code class="details" id="delete">delete(userId, id, x__xgafv=None)</code>
+ <pre>Immediately and permanently deletes the specified thread. This operation
+cannot be undone. Prefer <code>threads.trash</code> instead.
Args:
- userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
+ userId: string, The user's email address. The special value <code>me</code>
+can be used to indicate the authenticated user. (required)
id: string, ID of the Thread to delete. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
</pre>
</div>
<div class="method">
- <code class="details" id="get">get(userId, id, format=None, metadataHeaders=None)</code>
+ <code class="details" id="get">get(userId, id, format=None, x__xgafv=None, metadataHeaders=None)</code>
<pre>Gets the specified thread.
Args:
- userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
+ userId: string, The user's email address. The special value <code>me</code>
+can be used to indicate the authenticated user. (required)
id: string, The ID of the thread to retrieve. (required)
format: string, The format to return the messages in.
+ x__xgafv: string, V1 error format.
Allowed values
- full -
- metadata -
- minimal -
+ 1 - v1 error format
+ 2 - v2 error format
metadataHeaders: string, When given and format is METADATA, only include headers specified. (repeated)
Returns:
@@ -127,35 +134,70 @@
"snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # An email 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.
+ "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 <code>Date</code> header. However, for API-migrated mail, it can
+ # be configured by client to be based on the <code>Date</code> header.
"historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "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.
+ "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.
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be
+ # retrieved in a separate <code>messages.attachments.get</code> 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).
},
"mimeType": "A String", # The MIME type of the message part.
"partId": "A String", # The immutable ID of the message part.
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an 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.
+ "filename": "A String", # The filename of the attachment. Only present if this message part
+ # represents an 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 <code>To</code>, <code>From</code>, and
+ # <code>Subject</code>.
{
- "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.
+ "name": "A String", # The name of the header before the <code>:</code> separator. For
+ # example, <code>To</code>.
+ "value": "A String", # The value of the header after the <code>:</code> separator. For example,
+ # <code>someuser@example.com</code>.
},
],
- "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.
+ "parts": [ # The child MIME message parts of this part. This only applies to container
+ # MIME message parts, for example <code>multipart/*</code>. For non-
+ # container MIME message part types, such as <code>text/plain</code>, this
+ # field is empty. For more information, see
+ # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
# Object with schema name: MessagePart
],
},
"snippet": "A String", # A short part of the message text.
- "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.
+ "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url
+ # encoded string. Returned in <code>messages.get</code> and
+ # <code>drafts.get</code> responses when the <code>format=RAW</code>
+ # parameter is supplied.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"sizeEstimate": 42, # Estimated size in bytes of the 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:
- # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
- # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
- # - The Subject headers must match.
+ "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:
+ # <ol><li>The requested <code>threadId</code> must be specified on the
+ # <code>Message</code> or <code>Draft.Message</code> you supply with your
+ # request.</li>
+ # <li>The <code>References</code> and <code>In-Reply-To</code> headers must
+ # be set in compliance with the
+ # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
+ # <li>The <code>Subject</code> headers must match.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"labelIds": [ # List of IDs of labels applied to this message.
+ # @mutable gmail.users.messages.insert gmail.users.messages.modify
"A String",
],
"id": "A String", # The immutable ID of the message.
@@ -167,16 +209,26 @@
</div>
<div class="method">
- <code class="details" id="list">list(userId, labelIds=None, q=None, pageToken=None, maxResults=None, includeSpamTrash=None)</code>
+ <code class="details" id="list">list(userId, labelIds=None, pageToken=None, includeSpamTrash=None, maxResults=None, q=None, x__xgafv=None)</code>
<pre>Lists the threads 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)
+ userId: string, The user's email address. The special value <code>me</code>
+can be used to indicate the authenticated user. (required)
labelIds: string, Only return threads with labels that match all of the specified label IDs. (repeated)
- q: string, Only return threads 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.
pageToken: string, Page token to retrieve a specific page of results in the list.
+ includeSpamTrash: boolean, Include threads from <code>SPAM</code> and <code>TRASH</code>
+in the results.
maxResults: integer, Maximum number of threads to return.
- includeSpamTrash: boolean, Include threads from SPAM and TRASH in the results.
+ q: string, Only return threads matching the specified query. Supports the same
+query format as the Gmail search box. For example,
+<code>"from:someuser@example.com rfc822msgid:<somemsgid@example.com>
+is:unread"</code>. Parameter cannot be used when accessing the api
+using the gmail.metadata scope.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
@@ -184,40 +236,78 @@
{
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
"resultSizeEstimate": 42, # Estimated total number of results.
- "threads": [ # List of threads. Note that each thread resource does not contain a list of messages. The list of messages for a given thread can be fetched using the threads.get method.
+ "threads": [ # List of threads. Note that each thread resource does not contain a list of
+ # <code>messages</code>. The list of <code>messages</code> for a given thread
+ # can be fetched using the
+ # <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method.
{ # A collection of messages representing a conversation.
"snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # An email 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.
+ "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 <code>Date</code> header. However, for API-migrated mail, it can
+ # be configured by client to be based on the <code>Date</code> header.
"historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "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.
+ "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.
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be
+ # retrieved in a separate <code>messages.attachments.get</code> 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).
},
"mimeType": "A String", # The MIME type of the message part.
"partId": "A String", # The immutable ID of the message part.
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an 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.
+ "filename": "A String", # The filename of the attachment. Only present if this message part
+ # represents an 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 <code>To</code>, <code>From</code>, and
+ # <code>Subject</code>.
{
- "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.
+ "name": "A String", # The name of the header before the <code>:</code> separator. For
+ # example, <code>To</code>.
+ "value": "A String", # The value of the header after the <code>:</code> separator. For example,
+ # <code>someuser@example.com</code>.
},
],
- "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.
+ "parts": [ # The child MIME message parts of this part. This only applies to container
+ # MIME message parts, for example <code>multipart/*</code>. For non-
+ # container MIME message part types, such as <code>text/plain</code>, this
+ # field is empty. For more information, see
+ # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
# Object with schema name: MessagePart
],
},
"snippet": "A String", # A short part of the message text.
- "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.
+ "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url
+ # encoded string. Returned in <code>messages.get</code> and
+ # <code>drafts.get</code> responses when the <code>format=RAW</code>
+ # parameter is supplied.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"sizeEstimate": 42, # Estimated size in bytes of the 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:
- # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
- # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
- # - The Subject headers must match.
+ "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:
+ # <ol><li>The requested <code>threadId</code> must be specified on the
+ # <code>Message</code> or <code>Draft.Message</code> you supply with your
+ # request.</li>
+ # <li>The <code>References</code> and <code>In-Reply-To</code> headers must
+ # be set in compliance with the
+ # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
+ # <li>The <code>Subject</code> headers must match.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"labelIds": [ # List of IDs of labels applied to this message.
+ # @mutable gmail.users.messages.insert gmail.users.messages.modify
"A String",
],
"id": "A String", # The immutable ID of the message.
@@ -245,13 +335,15 @@
</div>
<div class="method">
- <code class="details" id="modify">modify(userId, id, body)</code>
- <pre>Modifies the labels applied to the thread. This applies to all messages in the thread.
+ <code class="details" id="modify">modify(userId, id, body=None, x__xgafv=None)</code>
+ <pre>Modifies the labels applied to the thread. This applies to all messages
+in the thread.
Args:
- userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
+ userId: string, The user's email address. The special value <code>me</code>
+can be used to indicate the authenticated user. (required)
id: string, The ID of the thread to modify. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
@@ -263,6 +355,10 @@
],
}
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
@@ -271,35 +367,70 @@
"snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # An email 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.
+ "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 <code>Date</code> header. However, for API-migrated mail, it can
+ # be configured by client to be based on the <code>Date</code> header.
"historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "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.
+ "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.
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be
+ # retrieved in a separate <code>messages.attachments.get</code> 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).
},
"mimeType": "A String", # The MIME type of the message part.
"partId": "A String", # The immutable ID of the message part.
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an 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.
+ "filename": "A String", # The filename of the attachment. Only present if this message part
+ # represents an 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 <code>To</code>, <code>From</code>, and
+ # <code>Subject</code>.
{
- "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.
+ "name": "A String", # The name of the header before the <code>:</code> separator. For
+ # example, <code>To</code>.
+ "value": "A String", # The value of the header after the <code>:</code> separator. For example,
+ # <code>someuser@example.com</code>.
},
],
- "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.
+ "parts": [ # The child MIME message parts of this part. This only applies to container
+ # MIME message parts, for example <code>multipart/*</code>. For non-
+ # container MIME message part types, such as <code>text/plain</code>, this
+ # field is empty. For more information, see
+ # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
# Object with schema name: MessagePart
],
},
"snippet": "A String", # A short part of the message text.
- "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.
+ "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url
+ # encoded string. Returned in <code>messages.get</code> and
+ # <code>drafts.get</code> responses when the <code>format=RAW</code>
+ # parameter is supplied.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"sizeEstimate": 42, # Estimated size in bytes of the 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:
- # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
- # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
- # - The Subject headers must match.
+ "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:
+ # <ol><li>The requested <code>threadId</code> must be specified on the
+ # <code>Message</code> or <code>Draft.Message</code> you supply with your
+ # request.</li>
+ # <li>The <code>References</code> and <code>In-Reply-To</code> headers must
+ # be set in compliance with the
+ # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
+ # <li>The <code>Subject</code> headers must match.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"labelIds": [ # List of IDs of labels applied to this message.
+ # @mutable gmail.users.messages.insert gmail.users.messages.modify
"A String",
],
"id": "A String", # The immutable ID of the message.
@@ -311,12 +442,17 @@
</div>
<div class="method">
- <code class="details" id="trash">trash(userId, id)</code>
+ <code class="details" id="trash">trash(userId, id, x__xgafv=None)</code>
<pre>Moves the specified thread to the trash.
Args:
- userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
+ userId: string, The user's email address. The special value <code>me</code>
+can be used to indicate the authenticated user. (required)
id: string, The ID of the thread to Trash. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
@@ -325,35 +461,70 @@
"snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # An email 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.
+ "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 <code>Date</code> header. However, for API-migrated mail, it can
+ # be configured by client to be based on the <code>Date</code> header.
"historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "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.
+ "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.
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be
+ # retrieved in a separate <code>messages.attachments.get</code> 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).
},
"mimeType": "A String", # The MIME type of the message part.
"partId": "A String", # The immutable ID of the message part.
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an 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.
+ "filename": "A String", # The filename of the attachment. Only present if this message part
+ # represents an 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 <code>To</code>, <code>From</code>, and
+ # <code>Subject</code>.
{
- "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.
+ "name": "A String", # The name of the header before the <code>:</code> separator. For
+ # example, <code>To</code>.
+ "value": "A String", # The value of the header after the <code>:</code> separator. For example,
+ # <code>someuser@example.com</code>.
},
],
- "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.
+ "parts": [ # The child MIME message parts of this part. This only applies to container
+ # MIME message parts, for example <code>multipart/*</code>. For non-
+ # container MIME message part types, such as <code>text/plain</code>, this
+ # field is empty. For more information, see
+ # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
# Object with schema name: MessagePart
],
},
"snippet": "A String", # A short part of the message text.
- "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.
+ "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url
+ # encoded string. Returned in <code>messages.get</code> and
+ # <code>drafts.get</code> responses when the <code>format=RAW</code>
+ # parameter is supplied.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"sizeEstimate": 42, # Estimated size in bytes of the 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:
- # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
- # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
- # - The Subject headers must match.
+ "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:
+ # <ol><li>The requested <code>threadId</code> must be specified on the
+ # <code>Message</code> or <code>Draft.Message</code> you supply with your
+ # request.</li>
+ # <li>The <code>References</code> and <code>In-Reply-To</code> headers must
+ # be set in compliance with the
+ # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
+ # <li>The <code>Subject</code> headers must match.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"labelIds": [ # List of IDs of labels applied to this message.
+ # @mutable gmail.users.messages.insert gmail.users.messages.modify
"A String",
],
"id": "A String", # The immutable ID of the message.
@@ -365,12 +536,17 @@
</div>
<div class="method">
- <code class="details" id="untrash">untrash(userId, id)</code>
+ <code class="details" id="untrash">untrash(userId, id, x__xgafv=None)</code>
<pre>Removes the specified thread from the trash.
Args:
- userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
+ userId: string, The user's email address. The special value <code>me</code>
+can be used to indicate the authenticated user. (required)
id: string, The ID of the thread to remove from Trash. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
@@ -379,35 +555,70 @@
"snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # An email 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.
+ "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 <code>Date</code> header. However, for API-migrated mail, it can
+ # be configured by client to be based on the <code>Date</code> header.
"historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "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.
+ "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.
+ "attachmentId": "A String", # When present, contains the ID of an external attachment that can be
+ # retrieved in a separate <code>messages.attachments.get</code> 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).
},
"mimeType": "A String", # The MIME type of the message part.
"partId": "A String", # The immutable ID of the message part.
- "filename": "A String", # The filename of the attachment. Only present if this message part represents an 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.
+ "filename": "A String", # The filename of the attachment. Only present if this message part
+ # represents an 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 <code>To</code>, <code>From</code>, and
+ # <code>Subject</code>.
{
- "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.
+ "name": "A String", # The name of the header before the <code>:</code> separator. For
+ # example, <code>To</code>.
+ "value": "A String", # The value of the header after the <code>:</code> separator. For example,
+ # <code>someuser@example.com</code>.
},
],
- "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.
+ "parts": [ # The child MIME message parts of this part. This only applies to container
+ # MIME message parts, for example <code>multipart/*</code>. For non-
+ # container MIME message part types, such as <code>text/plain</code>, this
+ # field is empty. For more information, see
+ # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
# Object with schema name: MessagePart
],
},
"snippet": "A String", # A short part of the message text.
- "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.
+ "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url
+ # encoded string. Returned in <code>messages.get</code> and
+ # <code>drafts.get</code> responses when the <code>format=RAW</code>
+ # parameter is supplied.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"sizeEstimate": 42, # Estimated size in bytes of the 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:
- # - The requested threadId must be specified on the Message or Draft.Message you supply with your request.
- # - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
- # - The Subject headers must match.
+ "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:
+ # <ol><li>The requested <code>threadId</code> must be specified on the
+ # <code>Message</code> or <code>Draft.Message</code> you supply with your
+ # request.</li>
+ # <li>The <code>References</code> and <code>In-Reply-To</code> headers must
+ # be set in compliance with the
+ # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
+ # <li>The <code>Subject</code> headers must match.
+ # @mutable gmail.users.messages.insert gmail.users.messages.send
+ # @mutable gmail.users.drafts.create gmail.users.drafts.update
"labelIds": [ # List of IDs of labels applied to this message.
+ # @mutable gmail.users.messages.insert gmail.users.messages.modify
"A String",
],
"id": "A String", # The immutable ID of the message.