REST Resource: users.settings.sendAs

Resource: SendAs

Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface.

JSON representation
{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    object (SmtpMsa)
  },
  "verificationStatus": enum (VerificationStatus)
}
Fields
sendAsEmail

string

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

displayName

string

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.

replyToAddress

string

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.

signature

string

An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.

isPrimary

boolean

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.

isDefault

boolean

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.

treatAsAlias

boolean

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

smtpMsa

object (SmtpMsa)

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.

verificationStatus

enum (VerificationStatus)

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

SmtpMsa

Configuration for communication with an SMTP service.

JSON representation
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Fields
host

string

The hostname of the SMTP service. Required.

port

integer

The port of the SMTP service. Required.

username

string

The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.

password

string

The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.

securityMode

enum (SecurityMode)

The protocol that will be used to secure communication with the SMTP service. Required.

SecurityMode

A protocol that may be used to secure communication with the SMTP service.

Enums
SECURITY_MODE_UNSPECIFIED Unspecified security mode.
NONE Communication with the remote SMTP service is unsecured. Requires port 25.
SSL Communication with the remote SMTP service is secured using SSL.
STARTTLS Communication with the remote SMTP service is secured using STARTTLS.

VerificationStatus

Indicates whether ownership of an address has been verified for its use as a send-as alias.

Enums
VERIFICATION_STATUS_UNSPECIFIED Unspecified verification status.
ACCEPTED The address is ready to use as a send-as alias.
PENDING The address is awaiting verification by the owner.

Methods

create

Creates a custom "from" send-as alias.

delete

Deletes the specified send-as alias.

get

Gets the specified send-as alias.

list

Lists the send-as aliases for the specified account.

patch

Patch the specified send-as alias.

update

Updates a send-as alias.

verify

Sends a verification email to the specified send-as alias address.