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.
Table Specific Information
Query 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.
Select
The driver uses the GMail REST API to process search criteria that refer to the SendAsEmail columns. The driver processes other filters client-side within the driver.
- SendAsEmail supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM SendAs WHERE SendAsEmail = '[email protected]'
INSERT/UPDATE/DELETE operations are restricted.
These operations are only available to service account clients that have been delegated domain-wide authority.
Columns
| Name | Type | ReadOnly | References | Description |
| SendAsEmail [KEY] | String | False |
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 | False |
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 | False |
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 | False |
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. | |
| IsPrimary | Bool | False |
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 | Bool | False |
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 | Bool | False |
Whether Gmail should treat this address as an alias for the users primary email address. This setting only applies to custom from aliases. | |
| SmtpMsaHost | String | False |
The hostname of the SMTP service. Required. | |
| SmtpMsaPort | Integer | False |
The port of the SMTP service. Required. | |
| SmtpMsaUsername | String | False |
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. | |
| SmtpMsaPassword | String | False |
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. | |
| SmtpMsaSecurityMode | String | False |
The protocol that will be used to secure communication with the SMTP service. Required. | |
| VerificationStatus | String | False |
Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom from aliases. |