Google: Gmail users settings send as schemas

← Gmail users settings send as operations · All schemas

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 For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for the ListSendAs method.
sendAs	array	Optional	List of send-as aliases.
sendAs[]	Model	Each item	Expand Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body

Referenced models: Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body

Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	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. The send-as alias must be a valid email address.
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	Model	Optional	Expand Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — request body — body smtp Msa 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	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. One of: verificationStatusUnspecified, accepted, pending

Referenced models: Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — request body — body smtp Msa

Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — request body — body smtp Msa

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for communication with an SMTP service.
host	string	Optional	The hostname of the SMTP service. Required.
password	string	Optional	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.
port	integer	Optional	The port of the SMTP service. Required. Format: int32
securityMode	string	Optional	The protocol that will be used to secure communication with the SMTP service. Required. One of: securityModeUnspecified, none, ssl, starttls
username	string	Optional	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.

Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body

Field	Type	Presence	Description and constraints
$	object	Root	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. The send-as alias must be a valid email address.
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	Model	Optional	Expand Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body — smtp Msa 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	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. Known values: verificationStatusUnspecified, accepted, pending

Referenced models: Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body — smtp Msa

Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body — smtp Msa

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for communication with an SMTP service.
host	string	Optional	The hostname of the SMTP service. Required.
password	string	Optional	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.
port	JSON	Optional
port (anyOf 1)	integer	Alternative	The port of the SMTP service. Required. Format: int32
port (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
securityMode	string	Optional	The protocol that will be used to secure communication with the SMTP service. Required. Known values: securityModeUnspecified, none, ssl, starttls
username	string	Optional	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.