messages_list - Charter Docs

GET

gmail_messages_list.py

import asyncio

from charter.packs import gmail

result = asyncio.run(gmail.messages_list.ainvoke({}))

Requires https://www.googleapis.com/auth/gmail.readonly, or any of https://www.googleapis.com/auth/gmail.modify or https://mail.google.com/. Pages by cursor: nextPageToken is sent back as pageToken. Costs 5 against the provider’s own quota.

Path parameters

Field	Type	Description
`userId`	`string`	The user’s email address. The special value ‘me’ can be used to indicate the authenticated user. defaults to `"me"`

Query parameters

Field	Type	Description
`maxResults`	`integer`	Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500. ≥ 1; ≤ 500; defaults to `100`
`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:<somemsgid@example.com> is:unread”. Parameter cannot be used when accessing the api using the gmail.metadata scope.
`labelIds`	`string`[]	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.
`includeSpamTrash`	`boolean`	Include messages from SPAM and TRASH in the results.