com.google.api.services.gmail.model

Class SendAs

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.SendAs

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SendAs
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SendAs()

Method Summary

Modifier and Type	Method and Description
SendAs	clone()
String	getDisplayName() A name that appears in the "From:" header for mail sent using this alias.
Boolean	getIsDefault() Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply.
Boolean	getIsPrimary() Whether this address is the primary address used to login to the account.
String	getReplyToAddress() An optional email address that is included in a "Reply-To:" header for mail sent using this alias.
String	getSendAsEmail() The email address that appears in the "From:" header for mail sent using this alias.
String	getSignature() An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
SmtpMsa	getSmtpMsa() An optional SMTP service that will be used as an outbound relay for mail sent using this alias.
Boolean	getTreatAsAlias() Whether Gmail should treat this address as an alias for the user's primary email address.
String	getVerificationStatus() Indicates whether this address has been verified for use as a send-as alias.
SendAs	set(String fieldName, Object value)
SendAs	setDisplayName(String displayName) A name that appears in the "From:" header for mail sent using this alias.
SendAs	setIsDefault(Boolean isDefault) Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply.
SendAs	setIsPrimary(Boolean isPrimary) Whether this address is the primary address used to login to the account.
SendAs	setReplyToAddress(String replyToAddress) An optional email address that is included in a "Reply-To:" header for mail sent using this alias.
SendAs	setSendAsEmail(String sendAsEmail) The email address that appears in the "From:" header for mail sent using this alias.
SendAs	setSignature(String signature) An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
SendAs	setSmtpMsa(SmtpMsa smtpMsa) An optional SMTP service that will be used as an outbound relay for mail sent using this alias.
SendAs	setTreatAsAlias(Boolean treatAsAlias) Whether Gmail should treat this address as an alias for the user's primary email address.
SendAs	setVerificationStatus(String verificationStatus) Indicates whether this address has been verified for use as a send-as alias.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SendAs

public SendAs()

Method Detail

getDisplayName

public String getDisplayName()

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.

Returns:

value or null for none

setDisplayName

public SendAs setDisplayName(String displayName)

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.

Parameters:

displayName - displayName or null for none

getIsDefault

public Boolean getIsDefault()

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.

Returns:

value or null for none

setIsDefault

public SendAs setIsDefault(Boolean isDefault)

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.

Parameters:

isDefault - isDefault or null for none

getIsPrimary

public Boolean getIsPrimary()

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.

Returns:

value or null for none

setIsPrimary

public SendAs setIsPrimary(Boolean isPrimary)

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.

Parameters:

isPrimary - isPrimary or null for none

getReplyToAddress

public String getReplyToAddress()

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.

Returns:

value or null for none

setReplyToAddress

public SendAs setReplyToAddress(String replyToAddress)

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.

Parameters:

replyToAddress - replyToAddress or null for none

getSendAsEmail

public String getSendAsEmail()

The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.

Returns:

value or null for none

setSendAsEmail

public SendAs setSendAsEmail(String sendAsEmail)

The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.

Parameters:

sendAsEmail - sendAsEmail or null for none

getSignature

public String getSignature()

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.

Returns:

value or null for none

setSignature

public SendAs setSignature(String signature)

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.

Parameters:

signature - signature or null for none

getSmtpMsa

public SmtpMsa getSmtpMsa()

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.

Returns:

value or null for none

setSmtpMsa

public SendAs setSmtpMsa(SmtpMsa smtpMsa)

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.

Parameters:

smtpMsa - smtpMsa or null for none

getTreatAsAlias

public Boolean getTreatAsAlias()

Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.

Returns:

value or null for none

setTreatAsAlias

public SendAs setTreatAsAlias(Boolean treatAsAlias)

Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.

Parameters:

treatAsAlias - treatAsAlias or null for none

getVerificationStatus

public String getVerificationStatus()

Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.

Returns:

value or null for none

setVerificationStatus

public SendAs setVerificationStatus(String verificationStatus)

Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.

Parameters:

verificationStatus - verificationStatus or null for none

set

public SendAs set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SendAs clone()

Overrides:

clone in class com.google.api.client.json.GenericJson