Method: users.messages.get

Gets the specified message.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

The user's email address. The special value me can be used to indicate the authenticated user.

id

string

The ID of the message to retrieve.

Query parameters

Parameters
format

enum (Format)

The format to return the message in.

metadataHeaders

string

When given and format is METADATA, only include headers specified.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Message.

Authorization Scopes

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.metadata
  • https://www.googleapis.com/auth/gmail.addons.current.message.metadata
  • https://www.googleapis.com/auth/gmail.addons.current.message.readonly
  • https://www.googleapis.com/auth/gmail.addons.current.message.action

For more information, see the OAuth 2.0 Overview.