Stay organized with collections Save and categorize content based on your preferences.
This page explains how to call the Gmail API's users.messages.list
method.
The method returns an array of Gmail Message
resources that contain the message id
and threadId
. To retrieve full message details, use the users.messages.get
method.
The users.messages.list
method supports several query parameters to filter the messages:
maxResults
: Maximum number of messages to return (defaults to 100, max 500).pageToken
: Token to retrieve a specific page of results.q
: Query string to filter messages, such as from:someuser@example.com is:unread"
.labelIds
: Only return messages with labels that match all specified label IDs.includeSpamTrash
: Include messages from SPAM
and TRASH
in the results.The following code sample shows how to list messages for the authenticated Gmail user. The code handles pagination to retrieve all messages matching the query.
The users.messages.list
method returns a response body that contains the following:
messages[]
: An array of Message
resources.nextPageToken
: For requests with multiple pages of results, a token that can be used with a subsequent calls to list more messages.resultSizeEstimate
: An estimated total number of results.To fetch the full message content and metadata, use the message.id
field to call the users.messages.get
method.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-04 UTC."],[],[]]
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