Users.settings.sendAs

For a list of methods for this resource, see the end of this page.

Resource representations

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.

{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    "host": string,
    "port": integer,
    "username": string,
    "password": string,
    "securityMode": string
  },
  "verificationStatus": string
}
Property name Value Description Notes
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.
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.
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.
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.
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.
signature string An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
smtpMsa nested object 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.
smtpMsa.host string The hostname of the SMTP service. Required.
smtpMsa.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.
smtpMsa.port integer The port of the SMTP service. Required.
smtpMsa.securityMode string The protocol that will be used to secure communication with the SMTP service. Required.

Acceptable values are:
  • "none"
  • "securityModeUnspecified"
  • "ssl"
  • "starttls"
smtpMsa.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.
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.
verificationStatus string Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.

Acceptable values are:
  • "accepted"
  • "pending"
  • "verificationStatusUnspecified"

Methods

create
Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

This method is only available to service account clients that have been delegated domain-wide authority.
delete
Deletes the specified send-as alias. Revokes any verification that may have been required for using it.

This method is only available to service account clients that have been delegated domain-wide authority.
get
Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection.
list
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.
patch
Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics.
update
Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias.

Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.
verify
Sends a verification email to the specified send-as alias address. The verification status must be pending.

This method is only available to service account clients that have been delegated domain-wide authority.

Send feedback about...

Need help? Visit our support page.