/gmail/v1/users/{userId}/settings/sendAs
POST/gmail/v1/users/{userId}/settings/sendAsCreates 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.
Request
User's email address. The special value "me" can be used to indicate the authenticated user.
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.
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.
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.
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.
The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
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.
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.
The hostname of the SMTP service. Required.
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.
The port of the SMTP service. Required.
The protocol that will be used to secure communication with the SMTP service. Required.
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.
Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
{
"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 samples
Responses
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.
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.
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.
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.
The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
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.
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.
The hostname of the SMTP service. Required.
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.
The port of the SMTP service. Required.
The protocol that will be used to secure communication with the SMTP service. Required.
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.
Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
{
"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"
}