gmail.users.messages.list
GET {{baseUrl}}/gmail/v1/users/:userId/messages?includeSpamTrash=<boolean>&labelIds=<string>&labelIds=<string>&maxResults=<integer>&pageToken=<string>&q=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Lists the messages in the user's mailbox.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
includeSpamTrash | string | Include messages from SPAM and TRASH in the results. | |
labelIds | string | Only return messages with labels that match all of the specified label IDs. | |
labelIds | string | Only return messages with labels that match all of the specified label IDs. | |
maxResults | string | Maximum number of messages to return. | |
pageToken | string | Page token to retrieve a specific page of results in the list. | |
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. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | 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_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | 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_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"messages":[{"historyId":"aliqua elit","id":"in nisi","internalDate":"aliquip laboris Duis consectetur","labelIds":["l","adi"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"sed incididunt fugiat mollit","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"Excepteur qui consectetur irure","partId":"conseq","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"dolore occaecat eu sed","sizeEstimate":-81125746,"snippet":"elit incididunt pariatur","threadId":"ut proident ea velit id"},{"historyId":"veniam dolore ea ut reprehenderit","id":"reprehenderit Duis eu","internalDate":"adipisicing ex est ut","labelIds":["incididunt veniam","cupidatat esse aute magna"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"eli","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"ut do aliquip tempor","partId":"proident pariatur occaecat velit","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"sunt exercitation in","sizeEstimate":-16598599,"snippet":"dolor dolore","threadId":"sed sit enim"}],"nextPageToken":"velit cupidatat eu ullamco Lorem","resultSizeEstimate":-51081423}