/gmail/v1/users/{userId}/settings/sendAs

GET

users

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//settings/sendAs'

Response Example

{
  "sendAs": [
    {
      "displayName": "string",
      "isDefault": true,
      "isPrimary": true,
      "replyToAddress": "string",
      "sendAsEmail": "string",
      "signature": "string",
      "smtpMsa": {
        "host": "string",
        "password": "string",
        "port": 0,
        "securityMode": "securityModeUnspecified",
        "username": "string"
      },
      "treatAsAlias": true,
      "verificationStatus": "verificationStatusUnspecified"
    }
  ]
}

Request

Path Params

userId

string

required

User's email address. The special value "me" can be used to indicate the authenticated user.

Responses

🟢200Successful response

application/json

Body

Response for the ListSendAs method.

sendAs

array[object (SendAs) {9}]

optional

List of send-as aliases.

displayName

string

optional

A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.

isDefault

boolean

optional

Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.

isPrimary

boolean

optional

Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.

replyToAddress

string

optional

An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.

sendAsEmail

string

optional

The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.

signature

string

optional

An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.

smtpMsa

object (SmtpMsa)

optional

An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.

treatAsAlias

boolean

optional

Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.

verificationStatus

enum<string>

optional

Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.

Allowed values:

verificationStatusUnspecifiedacceptedpending

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/settings/pop

/gmail/v1/users/{userId}/settings/sendAs