Method: users.settings.getAutoForwarding
Gets the auto-forwarding setting for the specified account.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/autoForwarding
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.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of AutoForwarding.
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."],[[["This API retrieves the auto-forwarding configuration for a specific Gmail account."],["It uses an HTTP GET request with the user's email address as a path parameter."],["An empty request body is required, and the response provides an AutoForwarding object containing the settings."],["Authorization is necessary using one of the specified OAuth scopes related to Gmail settings or access."]]],["This API retrieves the auto-forwarding settings for a specified Gmail account. It uses a `GET` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/autoForwarding`, where `userId` is the user's email or \"me\". The request body must be empty. A successful request returns an `AutoForwarding` instance in the response. Authorization requires one of four specified OAuth scopes: `gmail.settings.basic`, `mail.google.com`, `gmail.modify`, or `gmail.readonly`.\n"]]
