GET {{baseUrl}}/emails/mailboxes/:email/messages?maxResults=<string>&pageToken=<string>&labelIds=<string>&q=<string>&includeSpamTrash=<boolean>
Lists the messages in the user's mailbox. Scopes: Rate Limit Label: Not supported in Gov cluster mail:read
MEDIUM
Body
PARAM
Key | Datatype | Required | Description |
maxResults
|
string | Maximum number of messages to return. This field defaults to 50. The maximum allowed value for this field is 500. | |
pageToken
|
string | Page token to retrieve a specific page of results in the list. | |
labelIds
|
string | Only return messages with labels that match all of the specified label IDs in this query parameter. | |
q
|
string | Only return messages matching the specified elastic search query. | |
includeSpamTrash
|
string | Whether to include messages from SPAM and TRASH in the results. |
HEADERS
Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
{
"messages": [
{
"id": "<string>",
"threadId": "<string>"
},
{
"id": "<string>",
"threadId": "<string>"
}
],
"nextPageToken": "<string>",
"resultSizeEstimate": "<integer>"
} |
ENDPOINTS