docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/gmail_v1.users.threads.html b/docs/dyn/gmail_v1.users.threads.html
index 56d1a50..12aa96c 100644
--- a/docs/dyn/gmail_v1.users.threads.html
+++ b/docs/dyn/gmail_v1.users.threads.html
@@ -75,20 +75,23 @@
<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="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<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="firstline">Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead.</p>
<p class="toc_element">
<code><a href="#get">get(userId, id, format=None, metadataHeaders=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified thread.</p>
<p class="toc_element">
- <code><a href="#list">list(userId, q=None, includeSpamTrash=None, pageToken=None, maxResults=None, labelIds=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(userId, q=None, pageToken=None, labelIds=None, maxResults=None, includeSpamTrash=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=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="firstline">Modifies the labels applied to the thread. This applies to all messages in the thread.</p>
<p class="toc_element">
<code><a href="#trash">trash(userId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Moves the specified thread to the trash.</p>
@@ -97,13 +100,16 @@
<p class="firstline">Removes the specified thread from the trash.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<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 `threads.trash` instead.
+ <pre>Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` 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 `me` 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
@@ -117,10 +123,13 @@
<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 `me` 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.
+ Allowed values
+ full - Returns the full email message data with body content parsed in the `payload` field; the `raw` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.
+ metadata - Returns only email message IDs, labels, and email headers.
+ minimal - Returns only email message IDs and labels; does not return the email headers, body, or payload.
metadataHeaders: string, When given and format is METADATA, only include headers specified. (repeated)
x__xgafv: string, V1 error format.
Allowed values
@@ -133,98 +142,54 @@
{ # A collection of messages representing a conversation.
"id": "A String", # The unique ID of the thread.
"historyId": "A String", # The ID of the last history record that modified this thread.
- "snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # 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:
- # <ol><li>The requested `threadId` must be specified on the
- # `Message` or `Draft.Message` you supply with your
- # request.</li>
- # <li>The `References` and `In-Reply-To` headers must
- # be set in compliance with the
- # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
- # <li>The `Subject` headers must match.
- # @mutable gmail.users.messages.insert gmail.users.messages.send
- # @mutable gmail.users.drafts.create gmail.users.drafts.update
- "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines
- # ordering in the inbox. For normal SMTP-received email, this represents the
- # time the message was originally accepted by Google, which is more reliable
- # than the `Date` header. However, for API-migrated mail, it can
- # be configured by client to be based on the `Date` header.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "mimeType": "A String", # The MIME type 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
- # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
- # Object with schema name: MessagePart
- ],
- "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`.
- },
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part
- # represents an attachment.
- "partId": "A String", # The immutable ID of the message part.
- "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.
- "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.
- "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.
- },
- },
- "historyId": "A String", # The ID of the last history record that modified this message.
"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.
- # @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",
],
+ "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.
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "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`.
+ {
+ "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 `:` separator. For example, `To`.
+ },
+ ],
+ "mimeType": "A String", # The MIME type 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.
+ "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.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ },
+ },
+ "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.
+ "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.
+ "id": "A String", # The immutable ID of the message.
},
],
+ "snippet": "A String", # A short part of the message text.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(userId, q=None, includeSpamTrash=None, pageToken=None, maxResults=None, labelIds=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(userId, q=None, pageToken=None, labelIds=None, maxResults=None, includeSpamTrash=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)
- 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:<somemsgid@example.com>
-is:unread"`. Parameter cannot be used when accessing the api
-using the gmail.metadata scope.
- includeSpamTrash: boolean, Include threads from `SPAM` and `TRASH`
-in the results.
+ userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
+ 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.
- maxResults: integer, Maximum number of threads to return.
labelIds: string, Only return threads with labels that match all of the specified label IDs. (repeated)
+ maxResults: integer, Maximum number of threads to return.
+ includeSpamTrash: boolean, Include threads from `SPAM` and `TRASH` in the results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -234,88 +199,47 @@
An object of the form:
{
- "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
- # <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method.
+ "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.
{ # A collection of messages representing a conversation.
"id": "A String", # The unique ID of the thread.
"historyId": "A String", # The ID of the last history record that modified this thread.
- "snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # 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:
- # <ol><li>The requested `threadId` must be specified on the
- # `Message` or `Draft.Message` you supply with your
- # request.</li>
- # <li>The `References` and `In-Reply-To` headers must
- # be set in compliance with the
- # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
- # <li>The `Subject` headers must match.
- # @mutable gmail.users.messages.insert gmail.users.messages.send
- # @mutable gmail.users.drafts.create gmail.users.drafts.update
- "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines
- # ordering in the inbox. For normal SMTP-received email, this represents the
- # time the message was originally accepted by Google, which is more reliable
- # than the `Date` header. However, for API-migrated mail, it can
- # be configured by client to be based on the `Date` header.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "mimeType": "A String", # The MIME type 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
- # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
- # Object with schema name: MessagePart
- ],
- "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`.
- },
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part
- # represents an attachment.
- "partId": "A String", # The immutable ID of the message part.
- "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.
- "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.
- "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.
- },
- },
- "historyId": "A String", # The ID of the last history record that modified this message.
"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.
- # @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",
],
+ "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.
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "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`.
+ {
+ "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 `:` separator. For example, `To`.
+ },
+ ],
+ "mimeType": "A String", # The MIME type 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.
+ "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.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ },
+ },
+ "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.
+ "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.
+ "id": "A String", # The immutable ID of the message.
},
],
+ "snippet": "A String", # A short part of the message text.
},
],
+ "resultSizeEstimate": 42, # Estimated total number of results.
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
}</pre>
</div>
@@ -336,21 +260,19 @@
<div class="method">
<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.
+ <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 `me` can be used to indicate the authenticated user. (required)
id: string, The ID of the thread to modify. (required)
body: object, The request body.
The object takes the form of:
{
- "addLabelIds": [ # A list of IDs of labels to add to this thread.
+ "removeLabelIds": [ # A list of IDs of labels to remove from this thread.
"A String",
],
- "removeLabelIds": [ # A list of IDs of labels to remove from this thread.
+ "addLabelIds": [ # A list of IDs of labels to add to this thread.
"A String",
],
}
@@ -366,78 +288,40 @@
{ # A collection of messages representing a conversation.
"id": "A String", # The unique ID of the thread.
"historyId": "A String", # The ID of the last history record that modified this thread.
- "snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # 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:
- # <ol><li>The requested `threadId` must be specified on the
- # `Message` or `Draft.Message` you supply with your
- # request.</li>
- # <li>The `References` and `In-Reply-To` headers must
- # be set in compliance with the
- # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
- # <li>The `Subject` headers must match.
- # @mutable gmail.users.messages.insert gmail.users.messages.send
- # @mutable gmail.users.drafts.create gmail.users.drafts.update
- "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines
- # ordering in the inbox. For normal SMTP-received email, this represents the
- # time the message was originally accepted by Google, which is more reliable
- # than the `Date` header. However, for API-migrated mail, it can
- # be configured by client to be based on the `Date` header.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "mimeType": "A String", # The MIME type 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
- # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
- # Object with schema name: MessagePart
- ],
- "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`.
- },
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part
- # represents an attachment.
- "partId": "A String", # The immutable ID of the message part.
- "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.
- "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.
- "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.
- },
- },
- "historyId": "A String", # The ID of the last history record that modified this message.
"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.
- # @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",
],
+ "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.
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "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`.
+ {
+ "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 `:` separator. For example, `To`.
+ },
+ ],
+ "mimeType": "A String", # The MIME type 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.
+ "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.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ },
+ },
+ "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.
+ "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.
+ "id": "A String", # The immutable ID of the message.
},
],
+ "snippet": "A String", # A short part of the message text.
}</pre>
</div>
@@ -446,8 +330,7 @@
<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 `me` 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
@@ -460,78 +343,40 @@
{ # A collection of messages representing a conversation.
"id": "A String", # The unique ID of the thread.
"historyId": "A String", # The ID of the last history record that modified this thread.
- "snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # 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:
- # <ol><li>The requested `threadId` must be specified on the
- # `Message` or `Draft.Message` you supply with your
- # request.</li>
- # <li>The `References` and `In-Reply-To` headers must
- # be set in compliance with the
- # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
- # <li>The `Subject` headers must match.
- # @mutable gmail.users.messages.insert gmail.users.messages.send
- # @mutable gmail.users.drafts.create gmail.users.drafts.update
- "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines
- # ordering in the inbox. For normal SMTP-received email, this represents the
- # time the message was originally accepted by Google, which is more reliable
- # than the `Date` header. However, for API-migrated mail, it can
- # be configured by client to be based on the `Date` header.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "mimeType": "A String", # The MIME type 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
- # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
- # Object with schema name: MessagePart
- ],
- "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`.
- },
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part
- # represents an attachment.
- "partId": "A String", # The immutable ID of the message part.
- "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.
- "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.
- "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.
- },
- },
- "historyId": "A String", # The ID of the last history record that modified this message.
"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.
- # @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",
],
+ "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.
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "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`.
+ {
+ "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 `:` separator. For example, `To`.
+ },
+ ],
+ "mimeType": "A String", # The MIME type 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.
+ "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.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ },
+ },
+ "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.
+ "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.
+ "id": "A String", # The immutable ID of the message.
},
],
+ "snippet": "A String", # A short part of the message text.
}</pre>
</div>
@@ -540,8 +385,7 @@
<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 `me` 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
@@ -554,78 +398,40 @@
{ # A collection of messages representing a conversation.
"id": "A String", # The unique ID of the thread.
"historyId": "A String", # The ID of the last history record that modified this thread.
- "snippet": "A String", # A short part of the message text.
"messages": [ # The list of messages in the thread.
{ # 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:
- # <ol><li>The requested `threadId` must be specified on the
- # `Message` or `Draft.Message` you supply with your
- # request.</li>
- # <li>The `References` and `In-Reply-To` headers must
- # be set in compliance with the
- # <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
- # <li>The `Subject` headers must match.
- # @mutable gmail.users.messages.insert gmail.users.messages.send
- # @mutable gmail.users.drafts.create gmail.users.drafts.update
- "internalDate": "A String", # The internal message creation timestamp (epoch ms), which determines
- # ordering in the inbox. For normal SMTP-received email, this represents the
- # time the message was originally accepted by Google, which is more reliable
- # than the `Date` header. However, for API-migrated mail, it can
- # be configured by client to be based on the `Date` header.
- "id": "A String", # The immutable ID of the message.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
- "payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "mimeType": "A String", # The MIME type 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
- # <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
- # Object with schema name: MessagePart
- ],
- "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`.
- },
- ],
- "filename": "A String", # The filename of the attachment. Only present if this message part
- # represents an attachment.
- "partId": "A String", # The immutable ID of the message part.
- "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.
- "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.
- "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.
- },
- },
- "historyId": "A String", # The ID of the last history record that modified this message.
"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.
- # @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",
],
+ "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.
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "payload": { # A single MIME message part. # The parsed email structure in the message parts.
+ "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`.
+ {
+ "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 `:` separator. For example, `To`.
+ },
+ ],
+ "mimeType": "A String", # The MIME type 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.
+ "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.
+ "size": 42, # Number of bytes for the message part data (encoding notwithstanding).
+ },
+ },
+ "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.
+ "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.
+ "id": "A String", # The immutable ID of the message.
},
],
+ "snippet": "A String", # A short part of the message text.
}</pre>
</div>