Method: users.settings.sendAs.list
Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs
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 sendAs.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"sendAs": [
{
object (SendAs)
}
]
} |
| Fields |
sendAs[] |
object (SendAs)
List of send-as aliases.
|
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."],[[["Lists send-as aliases, including the primary address and custom \"from\" aliases, for a specified Gmail account."],["Uses an HTTP GET request with the user's email address as a path parameter."],["Returns a JSON response containing an array of send-as aliases with details."],["Requires specific OAuth scopes for authorization, like `gmail.settings.basic` or `gmail.readonly`."]]],["This describes how to retrieve send-as aliases for a Gmail account. Using a `GET` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs`, specifying the user's email (or \"me\") in the `userId` path parameter. The request body must be empty. The successful response includes a JSON object with a `sendAs` array, detailing the account's primary send-as address and custom \"from\" aliases. This action requires specific OAuth scopes like `gmail.settings.basic` or `mail.google.com`.\n"]]
