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

If successful, the response body contains data with the following structure:

Response for the sendAs.list method.

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 OAuth 2.0 Overview.