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. For more information, see Manage aliases and signatures with the Gmail API.

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 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 2026年04月15日 UTC.