Lists the messages in the user's mailbox.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.metadata
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly

If unset, the scope for this method defaults to https://www.googleapis.com/auth/gmail.readonly. You can set the scope for this method like this: gmail1 --scope <scope> users messages-list ...

Required Scalar Argument

  • <user-id> (string)
    • The user's email address. The special value me can be used to indicate the authenticated user.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p include-spam-trash=boolean

    • Include messages from SPAM and TRASH in the results.

  • -p label-ids=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.

  • -p max-results=integer

    • Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.

  • -p page-token=string

    • Page token to retrieve a specific page of results in the list.

  • -p q=string

    • Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, &#34;from:someuser@example.com rfc822msgid: is:unread&#34;. Parameter cannot be used when accessing the api using the gmail.metadata scope.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").