Method: users.settings.sendAs.get

Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}

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.

sendAsEmail

string

The send-as alias to be retrieved.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of SendAs.

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.