v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-173225164.2 KB
users

Lists the messages in the user's mailbox.

get/users/{userId}/messages

Path parameters

userIdstring required

The user's email address. The special value me can be used to indicate the authenticated user

Query parameters

$.xgafv'1' | '2'

V1 error format

V1 error format

access_tokenstring

OAuth access token

alt'json' | 'media' | 'proto'

Data format for response

Data format for response

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token

oauth_tokenstring

OAuth 2.0 token for the current user

prettyPrintboolean

Returns response with indentations and line breaks

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart")

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart")

includeSpamTrashboolean

Include messages from SPAM and TRASH in the results

labelIdsstring[]

Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see Manage labels on messages and threads

maxResultsinteger

Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500

pageTokenstring

Page token to retrieve a specific page of results in the list

qstring

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

Response

Successful response

nextPageTokenstring

Token to retrieve the next page of results in the list

resultSizeEstimateinteger

Estimated total number of results