Packages
Gmail API client library. The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.
Current section
Files
Jump to
Current section
Files
lib/google_api/gmail/v1/model/send_as.ex
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.Gmail.V1.Model.SendAs do
@moduledoc """
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
<a href="https://support.google.com/mail/answer/22370">"Send Mail As"</a>
feature in the web interface.
## Attributes
* `displayName` (*type:* `String.t`, *default:* `nil`) - 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.
* `isDefault` (*type:* `boolean()`, *default:* `nil`) - 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
<code>true</code>. Changing this from <code>false</code> to
<code>true</code> for an address will result in this field becoming
<code>false</code> for the other previous default address.
* `isPrimary` (*type:* `boolean()`, *default:* `nil`) - 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.
* `replyToAddress` (*type:* `String.t`, *default:* `nil`) - 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.
* `sendAsEmail` (*type:* `String.t`, *default:* `nil`) - The email address that appears in the "From:" header for mail sent using
this alias. This is read-only for all operations except create.
* `signature` (*type:* `String.t`, *default:* `nil`) - An optional HTML signature that is included in messages composed with this
alias in the Gmail web UI.
* `smtpMsa` (*type:* `GoogleApi.Gmail.V1.Model.SmtpMsa.t`, *default:* `nil`) - An optional SMTP service that will be used as an outbound relay for mail
sent using this alias. If this is empty, outbound mail will be sent
directly from Gmail's servers to the destination SMTP service. This
setting only applies to custom "from" aliases.
* `treatAsAlias` (*type:* `boolean()`, *default:* `nil`) - Whether Gmail should <a href="https://support.google.com/a/answer/1710338">
treat this address as an alias</a> for the user's primary email address.
This setting only applies to custom "from" aliases.
* `verificationStatus` (*type:* `String.t`, *default:* `nil`) - Indicates whether this address has been verified for use as a send-as
alias. Read-only. This setting only applies to custom "from" aliases.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:displayName => String.t(),
:isDefault => boolean(),
:isPrimary => boolean(),
:replyToAddress => String.t(),
:sendAsEmail => String.t(),
:signature => String.t(),
:smtpMsa => GoogleApi.Gmail.V1.Model.SmtpMsa.t(),
:treatAsAlias => boolean(),
:verificationStatus => String.t()
}
field(:displayName)
field(:isDefault)
field(:isPrimary)
field(:replyToAddress)
field(:sendAsEmail)
field(:signature)
field(:smtpMsa, as: GoogleApi.Gmail.V1.Model.SmtpMsa)
field(:treatAsAlias)
field(:verificationStatus)
end
defimpl Poison.Decoder, for: GoogleApi.Gmail.V1.Model.SendAs do
def decode(value, options) do
GoogleApi.Gmail.V1.Model.SendAs.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Gmail.V1.Model.SendAs do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end