docs: update generated docs (#981)
diff --git a/docs/dyn/gmail_v1.users.drafts.html b/docs/dyn/gmail_v1.users.drafts.html
index 2b7374e..b3136be 100644
--- a/docs/dyn/gmail_v1.users.drafts.html
+++ b/docs/dyn/gmail_v1.users.drafts.html
@@ -75,74 +75,114 @@
<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.drafts.html">drafts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(userId, body=None, media_body=None, media_mime_type=None)</a></code></p>
-<p class="firstline">Creates a new draft with the DRAFT label.</p>
+ <code><a href="#create">create(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
+<p class="firstline">Creates a new draft with the `DRAFT` label.</p>
<p class="toc_element">
- <code><a href="#delete">delete(userId, id)</a></code></p>
-<p class="firstline">Immediately and permanently deletes the specified draft. Does not simply trash it.</p>
+ <code><a href="#delete">delete(userId, id, x__xgafv=None)</a></code></p>
+<p class="firstline">Immediately and permanently deletes the specified draft.</p>
<p class="toc_element">
- <code><a href="#get">get(userId, id, format=None)</a></code></p>
+ <code><a href="#get">get(userId, id, format=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified draft.</p>
<p class="toc_element">
- <code><a href="#list">list(userId, includeSpamTrash=None, maxResults=None, pageToken=None, q=None)</a></code></p>
+ <code><a href="#list">list(userId, maxResults=None, q=None, includeSpamTrash=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the drafts in the user's mailbox.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#send">send(userId, body=None, media_body=None, media_mime_type=None)</a></code></p>
-<p class="firstline">Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.</p>
+ <code><a href="#send">send(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
+<p class="firstline">Sends the specified, existing draft to the recipients in the</p>
<p class="toc_element">
- <code><a href="#update">update(userId, id, body=None, media_body=None, media_mime_type=None)</a></code></p>
+ <code><a href="#update">update(userId, id, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Replaces a draft's content.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(userId, body=None, media_body=None, media_mime_type=None)</code>
- <pre>Creates a new draft with the DRAFT label.
+ <code class="details" id="create">create(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
+ <pre>Creates a new draft with the `DRAFT` label.
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)
body: object, The request body.
The object takes the form of:
{ # A draft email in the user's mailbox.
"id": "A String", # The immutable ID of the draft.
"message": { # An email message. # The message content of the draft.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
},
}
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
@@ -152,65 +192,106 @@
{ # A draft email in the user's mailbox.
"id": "A String", # The immutable ID of the draft.
"message": { # An email message. # The message content of the draft.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
},
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(userId, id)</code>
- <pre>Immediately and permanently deletes the specified draft. Does not simply trash it.
+ <code class="details" id="delete">delete(userId, id, x__xgafv=None)</code>
+ <pre>Immediately and permanently deletes the specified draft.
+Does not simply trash it.
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 draft 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)</code>
+ <code class="details" id="get">get(userId, id, format=None, x__xgafv=None)</code>
<pre>Gets the specified draft.
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 draft to retrieve. (required)
format: string, The format to return the draft in.
+ x__xgafv: string, V1 error format.
Allowed values
- full -
- metadata -
- minimal -
- raw -
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
@@ -218,97 +299,180 @@
{ # A draft email in the user's mailbox.
"id": "A String", # The immutable ID of the draft.
"message": { # An email message. # The message content of the draft.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
},
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(userId, includeSpamTrash=None, maxResults=None, pageToken=None, q=None)</code>
+ <code class="details" id="list">list(userId, maxResults=None, q=None, includeSpamTrash=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the drafts in the user's mailbox.
Args:
- userId: string, The user's email address. The special value me can be used to indicate the authenticated user. (required)
- includeSpamTrash: boolean, Include drafts 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)
maxResults: integer, Maximum number of drafts to return.
+ q: string, Only return draft messages matching the specified query. Supports the same
+query format as the Gmail search box. For example,
+`"from:someuser@example.com rfc822msgid:<somemsgid@example.com>
+is:unread"`.
+ includeSpamTrash: boolean, Include drafts from `SPAM` and `TRASH`
+in the results.
pageToken: string, Page token to retrieve a specific page of results in the list.
- q: string, Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{
- "drafts": [ # List of drafts. Note that the Message property in each Draft resource only contains an id and a threadId. The messages.get method can fetch additional message details.
+ "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
+ "drafts": [ # List of drafts. Note that the `Message` property in each
+ # `Draft` resource only contains an `id` and a
+ # `threadId`. The
+ # <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a>
+ # method can fetch additional message details.
{ # A draft email in the user's mailbox.
"id": "A String", # The immutable ID of the draft.
"message": { # An email message. # The message content of the draft.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
},
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results in the list.
"resultSizeEstimate": 42, # Estimated total number of results.
}</pre>
</div>
@@ -328,52 +492,93 @@
</div>
<div class="method">
- <code class="details" id="send">send(userId, body=None, media_body=None, media_mime_type=None)</code>
- <pre>Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.
+ <code class="details" id="send">send(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
+ <pre>Sends the specified, existing draft to the recipients in the
+`To`, `Cc`, and `Bcc` headers.
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)
body: object, The request body.
The object takes the form of:
{ # A draft email in the user's mailbox.
"id": "A String", # The immutable ID of the draft.
"message": { # An email message. # The message content of the draft.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
},
}
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
@@ -381,47 +586,83 @@
An object of the form:
{ # An email message.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(userId, id, body=None, media_body=None, media_mime_type=None)</code>
+ <code class="details" id="update">update(userId, id, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
<pre>Replaces a draft's content.
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 draft to update. (required)
body: object, The request body.
The object takes the form of:
@@ -429,41 +670,80 @@
{ # A draft email in the user's mailbox.
"id": "A String", # The immutable ID of the draft.
"message": { # An email message. # The message content of the draft.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
},
}
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
@@ -473,38 +753,73 @@
{ # A draft email in the user's mailbox.
"id": "A String", # The immutable ID of the draft.
"message": { # An email message. # The message content of the draft.
- "historyId": "A String", # The ID of the last history record that modified this 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.
- "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.
- "labelIds": [ # List of IDs of labels applied to this message.
- "A String",
- ],
+ "sizeEstimate": 42, # Estimated size in bytes of the message.
"payload": { # A single MIME message part. # The parsed email structure in the message parts.
- "body": { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
- "attachmentId": "A String", # When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.
- "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).
- },
- "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.
- {
- "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.
- },
- ],
"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.
+ "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.
+ },
},
- "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.
- "sizeEstimate": 42, # Estimated size in bytes of the message.
+ "historyId": "A String", # The ID of the last history record that modified this message.
"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:
- # - 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.
+ "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",
+ ],
},
}</pre>
</div>