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 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."],[[["Retrieves a specific send-as alias for a Gmail user using their email address."],["The request requires specifying the user's email address and the send-as alias email in the URL."],["An empty request body is necessary, and a successful response returns the details of the send-as alias."],["Authorization is required with one of the specified OAuth scopes, including access to Gmail settings or general Gmail access."]]],["This outlines retrieving a \"send-as\" alias via a `GET` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}`. The `userId` and `sendAsEmail` are path parameters, where \"me\" can replace the user's email. The request body must be empty. Successful requests return a `SendAs` instance, otherwise, a 404 error will occur if the alias is not found. One of the four listed OAuth scopes is required for authorization.\n"]]