gmail.users.settings.sendAs.get
Retrieves a Gmail user's specified send-as alias details and returns its configuration as JSON, helping inspect alias, signature, and sending settings before updates.
Instructions
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 GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, list, patch, update, verify.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] User's email address. The special value "me" can be used to indicate the authenticated user. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. | |
| sendAsEmail | Yes | [URL path segment] The send-as alias to be retrieved. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| smtpMsa | No | ||
| isDefault | No | ||
| isPrimary | No | ||
| signature | No | ||
| displayName | No | ||
| sendAsEmail | No | ||
| treatAsAlias | No | ||
| replyToAddress | No | ||
| verificationStatus | No |