Method: users.drafts.get
Gets the specified draft.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts/{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 draft to retrieve.
|
Query parameters
| Parameters |
format |
enum (Format)
The format to return the draft in.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Draft.
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.compose
https://www.googleapis.com/auth/gmail.readonly
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 draft using the draft ID and user ID."],["Allows specifying the format of the returned draft using query parameters."],["Requires authorization with specific Gmail scopes like `mail.google.com` or `gmail.readonly`."],["Returns the draft details as a `Draft` object in the response body if successful."],["Uses gRPC Transcoding syntax for its URL structure."]]],["This API endpoint retrieves a specific draft from a user's Gmail account. It uses a `GET` request to the URL `https://gmail.googleapis.com/gmail/v1/users/{userId}/drafts/{id}`. Required path parameters include `userId` (user's email or \"me\") and `id` (draft ID). An optional query parameter, `format`, determines the draft's return format. The request body must be empty. The successful response returns a draft instance. Access requires specific OAuth scopes, such as `mail.google.com`.\n"]]
