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. This ID is usually retrieved using messages.list. The ID is also contained in the result when a message is inserted (messages.insert) or imported (messages.import).
|
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
For more information, see the Authorization guide.
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Retrieves a specific email message using the message ID and user ID."],["Allows specifying the message format (e.g., full, metadata) and specific metadata headers to include."],["Requires authorization with specific Gmail scopes, such as read-only, modify, or metadata access."],["Returns the complete message data or metadata, depending on the requested format, in the response."],["Utilizes an HTTP GET request with path and query parameters to specify the request details."]]],["This content outlines how to retrieve a specific message from a user's Gmail account. It uses a `GET` request to a URL with the user's ID and message ID as path parameters. Optional query parameters (`format`, `metadataHeaders`) refine the response. The request body must be empty, and a successful response returns a Message object. Authorization requires specific OAuth scopes, including options for read-only, modification, or metadata access.\n"]]
