blob: 76b2329ebc25e173e89ad7ce08f22707702add1b [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.messages.html">messages</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="gmail_v1.users.messages.attachments.html">attachments()</a></code>
79</p>
80<p class="firstline">Returns the attachments Resource.</p>
81
82<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070083 <code><a href="#batchDelete">batchDelete(userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084<p class="firstline">Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070085<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070086 <code><a href="#batchModify">batchModify(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080087<p class="firstline">Modifies the labels on the specified messages.</p>
88<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070089 <code><a href="#close">close()</a></code></p>
90<p class="firstline">Close httplib2 connections.</p>
Craig Citro065b5302014-08-14 00:47:23 -070091<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070092 <code><a href="#delete">delete(userId, id, x__xgafv=None)</a></code></p>
93<p class="firstline">Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.</p>
94<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070095 <code><a href="#get">get(userId, id, format=None, metadataHeaders=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070096<p class="firstline">Gets the specified message.</p>
97<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070098 <code><a href="#import_">import_(userId, body=None, neverMarkSpam=None, deleted=None, internalDateSource=None, processForCalendar=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070099<p class="firstline">Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700100<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700101 <code><a href="#insert">insert(userId, body=None, deleted=None, internalDateSource=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
102<p class="firstline">Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700103<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700104 <code><a href="#list">list(userId, includeSpamTrash=None, q=None, labelIds=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700105<p class="firstline">Lists the messages in the user's mailbox.</p>
106<p class="toc_element">
107 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
108<p class="firstline">Retrieves the next page of results.</p>
109<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700110 <code><a href="#modify">modify(userId, id, body=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700111<p class="firstline">Modifies the labels on the specified message.</p>
112<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700113 <code><a href="#send">send(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114<p class="firstline">Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700115<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700116 <code><a href="#trash">trash(userId, id, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700117<p class="firstline">Moves the specified message to the trash.</p>
118<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 <code><a href="#untrash">untrash(userId, id, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700120<p class="firstline">Removes the specified message from the trash.</p>
121<h3>Method Details</h3>
122<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700123 <code class="details" id="batchDelete">batchDelete(userId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700124 <pre>Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700125
126Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700127 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700128 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700129 The object takes the form of:
130
131{
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 &quot;ids&quot;: [ # The IDs of the messages to delete.
133 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700134 ],
135 }
136
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700141</pre>
142</div>
143
144<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700145 <code class="details" id="batchModify">batchModify(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800146 <pre>Modifies the labels on the specified messages.
147
148Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700149 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700150 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800151 The object takes the form of:
152
153{
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 &quot;addLabelIds&quot;: [ # A list of label IDs to add to messages.
155 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800156 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700157 &quot;removeLabelIds&quot;: [ # A list of label IDs to remove from messages.
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800159 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700160 &quot;ids&quot;: [ # The IDs of the messages to modify. There is a limit of 1000 ids per request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700161 &quot;A String&quot;,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800162 ],
163 }
164
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800169</pre>
170</div>
171
172<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700173 <code class="details" id="close">close()</code>
174 <pre>Close httplib2 connections.</pre>
175</div>
176
177<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700178 <code class="details" id="delete">delete(userId, id, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700179 <pre>Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.
Craig Citro065b5302014-08-14 00:47:23 -0700180
181Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700183 id: string, The ID of the message to delete. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700188</pre>
189</div>
190
191<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700192 <code class="details" id="get">get(userId, id, format=None, metadataHeaders=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700193 <pre>Gets the specified message.
194
195Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700196 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700197 id: string, The ID of the message to retrieve. (required)
198 format: string, The format to return the message in.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700199 Allowed values
200 minimal - Returns only email message ID and labels; does not return the email headers, body, or payload.
201 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.
202 raw - Returns the full email message data with body content in the `raw` field as a base64url encoded string; the `payload` field is not used. Format cannot be used when accessing the api using the gmail.metadata scope.
203 metadata - Returns only email message ID, labels, and email headers.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700204 metadataHeaders: string, When given and format is `METADATA`, only include headers specified. (repeated)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700209
210Returns:
211 An object of the form:
212
213 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700214 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700215 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700216 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700217 &quot;A String&quot;,
218 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700219 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700220 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
221 &quot;parts&quot;: [ # 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.
222 # Object with schema name: MessagePart
223 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700224 &quot;headers&quot;: [ # 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`.
225 {
226 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
227 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
228 },
229 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700230 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
231 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
233 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700234 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700235 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700236 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700237 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700238 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700239 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
240 &quot;raw&quot;: &quot;A String&quot;, # 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.
241 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
242 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700243 }</pre>
244</div>
245
246<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700247 <code class="details" id="import_">import_(userId, body=None, neverMarkSpam=None, deleted=None, internalDateSource=None, processForCalendar=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700248 <pre>Imports a message into only this user&#x27;s mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn&#x27;t trigger forwarding rules or filters set up by the user.
Craig Citro065b5302014-08-14 00:47:23 -0700249
250Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700251 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700252 body: object, The request body.
253 The object takes the form of:
254
255{ # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700256 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700257 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700258 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700259 &quot;A String&quot;,
260 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700261 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700262 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
263 &quot;parts&quot;: [ # 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.
264 # Object with schema name: MessagePart
265 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700266 &quot;headers&quot;: [ # 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`.
267 {
268 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
269 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
270 },
271 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700272 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
273 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700274 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
275 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700276 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700277 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700278 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700279 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700280 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700281 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
282 &quot;raw&quot;: &quot;A String&quot;, # 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.
283 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
284 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700285}
286
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700287 neverMarkSpam: boolean, Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700288 deleted: boolean, Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.
Bu Sun Kim65020912020-05-20 12:08:20 -0700289 internalDateSource: string, Source for Gmail&#x27;s internal date of the message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700290 Allowed values
291 receivedTime - Internal message date set to current time when received by Gmail.
292 dateHeader - Internal message time based on &#x27;Date&#x27; header in email, when valid.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700293 processForCalendar: boolean, Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700294 x__xgafv: string, V1 error format.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700295 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700296 1 - v1 error format
297 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700298 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800299 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Craig Citro065b5302014-08-14 00:47:23 -0700300
301Returns:
302 An object of the form:
303
304 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700305 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700306 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700307 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700308 &quot;A String&quot;,
309 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700310 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700311 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
312 &quot;parts&quot;: [ # 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.
313 # Object with schema name: MessagePart
314 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700315 &quot;headers&quot;: [ # 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`.
316 {
317 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
318 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
319 },
320 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700321 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
322 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700323 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
324 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700325 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700326 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700327 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700328 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700329 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700330 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
331 &quot;raw&quot;: &quot;A String&quot;, # 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.
332 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
333 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700334 }</pre>
335</div>
336
337<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700338 <code class="details" id="insert">insert(userId, body=None, deleted=None, internalDateSource=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
339 <pre>Directly inserts a message into only this user&#x27;s mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.
Craig Citro065b5302014-08-14 00:47:23 -0700340
341Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700342 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 body: object, The request body.
344 The object takes the form of:
345
346{ # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700347 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700348 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700349 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700350 &quot;A String&quot;,
351 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700352 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700353 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
354 &quot;parts&quot;: [ # 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.
355 # Object with schema name: MessagePart
356 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700357 &quot;headers&quot;: [ # 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`.
358 {
359 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
360 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
361 },
362 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700363 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
364 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700365 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
366 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700367 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700368 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700369 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700370 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700371 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700372 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
373 &quot;raw&quot;: &quot;A String&quot;, # 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.
374 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
375 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700376}
377
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700378 deleted: boolean, Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.
Bu Sun Kim65020912020-05-20 12:08:20 -0700379 internalDateSource: string, Source for Gmail&#x27;s internal date of the message.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700380 Allowed values
381 receivedTime - Internal message date set to current time when received by Gmail.
382 dateHeader - Internal message time based on &#x27;Date&#x27; header in email, when valid.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700383 x__xgafv: string, V1 error format.
Bu Sun Kim65020912020-05-20 12:08:20 -0700384 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700385 1 - v1 error format
386 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700387 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
388 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
389
390Returns:
391 An object of the form:
392
393 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700394 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700395 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700396 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700397 &quot;A String&quot;,
398 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700399 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700400 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
401 &quot;parts&quot;: [ # 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.
402 # Object with schema name: MessagePart
403 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700404 &quot;headers&quot;: [ # 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`.
405 {
406 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
407 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
408 },
409 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700410 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
411 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700412 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
413 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700414 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700415 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700416 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700417 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700418 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700419 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
420 &quot;raw&quot;: &quot;A String&quot;, # 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.
421 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
422 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700423 }</pre>
424</div>
425
426<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700427 <code class="details" id="list">list(userId, includeSpamTrash=None, q=None, labelIds=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700428 <pre>Lists the messages in the user&#x27;s mailbox.
429
430Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700431 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
432 includeSpamTrash: boolean, Include messages from `SPAM` and `TRASH` in the results.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700433 q: string, Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `&quot;from:someuser@example.com rfc822msgid: is:unread&quot;`. Parameter cannot be used when accessing the api using the gmail.metadata scope.
434 labelIds: string, Only return messages with labels that match all of the specified label IDs. (repeated)
435 maxResults: integer, Maximum number of messages to return.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700436 pageToken: string, Page token to retrieve a specific page of results in the list.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700437 x__xgafv: string, V1 error format.
438 Allowed values
439 1 - v1 error format
440 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700441
442Returns:
443 An object of the form:
444
445 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700446 &quot;messages&quot;: [ # List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method.
Craig Citro065b5302014-08-14 00:47:23 -0700447 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700448 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700449 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700450 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700451 &quot;A String&quot;,
452 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700453 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700454 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
455 &quot;parts&quot;: [ # 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.
456 # Object with schema name: MessagePart
457 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700458 &quot;headers&quot;: [ # 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`.
459 {
460 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
461 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
462 },
463 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700464 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
465 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700466 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
467 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700468 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700469 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700470 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700471 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700472 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700473 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
474 &quot;raw&quot;: &quot;A String&quot;, # 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.
475 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
476 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700477 },
478 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700479 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results in the list.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700480 &quot;resultSizeEstimate&quot;: 42, # Estimated total number of results.
Craig Citro065b5302014-08-14 00:47:23 -0700481 }</pre>
482</div>
483
484<div class="method">
485 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
486 <pre>Retrieves the next page of results.
487
488Args:
489 previous_request: The request for the previous page. (required)
490 previous_response: The response from the request for the previous page. (required)
491
492Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700493 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citro065b5302014-08-14 00:47:23 -0700494 page. Returns None if there are no more items in the collection.
495 </pre>
496</div>
497
498<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700499 <code class="details" id="modify">modify(userId, id, body=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700500 <pre>Modifies the labels on the specified message.
501
502Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700503 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700504 id: string, The ID of the message to modify. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700505 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700506 The object takes the form of:
507
508{
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700509 &quot;removeLabelIds&quot;: [ # A list IDs of labels to remove from this message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700510 &quot;A String&quot;,
Craig Citro065b5302014-08-14 00:47:23 -0700511 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700512 &quot;addLabelIds&quot;: [ # A list of IDs of labels to add to this message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700513 &quot;A String&quot;,
Craig Citro065b5302014-08-14 00:47:23 -0700514 ],
515 }
516
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700517 x__xgafv: string, V1 error format.
518 Allowed values
519 1 - v1 error format
520 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700521
522Returns:
523 An object of the form:
524
525 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700526 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700527 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700528 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700529 &quot;A String&quot;,
530 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700531 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700532 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
533 &quot;parts&quot;: [ # 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.
534 # Object with schema name: MessagePart
535 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700536 &quot;headers&quot;: [ # 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`.
537 {
538 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
539 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
540 },
541 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700542 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
543 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700544 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
545 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700546 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700547 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700548 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700549 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700550 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700551 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
552 &quot;raw&quot;: &quot;A String&quot;, # 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.
553 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
554 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700555 }</pre>
556</div>
557
558<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700559 <code class="details" id="send">send(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700560 <pre>Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers.
Craig Citro065b5302014-08-14 00:47:23 -0700561
562Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700563 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700564 body: object, The request body.
565 The object takes the form of:
566
567{ # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700568 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700569 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700570 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700571 &quot;A String&quot;,
572 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700573 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700574 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
575 &quot;parts&quot;: [ # 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.
576 # Object with schema name: MessagePart
577 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700578 &quot;headers&quot;: [ # 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`.
579 {
580 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
581 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
582 },
583 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700584 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
585 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700586 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
587 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700588 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700589 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700590 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700591 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700592 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700593 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
594 &quot;raw&quot;: &quot;A String&quot;, # 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.
595 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
596 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700597}
598
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700599 x__xgafv: string, V1 error format.
600 Allowed values
601 1 - v1 error format
602 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700603 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800604 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Craig Citro065b5302014-08-14 00:47:23 -0700605
606Returns:
607 An object of the form:
608
609 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700610 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700611 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700612 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700613 &quot;A String&quot;,
614 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700615 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700616 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
617 &quot;parts&quot;: [ # 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.
618 # Object with schema name: MessagePart
619 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700620 &quot;headers&quot;: [ # 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`.
621 {
622 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
623 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
624 },
625 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700626 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
627 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700628 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
629 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700630 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700631 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700632 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700633 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700634 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700635 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
636 &quot;raw&quot;: &quot;A String&quot;, # 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.
637 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
638 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700639 }</pre>
640</div>
641
642<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700643 <code class="details" id="trash">trash(userId, id, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700644 <pre>Moves the specified message to the trash.
645
646Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700647 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700648 id: string, The ID of the message to Trash. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700649 x__xgafv: string, V1 error format.
650 Allowed values
651 1 - v1 error format
652 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700653
654Returns:
655 An object of the form:
656
657 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700658 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700659 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700660 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700661 &quot;A String&quot;,
662 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700663 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700664 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
665 &quot;parts&quot;: [ # 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.
666 # Object with schema name: MessagePart
667 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700668 &quot;headers&quot;: [ # 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`.
669 {
670 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
671 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
672 },
673 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700674 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
675 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700676 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
677 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700678 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700679 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700680 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700681 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700682 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700683 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
684 &quot;raw&quot;: &quot;A String&quot;, # 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.
685 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
686 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700687 }</pre>
688</div>
689
690<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700691 <code class="details" id="untrash">untrash(userId, id, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700692 <pre>Removes the specified message from the trash.
693
694Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700695 userId: string, The user&#x27;s email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700696 id: string, The ID of the message to remove from Trash. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700697 x__xgafv: string, V1 error format.
698 Allowed values
699 1 - v1 error format
700 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700701
702Returns:
703 An object of the form:
704
705 { # An email message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700706 &quot;sizeEstimate&quot;: 42, # Estimated size in bytes of the message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700707 &quot;snippet&quot;: &quot;A String&quot;, # A short part of the message text.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700708 &quot;labelIds&quot;: [ # List of IDs of labels applied to this message.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700709 &quot;A String&quot;,
710 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700711 &quot;payload&quot;: { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700712 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the message part.
713 &quot;parts&quot;: [ # 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.
714 # Object with schema name: MessagePart
715 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700716 &quot;headers&quot;: [ # 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`.
717 {
718 &quot;name&quot;: &quot;A String&quot;, # The name of the header before the `:` separator. For example, `To`.
719 &quot;value&quot;: &quot;A String&quot;, # The value of the header after the `:` separator. For example, `someuser@example.com`.
720 },
721 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700722 &quot;filename&quot;: &quot;A String&quot;, # The filename of the attachment. Only present if this message part represents an attachment.
723 &quot;body&quot;: { # The body of a single MIME message part. # The message part body for this part, which may be empty for container MIME message parts.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700724 &quot;attachmentId&quot;: &quot;A String&quot;, # 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.
725 &quot;size&quot;: 42, # Number of bytes for the message part data (encoding notwithstanding).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700726 &quot;data&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700727 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700728 &quot;partId&quot;: &quot;A String&quot;, # The immutable ID of the message part.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700729 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700730 &quot;id&quot;: &quot;A String&quot;, # The immutable ID of the message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700731 &quot;internalDate&quot;: &quot;A String&quot;, # 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.
732 &quot;raw&quot;: &quot;A String&quot;, # 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.
733 &quot;historyId&quot;: &quot;A String&quot;, # The ID of the last history record that modified this message.
734 &quot;threadId&quot;: &quot;A String&quot;, # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700735 }</pre>
736</div>
737
738</body></html>