gmail  v1
Public Member Functions | Static Public Member Functions | List of all members
google_gmail_api::SendAs Class Reference

#include <send_as.h>

Inheritance diagram for google_gmail_api::SendAs:

Public Member Functions

 SendAs (const Json::Value &storage)
 
 SendAs (Json::Value *storage)
 
virtual ~SendAs ()
 
const StringPiece GetTypeName () const
 
bool has_display_name () const
 
void clear_display_name ()
 
const StringPiece get_display_name () const
 
void set_display_name (const StringPiece &value)
 
bool has_is_default () const
 
void clear_is_default ()
 
bool get_is_default () const
 
void set_is_default (bool value)
 
bool has_is_primary () const
 
void clear_is_primary ()
 
bool get_is_primary () const
 
void set_is_primary (bool value)
 
bool has_reply_to_address () const
 
void clear_reply_to_address ()
 
const StringPiece get_reply_to_address () const
 
void set_reply_to_address (const StringPiece &value)
 
bool has_send_as_email () const
 
void clear_send_as_email ()
 
const StringPiece get_send_as_email () const
 
void set_send_as_email (const StringPiece &value)
 
bool has_signature () const
 
void clear_signature ()
 
const StringPiece get_signature () const
 
void set_signature (const StringPiece &value)
 
bool has_smtp_msa () const
 
void clear_smtp_msa ()
 
const SmtpMsa get_smtp_msa () const
 
SmtpMsa mutable_smtpMsa ()
 
bool has_treat_as_alias () const
 
void clear_treat_as_alias ()
 
bool get_treat_as_alias () const
 
void set_treat_as_alias (bool value)
 
bool has_verification_status () const
 
void clear_verification_status ()
 
const StringPiece get_verification_status () const
 
void set_verification_status (const StringPiece &value)
 

Static Public Member Functions

static SendAsNew ()
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ SendAs() [1/2]

google_gmail_api::SendAs::SendAs ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ SendAs() [2/2]

google_gmail_api::SendAs::SendAs ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~SendAs()

google_gmail_api::SendAs::~SendAs ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_display_name()

void google_gmail_api::SendAs::clear_display_name ( )
inline

Clears the 'displayName' attribute.

◆ clear_is_default()

void google_gmail_api::SendAs::clear_is_default ( )
inline

Clears the 'isDefault' attribute.

◆ clear_is_primary()

void google_gmail_api::SendAs::clear_is_primary ( )
inline

Clears the 'isPrimary' attribute.

◆ clear_reply_to_address()

void google_gmail_api::SendAs::clear_reply_to_address ( )
inline

Clears the 'replyToAddress' attribute.

◆ clear_send_as_email()

void google_gmail_api::SendAs::clear_send_as_email ( )
inline

Clears the 'sendAsEmail' attribute.

◆ clear_signature()

void google_gmail_api::SendAs::clear_signature ( )
inline

Clears the 'signature' attribute.

◆ clear_smtp_msa()

void google_gmail_api::SendAs::clear_smtp_msa ( )
inline

Clears the 'smtpMsa' attribute.

◆ clear_treat_as_alias()

void google_gmail_api::SendAs::clear_treat_as_alias ( )
inline

Clears the 'treatAsAlias' attribute.

◆ clear_verification_status()

void google_gmail_api::SendAs::clear_verification_status ( )
inline

Clears the 'verificationStatus' attribute.

◆ get_display_name()

const StringPiece google_gmail_api::SendAs::get_display_name ( ) const
inline

Get the value of the 'displayName' attribute.

◆ get_is_default()

bool google_gmail_api::SendAs::get_is_default ( ) const
inline

Get the value of the 'isDefault' attribute.

◆ get_is_primary()

bool google_gmail_api::SendAs::get_is_primary ( ) const
inline

Get the value of the 'isPrimary' attribute.

◆ get_reply_to_address()

const StringPiece google_gmail_api::SendAs::get_reply_to_address ( ) const
inline

Get the value of the 'replyToAddress' attribute.

◆ get_send_as_email()

const StringPiece google_gmail_api::SendAs::get_send_as_email ( ) const
inline

Get the value of the 'sendAsEmail' attribute.

◆ get_signature()

const StringPiece google_gmail_api::SendAs::get_signature ( ) const
inline

Get the value of the 'signature' attribute.

◆ get_smtp_msa()

const SmtpMsa google_gmail_api::SendAs::get_smtp_msa ( ) const

Get a reference to the value of the 'smtpMsa' attribute.

◆ get_treat_as_alias()

bool google_gmail_api::SendAs::get_treat_as_alias ( ) const
inline

Get the value of the 'treatAsAlias' attribute.

◆ get_verification_status()

const StringPiece google_gmail_api::SendAs::get_verification_status ( ) const
inline

Get the value of the 'verificationStatus' attribute.

◆ GetTypeName()

const StringPiece google_gmail_api::SendAs::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_gmail_api::SendAs

◆ has_display_name()

bool google_gmail_api::SendAs::has_display_name ( ) const
inline

Determine if the 'displayName' attribute was set.

Returns
true if the 'displayName' attribute was set.

◆ has_is_default()

bool google_gmail_api::SendAs::has_is_default ( ) const
inline

Determine if the 'isDefault' attribute was set.

Returns
true if the 'isDefault' attribute was set.

◆ has_is_primary()

bool google_gmail_api::SendAs::has_is_primary ( ) const
inline

Determine if the 'isPrimary' attribute was set.

Returns
true if the 'isPrimary' attribute was set.

◆ has_reply_to_address()

bool google_gmail_api::SendAs::has_reply_to_address ( ) const
inline

Determine if the 'replyToAddress' attribute was set.

Returns
true if the 'replyToAddress' attribute was set.

◆ has_send_as_email()

bool google_gmail_api::SendAs::has_send_as_email ( ) const
inline

Determine if the 'sendAsEmail' attribute was set.

Returns
true if the 'sendAsEmail' attribute was set.

◆ has_signature()

bool google_gmail_api::SendAs::has_signature ( ) const
inline

Determine if the 'signature' attribute was set.

Returns
true if the 'signature' attribute was set.

◆ has_smtp_msa()

bool google_gmail_api::SendAs::has_smtp_msa ( ) const
inline

Determine if the 'smtpMsa' attribute was set.

Returns
true if the 'smtpMsa' attribute was set.

◆ has_treat_as_alias()

bool google_gmail_api::SendAs::has_treat_as_alias ( ) const
inline

Determine if the 'treatAsAlias' attribute was set.

Returns
true if the 'treatAsAlias' attribute was set.

◆ has_verification_status()

bool google_gmail_api::SendAs::has_verification_status ( ) const
inline

Determine if the 'verificationStatus' attribute was set.

Returns
true if the 'verificationStatus' attribute was set.

◆ mutable_smtpMsa()

SmtpMsa google_gmail_api::SendAs::mutable_smtpMsa ( )

Gets a reference to a mutable value of the 'smtpMsa' property.

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
The result can be modified to change the attribute value.

◆ New()

SendAs * google_gmail_api::SendAs::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_display_name()

void google_gmail_api::SendAs::set_display_name ( const StringPiece &  value)
inline

Change the 'displayName' attribute.

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
[in]valueThe new value.

◆ set_is_default()

void google_gmail_api::SendAs::set_is_default ( bool  value)
inline

Change the 'isDefault' attribute.

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
[in]valueThe new value.

◆ set_is_primary()

void google_gmail_api::SendAs::set_is_primary ( bool  value)
inline

Change the 'isPrimary' attribute.

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
[in]valueThe new value.

◆ set_reply_to_address()

void google_gmail_api::SendAs::set_reply_to_address ( const StringPiece &  value)
inline

Change the 'replyToAddress' attribute.

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
[in]valueThe new value.

◆ set_send_as_email()

void google_gmail_api::SendAs::set_send_as_email ( const StringPiece &  value)
inline

Change the 'sendAsEmail' attribute.

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
[in]valueThe new value.

◆ set_signature()

void google_gmail_api::SendAs::set_signature ( const StringPiece &  value)
inline

Change the 'signature' attribute.

An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.

Parameters
[in]valueThe new value.

◆ set_treat_as_alias()

void google_gmail_api::SendAs::set_treat_as_alias ( bool  value)
inline

Change the 'treatAsAlias' attribute.

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
[in]valueThe new value.

◆ set_verification_status()

void google_gmail_api::SendAs::set_verification_status ( const StringPiece &  value)
inline

Change the 'verificationStatus' attribute.

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
[in]valueThe new value.

The documentation for this class was generated from the following files: