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
1212 1213 1214 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1212 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
1154 1155 1156 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1154 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
1164 1165 1166 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1164 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
1172 1173 1174 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1172 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
1180 1181 1182 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1180 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
1186 1187 1188 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1186 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
1192 1193 1194 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1192 def signature @signature end |
#smtp_msa ⇒ Google::Apis::GmailV1::SmtpMsa
Configuration for communication with an SMTP service.
Corresponds to the JSON property smtpMsa
1197 1198 1199 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1197 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
1203 1204 1205 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1203 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
1210 1211 1212 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1210 def verification_status @verification_status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 |
# File 'generated/google/apis/gmail_v1/classes.rb', line 1217 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 |