class Google::Apis::GmailV1::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.

Attributes

display_name[RW]

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. Corresponds to the JSON property `displayName` @return [String]

is_default[RW]

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. Corresponds to the JSON property `isDefault` @return [Boolean]

is_default?[RW]

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. Corresponds to the JSON property `isDefault` @return [Boolean]

is_primary[RW]

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. Corresponds to the JSON property `isPrimary` @return [Boolean]

is_primary?[RW]

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. Corresponds to the JSON property `isPrimary` @return [Boolean]

reply_to_address[RW]

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. Corresponds to the JSON property `replyToAddress` @return [String]

send_as_email[RW]

The email address that appears in the “From:” header for mail sent using this alias. This is read-only for all operations except create. Corresponds to the JSON property `sendAsEmail` @return [String]

signature[RW]

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. Corresponds to the JSON property `signature` @return [String]

smtp_msa[RW]

Configuration for communication with an SMTP service. Corresponds to the JSON property `smtpMsa` @return [Google::Apis::GmailV1::SmtpMsa]

treat_as_alias[RW]

Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom “from” aliases. Corresponds to the JSON property `treatAsAlias` @return [Boolean]

treat_as_alias?[RW]

Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom “from” aliases. Corresponds to the JSON property `treatAsAlias` @return [Boolean]

verification_status[RW]

Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom “from” aliases. Corresponds to the JSON property `verificationStatus` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/gmail_v1/classes.rb, line 1307
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/gmail_v1/classes.rb, line 1312
def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @is_default = args[:is_default] if args.key?(:is_default)
  @is_primary = args[:is_primary] if args.key?(:is_primary)
  @reply_to_address = args[:reply_to_address] if args.key?(:reply_to_address)
  @send_as_email = args[:send_as_email] if args.key?(:send_as_email)
  @signature = args[:signature] if args.key?(:signature)
  @smtp_msa = args[:smtp_msa] if args.key?(:smtp_msa)
  @treat_as_alias = args[:treat_as_alias] if args.key?(:treat_as_alias)
  @verification_status = args[:verification_status] if args.key?(:verification_status)
end