Class: Google::Apis::GmailV1::SendAs

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/gmail_v1/classes.rb,
generated/google/apis/gmail_v1/representations.rb,
generated/google/apis/gmail_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SendAs

Returns a new instance of SendAs



1159
1160
1161
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1159

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#display_name ⇒ 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. Corresponds to the JSON property displayName

Returns:

  • (String) 


1101
1102
1103
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1101

def display_name
  @display_name
end

#is_default ⇒ Boolean Also known as: is_default?

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

Returns:

  • (Boolean) 


1111
1112
1113
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1111

def is_default
  @is_default
end

#is_primary ⇒ Boolean Also known as: is_primary?

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

Returns:

  • (Boolean) 


1119
1120
1121
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1119

def is_primary
  @is_primary
end

#reply_to_address ⇒ 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. Corresponds to the JSON property replyToAddress

Returns:

  • (String) 


1127
1128
1129
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1127

def reply_to_address
  @reply_to_address
end

#send_as_email ⇒ 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. Corresponds to the JSON property sendAsEmail

Returns:

  • (String) 


1133
1134
1135
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1133

def send_as_email
  @send_as_email
end

#signature ⇒ String

An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. Corresponds to the JSON property signature

Returns:

  • (String) 


1139
1140
1141
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1139

def signature
  @signature
end

#smtp_msa ⇒ Google::Apis::GmailV1::SmtpMsa

Configuration for communication with an SMTP service. Corresponds to the JSON property smtpMsa

Returns:



1144
1145
1146
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1144

def smtp_msa
  @smtp_msa
end

#treat_as_alias ⇒ Boolean Also known as: treat_as_alias?

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

Returns:

  • (Boolean) 


1150
1151
1152
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1150

def treat_as_alias
  @treat_as_alias
end

#verification_status ⇒ 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. Corresponds to the JSON property verificationStatus

Returns:

  • (String) 


1157
1158
1159
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1157

def verification_status
  @verification_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1164

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