Class: Google::Apis::GmailV1::SendAs
- Inherits:
-
Object
- Object
- Google::Apis::GmailV1::SendAs
- 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
-
#display_name ⇒ String
A name that appears in the "From:" header for mail sent using this alias.
-
#is_default ⇒ Boolean
(also: #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.
-
#is_primary ⇒ Boolean
(also: #is_primary?)
Whether this address is the primary address used to login to the account.
-
#reply_to_address ⇒ String
An optional email address that is included in a "Reply-To:" header for mail sent using this alias.
-
#send_as_email ⇒ String
The email address that appears in the "From:" header for mail sent using this alias.
-
#signature ⇒ String
An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
-
#smtp_msa ⇒ Google::Apis::GmailV1::SmtpMsa
Configuration for communication with an SMTP service.
-
#treat_as_alias ⇒ Boolean
(also: #treat_as_alias?)
Whether Gmail should treat this address as an alias for the user's primary email address.
-
#verification_status ⇒ String
Indicates whether this address has been verified for use as a send-as alias.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SendAs
constructor
A new instance of SendAs.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SendAs
Returns a new instance of SendAs.
1304 1305 1306 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1304 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
1246 1247 1248 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1246 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
1256 1257 1258 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1256 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
1264 1265 1266 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1264 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
1272 1273 1274 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1272 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
1278 1279 1280 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1278 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
1284 1285 1286 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1284 def signature @signature end |
#smtp_msa ⇒ Google::Apis::GmailV1::SmtpMsa
Configuration for communication with an SMTP service.
Corresponds to the JSON property smtpMsa
1289 1290 1291 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1289 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
1295 1296 1297 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1295 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
1302 1303 1304 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1302 def verification_status @verification_status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1309 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 |