Stay organized with collections Save and categorize content based on your preferences.
Lists the messages in the user's mailbox. For example usage, see List Gmail messages.
HTTP requestGET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
The URL uses gRPC Transcoding syntax.
Path parameters ParametersuserId
string
The user's email address. The special value me can be used to indicate the authenticated user.
maxResults
integer (uint32 format)
Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.
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. To learn more, see Manage labels on messages and threads.
includeSpamTrash
boolean
Include messages from SPAM and TRASH in the results.
The request body must be empty.
Response bodyIf successful, the response body contains data with the following structure:
JSON representation{
"messages": [
{
object (Message)
}
],
"nextPageToken": string,
"resultSizeEstimate": integer
} Fields messages[]
object (Message)
List of messages. Note that each message resource contains only an id and a threadId. Additional message details can be fetched using the messages.get method.
nextPageToken
string
Token to retrieve the next page of results in the list.
resultSizeEstimate
integer (uint32 format)
Estimated total number of results.
Requires one of the following OAuth scopes:
https://mail.google.com/ https://www.googleapis.com/auth/gmail.modify https://www.googleapis.com/auth/gmail.readonly https://www.googleapis.com/auth/gmail.metadataFor more information, see the Authorization guide.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4