Blame - docs/dyn/gmail_v1.users.messages.html - platform/external/python/google-api-python-client

blob: 01e0e5a61318bc592e6ea1ed8d31b6a413e6dd96 [file] [log] [blame]

Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	83	<code><a href="#batchDelete">batchDelete(userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<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 Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	85	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	86	<code><a href="#batchModify">batchModify(userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	87	<p class="firstline">Modifies the labels on the specified messages.</p>
				88	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	89	<code><a href="#close">close()</a></code></p>
				90	<p class="firstline">Close httplib2 connections.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	91	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	92	<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">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	95	<code><a href="#get">get(userId, id, metadataHeaders=None, format=None, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	96	<p class="firstline">Gets the specified message.</p>
				97	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	98	<code><a href="#import_">import_(userId, body=None, deleted=None, processForCalendar=None, internalDateSource=None, neverMarkSpam=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	99	<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 Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	100	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	101	<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 Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	103	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	104	<code><a href="#list">list(userId, q=None, pageToken=None, labelIds=None, maxResults=None, includeSpamTrash=None, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	105	<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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	110	<code><a href="#modify">modify(userId, id, body=None, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	111	<p class="firstline">Modifies the labels on the specified message.</p>
				112	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	113	<code><a href="#send">send(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	<p class="firstline">Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	115	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	116	<code><a href="#trash">trash(userId, id, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	117	<p class="firstline">Moves the specified message to the trash.</p>
				118	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	119	<code><a href="#untrash">untrash(userId, id, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	120	<p class="firstline">Removes the specified message from the trash.</p>
				121	<h3>Method Details</h3>
				122	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	123	<code class="details" id="batchDelete">batchDelete(userId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	<pre>Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	125
				126	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	127	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	128	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	129	The object takes the form of:
				130
				131	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	132	"ids": [ # The IDs of the messages to delete.
				133	"A String",
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	134	],
				135	}
				136
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	137	x__xgafv: string, V1 error format.
				138	Allowed values
				139	1 - v1 error format
				140	2 - v2 error format
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	141	</pre>
				142	</div>
				143
				144	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	145	<code class="details" id="batchModify">batchModify(userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	146	<pre>Modifies the labels on the specified messages.
				147
				148	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	149	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	150	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	151	The object takes the form of:
				152
				153	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	154	"addLabelIds": [ # A list of label IDs to add to messages.
				155	"A String",
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	156	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	157	"removeLabelIds": [ # A list of label IDs to remove from messages.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	158	"A String",
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	159	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	160	"ids": [ # The IDs of the messages to modify. There is a limit of 1000 ids per request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	161	"A String",
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	162	],
				163	}
				164
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	165	x__xgafv: string, V1 error format.
				166	Allowed values
				167	1 - v1 error format
				168	2 - v2 error format
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	169	</pre>
				170	</div>
				171
				172	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	173	<code class="details" id="close">close()</code>
				174	<pre>Close httplib2 connections.</pre>
				175	</div>
				176
				177	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	178	<code class="details" id="delete">delete(userId, id, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	179	<pre>Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	180
				181	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	182	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	183	id: string, The ID of the message to delete. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	184	x__xgafv: string, V1 error format.
				185	Allowed values
				186	1 - v1 error format
				187	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	188	</pre>
				189	</div>
				190
				191	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	192	<code class="details" id="get">get(userId, id, metadataHeaders=None, format=None, x__xgafv=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	193	<pre>Gets the specified message.
				194
				195	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	196	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	197	id: string, The ID of the message to retrieve. (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	198	metadataHeaders: string, When given and format is `METADATA`, only include headers specified. (repeated)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	199	format: string, The format to return the message in.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	200	Allowed values
				201	minimal - Returns only email message ID and labels; does not return the email headers, body, or payload.
				202	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.
				203	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.
				204	metadata - Returns only email message ID, labels, and email headers.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	205	x__xgafv: string, V1 error format.
				206	Allowed values
				207	1 - v1 error format
				208	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	209
				210	Returns:
				211	An object of the form:
				212
				213	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	214	"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.
				215	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	216	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	217	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	218	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	219	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	220	"A String",
				221	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	222	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	223	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	224	"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.
				225	# Object with schema name: MessagePart
				226	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	227	"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`.
				228	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	229	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	230	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	231	},
				232	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	233	"partId": "A String", # The immutable ID of the message part.
				234	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	235	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				236	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	237	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	238	"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.
				239	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				240	},
				241	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	242	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	243	}</pre>
				244	</div>
				245
				246	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	247	<code class="details" id="import_">import_(userId, body=None, deleted=None, processForCalendar=None, internalDateSource=None, neverMarkSpam=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	248	<pre>Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	249
				250	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	251	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	252	body: object, The request body.
				253	The object takes the form of:
				254
				255	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	256	"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.
				257	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	258	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	259	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	260	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	261	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	262	"A String",
				263	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	264	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	265	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	266	"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.
				267	# Object with schema name: MessagePart
				268	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	269	"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`.
				270	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	271	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	272	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	273	},
				274	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	275	"partId": "A String", # The immutable ID of the message part.
				276	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	277	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				278	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	279	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	280	"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.
				281	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				282	},
				283	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	284	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	285	}
				286
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	287	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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	288	processForCalendar: boolean, Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	289	internalDateSource: string, Source for Gmail's internal date of the message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	290	Allowed values
				291	receivedTime - Internal message date set to current time when received by Gmail.
				292	dateHeader - Internal message time based on 'Date' header in email, when valid.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	293	neverMarkSpam: boolean, Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	294	x__xgafv: string, V1 error format.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	295	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	296	1 - v1 error format
				297	2 - v2 error format
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	298	media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	299	media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	300
				301	Returns:
				302	An object of the form:
				303
				304	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	305	"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.
				306	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	307	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	308	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	309	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	310	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	311	"A String",
				312	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	313	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	314	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	315	"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.
				316	# Object with schema name: MessagePart
				317	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	318	"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`.
				319	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	320	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	321	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	322	},
				323	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	324	"partId": "A String", # The immutable ID of the message part.
				325	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	326	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				327	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	328	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	329	"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.
				330	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				331	},
				332	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	333	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	334	}</pre>
				335	</div>
				336
				337	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	338	<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's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	340
				341	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	342	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	343	body: object, The request body.
				344	The object takes the form of:
				345
				346	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	347	"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.
				348	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	349	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	350	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	351	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	352	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	353	"A String",
				354	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	355	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	356	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	357	"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.
				358	# Object with schema name: MessagePart
				359	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	360	"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`.
				361	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	362	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	363	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	364	},
				365	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	366	"partId": "A String", # The immutable ID of the message part.
				367	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	368	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				369	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	370	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	371	"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.
				372	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				373	},
				374	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	375	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	376	}
				377
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	378	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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	379	internalDateSource: string, Source for Gmail's internal date of the message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	380	Allowed values
				381	receivedTime - Internal message date set to current time when received by Gmail.
				382	dateHeader - Internal message time based on 'Date' header in email, when valid.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	383	x__xgafv: string, V1 error format.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	384	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	385	1 - v1 error format
				386	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	387	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
				390	Returns:
				391	An object of the form:
				392
				393	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	394	"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.
				395	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	396	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	397	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	398	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	399	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	400	"A String",
				401	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	402	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	403	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	404	"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.
				405	# Object with schema name: MessagePart
				406	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	407	"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`.
				408	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	409	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	410	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	411	},
				412	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	413	"partId": "A String", # The immutable ID of the message part.
				414	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	415	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				416	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	417	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	418	"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.
				419	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				420	},
				421	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	422	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	423	}</pre>
				424	</div>
				425
				426	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	427	<code class="details" id="list">list(userId, q=None, pageToken=None, labelIds=None, maxResults=None, includeSpamTrash=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	428	<pre>Lists the messages in the user's mailbox.
				429
				430	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	431	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	432	q: string, Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	433	pageToken: string, Page token to retrieve a specific page of results in the list.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	436	includeSpamTrash: boolean, Include messages from `SPAM` and `TRASH` in the results.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	437	x__xgafv: string, V1 error format.
				438	Allowed values
				439	1 - v1 error format
				440	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	441
				442	Returns:
				443	An object of the form:
				444
				445	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	446	"messages": [ # List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	447	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	448	"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.
				449	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	450	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	451	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	452	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	453	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	454	"A String",
				455	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	456	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	457	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	458	"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.
				459	# Object with schema name: MessagePart
				460	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	461	"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`.
				462	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	463	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	464	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	465	},
				466	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	467	"partId": "A String", # The immutable ID of the message part.
				468	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	469	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				470	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	471	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	472	"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.
				473	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				474	},
				475	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	476	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	477	},
				478	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	479	"resultSizeEstimate": 42, # Estimated total number of results.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	480	"nextPageToken": "A String", # Token to retrieve the next page of results in the list.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	481	}</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
				488	Args:
				489	previous_request: The request for the previous page. (required)
				490	previous_response: The response from the request for the previous page. (required)
				491
				492	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	493	A request object that you can call 'execute()' on to request the next
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	494	page. Returns None if there are no more items in the collection.
				495	</pre>
				496	</div>
				497
				498	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	499	<code class="details" id="modify">modify(userId, id, body=None, x__xgafv=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	500	<pre>Modifies the labels on the specified message.
				501
				502	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	503	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	504	id: string, The ID of the message to modify. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	505	body: object, The request body.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	506	The object takes the form of:
				507
				508	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	509	"removeLabelIds": [ # A list IDs of labels to remove from this message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	510	"A String",
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	511	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	512	"addLabelIds": [ # A list of IDs of labels to add to this message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	513	"A String",
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	514	],
				515	}
				516
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	517	x__xgafv: string, V1 error format.
				518	Allowed values
				519	1 - v1 error format
				520	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	521
				522	Returns:
				523	An object of the form:
				524
				525	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	526	"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.
				527	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	528	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	529	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	530	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	531	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	532	"A String",
				533	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	534	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	535	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	536	"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.
				537	# Object with schema name: MessagePart
				538	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	539	"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`.
				540	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	541	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	542	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	543	},
				544	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	545	"partId": "A String", # The immutable ID of the message part.
				546	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	547	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				548	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	549	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	550	"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.
				551	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				552	},
				553	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	554	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	555	}</pre>
				556	</div>
				557
				558	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	559	<code class="details" id="send">send(userId, body=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	560	<pre>Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	561
				562	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	563	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	564	body: object, The request body.
				565	The object takes the form of:
				566
				567	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	568	"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.
				569	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	570	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	571	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	572	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	573	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	574	"A String",
				575	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	576	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	577	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	578	"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.
				579	# Object with schema name: MessagePart
				580	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	581	"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`.
				582	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	583	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	584	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	585	},
				586	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	587	"partId": "A String", # The immutable ID of the message part.
				588	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	589	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				590	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	591	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	592	"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.
				593	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				594	},
				595	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	596	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	597	}
				598
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	599	x__xgafv: string, V1 error format.
				600	Allowed values
				601	1 - v1 error format
				602	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	603	media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	604	media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	605
				606	Returns:
				607	An object of the form:
				608
				609	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	610	"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.
				611	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	612	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	613	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	614	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	615	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	616	"A String",
				617	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	618	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	619	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	620	"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.
				621	# Object with schema name: MessagePart
				622	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	623	"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`.
				624	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	625	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	626	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	627	},
				628	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	629	"partId": "A String", # The immutable ID of the message part.
				630	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	631	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				632	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	633	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	634	"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.
				635	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				636	},
				637	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	638	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	639	}</pre>
				640	</div>
				641
				642	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	643	<code class="details" id="trash">trash(userId, id, x__xgafv=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	644	<pre>Moves the specified message to the trash.
				645
				646	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	647	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	648	id: string, The ID of the message to Trash. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	649	x__xgafv: string, V1 error format.
				650	Allowed values
				651	1 - v1 error format
				652	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	653
				654	Returns:
				655	An object of the form:
				656
				657	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	658	"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.
				659	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	660	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	661	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	662	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	663	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	664	"A String",
				665	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	666	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	667	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	668	"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.
				669	# Object with schema name: MessagePart
				670	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	671	"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`.
				672	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	673	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	674	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	675	},
				676	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	677	"partId": "A String", # The immutable ID of the message part.
				678	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	679	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				680	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	681	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	682	"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.
				683	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				684	},
				685	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	686	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	687	}</pre>
				688	</div>
				689
				690	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	691	<code class="details" id="untrash">untrash(userId, id, x__xgafv=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	692	<pre>Removes the specified message from the trash.
				693
				694	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	695	userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	696	id: string, The ID of the message to remove from Trash. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	697	x__xgafv: string, V1 error format.
				698	Allowed values
				699	1 - v1 error format
				700	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	701
				702	Returns:
				703	An object of the form:
				704
				705	{ # An email message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	706	"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.
				707	"id": "A String", # The immutable ID of the message.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	708	"sizeEstimate": 42, # Estimated size in bytes of the message.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	709	"threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	710	"snippet": "A String", # A short part of the message text.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	711	"labelIds": [ # List of IDs of labels applied to this message.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	712	"A String",
				713	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	714	"historyId": "A String", # The ID of the last history record that modified this message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	715	"payload": { # A single MIME message part. # The parsed email structure in the message parts.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	716	"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.
				717	# Object with schema name: MessagePart
				718	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	719	"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`.
				720	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	721	"value": "A String", # The value of the header after the `:` separator. For example, `someuser@example.com`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	722	"name": "A String", # The name of the header before the `:` separator. For example, `To`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	723	},
				724	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	725	"partId": "A String", # The immutable ID of the message part.
				726	"mimeType": "A String", # The MIME type of the message part.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	727	"filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment.
				728	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	729	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	730	"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.
				731	"size": 42, # Number of bytes for the message part data (encoding notwithstanding).
				732	},
				733	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	734	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	735	}</pre>
				736	</div>
				737
				738	</body></html>