Method: users.settings.forwardingAddresses.get
Gets the specified forwarding address.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
User's email address. The special value "me" can be used to indicate the authenticated user.
|
forwardingEmail |
string
The forwarding address to be retrieved.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ForwardingAddress.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/gmail.settings.basic
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
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 forwarding address for a Gmail user using their email address and the forwarding address."],["Requires an empty request body and returns a ForwardingAddress object upon successful execution."],["Needs authorization with specific OAuth scopes, including 'gmail.settings.basic', 'mail.google.com', 'gmail.modify', or 'gmail.readonly'."],["Utilizes a GET request with path parameters for user ID and forwarding email, adhering to gRPC Transcoding syntax."]]],["This document outlines how to retrieve a specific forwarding address using a GET request. The request URL structure is `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}`, where `userId` is the user's email or \"me,\" and `forwardingEmail` is the target address. The request body must be empty. A successful request returns a `ForwardingAddress` instance in the response body. The request needs authorization with one of the specified OAuth scopes.\n"]]
