Gmail profile for listing messages. Supports Gmail q-syntax for filtering.
Implements: List email messages (org.intentschema.communication.email.message.list.v1)
| Field | Type | Description |
|---|---|---|
target * | Target | (system = "gmail", required: system) |
object | object | |
gmail @com.google.gmail | object |
object| Field | Type | Description |
|---|---|---|
query | string | Provider-specific search string (Gmail syntax, JMAP filter string, Outlook KQL). Applied alongside `filter` if both are provided. |
filter | object | Structured filter, JMAP-inspired. |
limit | integer (minimum 1; maximum 500; default 50) | |
cursor | string | Opaque pagination cursor returned by a prior search. |
filter| Field | Type | Description |
|---|---|---|
from | string | |
to | string | |
subject | string | |
body | string | |
has_attachment | boolean | |
is_unread | boolean | |
after | string (date-time) | |
before | string (date-time) | |
labels_any | string[] | |
labels_all | string[] |
gmail @com.google.gmail| Field | Type | Description |
|---|---|---|
q | string | Gmail search query syntax. |
includeSpamTrash | boolean |
| Field | Type | Description |
|---|---|---|
messages * | object[] | |
next_cursor | string | Present when more results are available. |
estimated_total | integer | Optional provider estimate of total matches. |
| Field | Value |
|---|---|
base_url | https://gmail.googleapis.com |
method | GET |
path | /gmail/v1/users/me/messages |
scopes | https://www.googleapis.com/auth/gmail.readonly |
docs | https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list |
| Intent field | API parameter |
|---|---|
object.query | q (Gmail search syntax) |
object.filter.from | q parameter: from:<value> |
object.filter.to | q parameter: to:<value> |
object.filter.subject | q parameter: subject:<value> |
object.filter.has_attachment | q parameter: has:attachment |
object.filter.is_unread | q parameter: is:unread |
object.filter.after | q parameter: after:<epoch> |
object.filter.before | q parameter: before:<epoch> |
object.filter.labels_any | q parameter: label:<value> |
object.limit | maxResults |
object.cursor | pageToken |
gmail.q | q (raw Gmail search syntax, overrides filter) |
gmail.includeSpamTrash | includeSpamTrash (boolean query param) |