Method: users.settings.forwardingAddresses.list
Lists the forwarding addresses for the specified account.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses
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
Response for the forwardingAddresses.list method.
If successful, the response body contains data with the following structure:
| Fields |
forwardingAddresses[] |
object (ForwardingAddress)
List of addresses that may be used for forwarding.
|
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 lists email forwarding addresses for a specified Gmail account."],["It uses an HTTP GET request with the user's email address as a path parameter."],["The response includes a list of forwarding addresses in JSON format."],["Authorization is required using one of the listed OAuth scopes, such as `https://www.googleapis.com/auth/gmail.settings.basic` or `https://www.googleapis.com/auth/gmail.readonly`."]]],["This document outlines how to list forwarding addresses for a Gmail account. A `GET` request is sent to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses`, using the user's email or \"me\" as the `userId` path parameter. The request body must be empty. A successful response returns a JSON object containing an array of forwarding addresses. Authorization requires specific OAuth scopes like `gmail.settings.basic`, `mail.google.com`, `gmail.modify`, or `gmail.readonly`.\n"]]
