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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gmail_v1/classes.rb,
lib/google/apis/gmail_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ SendAs

Returns a new instance of SendAs.



1311
1312
1313
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1311

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. 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

Returns:

  • (String) 


1253
1254
1255
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1253

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) 


1263
1264
1265
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1263

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) 


1271
1272
1273
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1271

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) 


1279
1280
1281
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1279

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) 


1285
1286
1287
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1285

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. This signature is added to new emails only. Corresponds to the JSON property signature

Returns:

  • (String) 


1291
1292
1293
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1291

def signature
  @signature
end

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

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

Returns:



1296
1297
1298
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1296

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) 


1302
1303
1304
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1302

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) 


1309
1310
1311
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1309

def verification_status
  @verification_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 1316

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