1<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.threads.html">threads</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(userId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(userId, id, format=None, metadataHeaders=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the specified thread.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(userId, includeSpamTrash=None, labelIds=None, maxResults=None, pageToken=None, q=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists the threads in the user's mailbox.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#modify">modify(userId, id, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Modifies the labels applied to the thread. This applies to all messages in the thread.</p> 95<p class="toc_element"> 96 <code><a href="#trash">trash(userId, id, x__xgafv=None)</a></code></p> 97<p class="firstline">Moves the specified thread to the trash.</p> 98<p class="toc_element"> 99 <code><a href="#untrash">untrash(userId, id, x__xgafv=None)</a></code></p> 100<p class="firstline">Removes the specified thread from the trash.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(userId, id, x__xgafv=None)</code> 109 <pre>Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer `threads.trash` instead. 110 111Args: 112 userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) 113 id: string, ID of the Thread to delete. (required) 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118</pre> 119</div> 120 121<div class="method"> 122 <code class="details" id="get">get(userId, id, format=None, metadataHeaders=None, x__xgafv=None)</code> 123 <pre>Gets the specified thread. 124 125Args: 126 userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) 127 id: string, The ID of the thread to retrieve. (required) 128 format: string, The format to return the messages in. 129 Allowed values 130 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. 131 metadata - Returns only email message IDs, labels, and email headers. 132 minimal - Returns only email message IDs and labels; does not return the email headers, body, or payload. 133 metadataHeaders: string, When given and format is METADATA, only include headers specified. (repeated) 134 x__xgafv: string, V1 error format. 135 Allowed values 136 1 - v1 error format 137 2 - v2 error format 138 139Returns: 140 An object of the form: 141 142 { # A collection of messages representing a conversation. 143 "historyId": "A String", # The ID of the last history record that modified this thread. 144 "id": "A String", # The unique ID of the thread. 145 "messages": [ # The list of messages in the thread. 146 { # An email message. 147 "historyId": "A String", # The ID of the last history record that modified this message. 148 "id": "A String", # The immutable ID of the message. 149 "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. 150 "labelIds": [ # List of IDs of labels applied to this message. 151 "A String", 152 ], 153 "payload": { # A single MIME message part. # The parsed email structure in the message parts. 154 "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. 155 "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. 156 "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. 157 "size": 42, # Number of bytes for the message part data (encoding notwithstanding). 158 }, 159 "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment. 160 "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`. 161 { 162 "name": "A String", # The name of the header before the `:` separator. For example, `To`. 163 "value": "A String", # The value of the header after the `:` separator. For example, `[email protected]`. 164 }, 165 ], 166 "mimeType": "A String", # The MIME type of the message part. 167 "partId": "A String", # The immutable ID of the message part. 168 "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. 169 # Object with schema name: MessagePart 170 ], 171 }, 172 "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. 173 "sizeEstimate": 42, # Estimated size in bytes of the message. 174 "snippet": "A String", # A short part of the message text. 175 "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. 176 }, 177 ], 178 "snippet": "A String", # A short part of the message text. 179}</pre> 180</div> 181 182<div class="method"> 183 <code class="details" id="list">list(userId, includeSpamTrash=None, labelIds=None, maxResults=None, pageToken=None, q=None, x__xgafv=None)</code> 184 <pre>Lists the threads in the user's mailbox. 185 186Args: 187 userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) 188 includeSpamTrash: boolean, Include threads from `SPAM` and `TRASH` in the results. 189 labelIds: string, Only return threads with labels that match all of the specified label IDs. (repeated) 190 maxResults: integer, Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500. 191 pageToken: string, Page token to retrieve a specific page of results in the list. 192 q: string, Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:[email protected] rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope. 193 x__xgafv: string, V1 error format. 194 Allowed values 195 1 - v1 error format 196 2 - v2 error format 197 198Returns: 199 An object of the form: 200 201 { 202 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. 203 "resultSizeEstimate": 42, # Estimated total number of results. 204 "threads": [ # List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the threads.get method. 205 { # A collection of messages representing a conversation. 206 "historyId": "A String", # The ID of the last history record that modified this thread. 207 "id": "A String", # The unique ID of the thread. 208 "messages": [ # The list of messages in the thread. 209 { # An email message. 210 "historyId": "A String", # The ID of the last history record that modified this message. 211 "id": "A String", # The immutable ID of the message. 212 "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. 213 "labelIds": [ # List of IDs of labels applied to this message. 214 "A String", 215 ], 216 "payload": { # A single MIME message part. # The parsed email structure in the message parts. 217 "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. 218 "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. 219 "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. 220 "size": 42, # Number of bytes for the message part data (encoding notwithstanding). 221 }, 222 "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment. 223 "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`. 224 { 225 "name": "A String", # The name of the header before the `:` separator. For example, `To`. 226 "value": "A String", # The value of the header after the `:` separator. For example, `[email protected]`. 227 }, 228 ], 229 "mimeType": "A String", # The MIME type of the message part. 230 "partId": "A String", # The immutable ID of the message part. 231 "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. 232 # Object with schema name: MessagePart 233 ], 234 }, 235 "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. 236 "sizeEstimate": 42, # Estimated size in bytes of the message. 237 "snippet": "A String", # A short part of the message text. 238 "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. 239 }, 240 ], 241 "snippet": "A String", # A short part of the message text. 242 }, 243 ], 244}</pre> 245</div> 246 247<div class="method"> 248 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 249 <pre>Retrieves the next page of results. 250 251Args: 252 previous_request: The request for the previous page. (required) 253 previous_response: The response from the request for the previous page. (required) 254 255Returns: 256 A request object that you can call 'execute()' on to request the next 257 page. Returns None if there are no more items in the collection. 258 </pre> 259</div> 260 261<div class="method"> 262 <code class="details" id="modify">modify(userId, id, body=None, x__xgafv=None)</code> 263 <pre>Modifies the labels applied to the thread. This applies to all messages in the thread. 264 265Args: 266 userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) 267 id: string, The ID of the thread to modify. (required) 268 body: object, The request body. 269 The object takes the form of: 270 271{ 272 "addLabelIds": [ # A list of IDs of labels to add to this thread. 273 "A String", 274 ], 275 "removeLabelIds": [ # A list of IDs of labels to remove from this thread. 276 "A String", 277 ], 278} 279 280 x__xgafv: string, V1 error format. 281 Allowed values 282 1 - v1 error format 283 2 - v2 error format 284 285Returns: 286 An object of the form: 287 288 { # A collection of messages representing a conversation. 289 "historyId": "A String", # The ID of the last history record that modified this thread. 290 "id": "A String", # The unique ID of the thread. 291 "messages": [ # The list of messages in the thread. 292 { # An email message. 293 "historyId": "A String", # The ID of the last history record that modified this message. 294 "id": "A String", # The immutable ID of the message. 295 "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. 296 "labelIds": [ # List of IDs of labels applied to this message. 297 "A String", 298 ], 299 "payload": { # A single MIME message part. # The parsed email structure in the message parts. 300 "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. 301 "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. 302 "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. 303 "size": 42, # Number of bytes for the message part data (encoding notwithstanding). 304 }, 305 "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment. 306 "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`. 307 { 308 "name": "A String", # The name of the header before the `:` separator. For example, `To`. 309 "value": "A String", # The value of the header after the `:` separator. For example, `[email protected]`. 310 }, 311 ], 312 "mimeType": "A String", # The MIME type of the message part. 313 "partId": "A String", # The immutable ID of the message part. 314 "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. 315 # Object with schema name: MessagePart 316 ], 317 }, 318 "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. 319 "sizeEstimate": 42, # Estimated size in bytes of the message. 320 "snippet": "A String", # A short part of the message text. 321 "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. 322 }, 323 ], 324 "snippet": "A String", # A short part of the message text. 325}</pre> 326</div> 327 328<div class="method"> 329 <code class="details" id="trash">trash(userId, id, x__xgafv=None)</code> 330 <pre>Moves the specified thread to the trash. 331 332Args: 333 userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) 334 id: string, The ID of the thread to Trash. (required) 335 x__xgafv: string, V1 error format. 336 Allowed values 337 1 - v1 error format 338 2 - v2 error format 339 340Returns: 341 An object of the form: 342 343 { # A collection of messages representing a conversation. 344 "historyId": "A String", # The ID of the last history record that modified this thread. 345 "id": "A String", # The unique ID of the thread. 346 "messages": [ # The list of messages in the thread. 347 { # An email message. 348 "historyId": "A String", # The ID of the last history record that modified this message. 349 "id": "A String", # The immutable ID of the message. 350 "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. 351 "labelIds": [ # List of IDs of labels applied to this message. 352 "A String", 353 ], 354 "payload": { # A single MIME message part. # The parsed email structure in the message parts. 355 "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. 356 "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. 357 "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. 358 "size": 42, # Number of bytes for the message part data (encoding notwithstanding). 359 }, 360 "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment. 361 "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`. 362 { 363 "name": "A String", # The name of the header before the `:` separator. For example, `To`. 364 "value": "A String", # The value of the header after the `:` separator. For example, `[email protected]`. 365 }, 366 ], 367 "mimeType": "A String", # The MIME type of the message part. 368 "partId": "A String", # The immutable ID of the message part. 369 "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. 370 # Object with schema name: MessagePart 371 ], 372 }, 373 "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. 374 "sizeEstimate": 42, # Estimated size in bytes of the message. 375 "snippet": "A String", # A short part of the message text. 376 "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. 377 }, 378 ], 379 "snippet": "A String", # A short part of the message text. 380}</pre> 381</div> 382 383<div class="method"> 384 <code class="details" id="untrash">untrash(userId, id, x__xgafv=None)</code> 385 <pre>Removes the specified thread from the trash. 386 387Args: 388 userId: string, The user's email address. The special value `me` can be used to indicate the authenticated user. (required) 389 id: string, The ID of the thread to remove from Trash. (required) 390 x__xgafv: string, V1 error format. 391 Allowed values 392 1 - v1 error format 393 2 - v2 error format 394 395Returns: 396 An object of the form: 397 398 { # A collection of messages representing a conversation. 399 "historyId": "A String", # The ID of the last history record that modified this thread. 400 "id": "A String", # The unique ID of the thread. 401 "messages": [ # The list of messages in the thread. 402 { # An email message. 403 "historyId": "A String", # The ID of the last history record that modified this message. 404 "id": "A String", # The immutable ID of the message. 405 "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. 406 "labelIds": [ # List of IDs of labels applied to this message. 407 "A String", 408 ], 409 "payload": { # A single MIME message part. # The parsed email structure in the message parts. 410 "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. 411 "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. 412 "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. 413 "size": 42, # Number of bytes for the message part data (encoding notwithstanding). 414 }, 415 "filename": "A String", # The filename of the attachment. Only present if this message part represents an attachment. 416 "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`. 417 { 418 "name": "A String", # The name of the header before the `:` separator. For example, `To`. 419 "value": "A String", # The value of the header after the `:` separator. For example, `[email protected]`. 420 }, 421 ], 422 "mimeType": "A String", # The MIME type of the message part. 423 "partId": "A String", # The immutable ID of the message part. 424 "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. 425 # Object with schema name: MessagePart 426 ], 427 }, 428 "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. 429 "sizeEstimate": 42, # Estimated size in bytes of the message. 430 "snippet": "A String", # A short part of the message text. 431 "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. 432 }, 433 ], 434 "snippet": "A String", # A short part of the message text. 435}</pre> 436</div> 437 438</body></html>