#include <vacation_settings.h>

Inheritance diagram for google_gmail_api::VacationSettings:

Public Member Functions
	VacationSettings (const Json::Value &storage)

	VacationSettings (Json::Value *storage)

virtual	~VacationSettings ()

const StringPiece	GetTypeName () const

bool	has_enable_auto_reply () const

void	clear_enable_auto_reply ()

bool	get_enable_auto_reply () const

void	set_enable_auto_reply (bool value)

bool	has_end_time () const

void	clear_end_time ()

int64	get_end_time () const

void	set_end_time (int64 value)

bool	has_response_body_html () const

void	clear_response_body_html ()

const StringPiece	get_response_body_html () const

void	set_response_body_html (const StringPiece &value)

bool	has_response_body_plain_text () const

void	clear_response_body_plain_text ()

const StringPiece	get_response_body_plain_text () const

void	set_response_body_plain_text (const StringPiece &value)

bool	has_response_subject () const

void	clear_response_subject ()

const StringPiece	get_response_subject () const

void	set_response_subject (const StringPiece &value)

bool	has_restrict_to_contacts () const

void	clear_restrict_to_contacts ()

bool	get_restrict_to_contacts () const

void	set_restrict_to_contacts (bool value)

bool	has_restrict_to_domain () const

void	clear_restrict_to_domain ()

bool	get_restrict_to_domain () const

void	set_restrict_to_domain (bool value)

bool	has_start_time () const

void	clear_start_time ()

int64	get_start_time () const

void	set_start_time (int64 value)

Static Public Member Functions
static VacationSettings *	New ()

Detailed Description

Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.

Constructor & Destructor Documentation

◆ VacationSettings() [1/2]

google_gmail_api::VacationSettings::VacationSettings ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ VacationSettings() [2/2]

google_gmail_api::VacationSettings::VacationSettings ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~VacationSettings()

google_gmail_api::VacationSettings::~VacationSettings ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_enable_auto_reply()

void google_gmail_api::VacationSettings::clear_enable_auto_reply ( )

inline

Clears the 'enableAutoReply' attribute.

◆ clear_end_time()

void google_gmail_api::VacationSettings::clear_end_time ( )

inline

Clears the 'endTime' attribute.

◆ clear_response_body_html()

void google_gmail_api::VacationSettings::clear_response_body_html ( )

inline

Clears the 'responseBodyHtml' attribute.

◆ clear_response_body_plain_text()

void google_gmail_api::VacationSettings::clear_response_body_plain_text ( )

inline

Clears the 'responseBodyPlainText' attribute.

◆ clear_response_subject()

void google_gmail_api::VacationSettings::clear_response_subject ( )

inline

Clears the 'responseSubject' attribute.

◆ clear_restrict_to_contacts()

void google_gmail_api::VacationSettings::clear_restrict_to_contacts ( )

inline

Clears the 'restrictToContacts' attribute.

◆ clear_restrict_to_domain()

void google_gmail_api::VacationSettings::clear_restrict_to_domain ( )

inline

Clears the 'restrictToDomain' attribute.

◆ clear_start_time()

void google_gmail_api::VacationSettings::clear_start_time ( )

inline

Clears the 'startTime' attribute.

◆ get_enable_auto_reply()

bool google_gmail_api::VacationSettings::get_enable_auto_reply ( ) const

inline

Get the value of the 'enableAutoReply' attribute.

◆ get_end_time()

int64 google_gmail_api::VacationSettings::get_end_time ( ) const

inline

Get the value of the 'endTime' attribute.

◆ get_response_body_html()

const StringPiece google_gmail_api::VacationSettings::get_response_body_html ( ) const

inline

Get the value of the 'responseBodyHtml' attribute.

◆ get_response_body_plain_text()

const StringPiece google_gmail_api::VacationSettings::get_response_body_plain_text ( ) const

inline

Get the value of the 'responseBodyPlainText' attribute.

◆ get_response_subject()

const StringPiece google_gmail_api::VacationSettings::get_response_subject ( ) const

inline

Get the value of the 'responseSubject' attribute.

◆ get_restrict_to_contacts()

bool google_gmail_api::VacationSettings::get_restrict_to_contacts ( ) const

inline

Get the value of the 'restrictToContacts' attribute.

◆ get_restrict_to_domain()

bool google_gmail_api::VacationSettings::get_restrict_to_domain ( ) const

inline

Get the value of the 'restrictToDomain' attribute.

◆ get_start_time()

int64 google_gmail_api::VacationSettings::get_start_time ( ) const

inline

Get the value of the 'startTime' attribute.

◆ GetTypeName()

const StringPiece google_gmail_api::VacationSettings::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_gmail_api::VacationSettings

◆ has_enable_auto_reply()

bool google_gmail_api::VacationSettings::has_enable_auto_reply ( ) const

inline

Determine if the 'enableAutoReply' attribute was set.

Returns: true if the 'enableAutoReply' attribute was set.

◆ has_end_time()

bool google_gmail_api::VacationSettings::has_end_time ( ) const

inline

Determine if the 'endTime' attribute was set.

Returns: true if the 'endTime' attribute was set.

◆ has_response_body_html()

bool google_gmail_api::VacationSettings::has_response_body_html ( ) const

inline

Determine if the 'responseBodyHtml' attribute was set.

Returns: true if the 'responseBodyHtml' attribute was set.

◆ has_response_body_plain_text()

bool google_gmail_api::VacationSettings::has_response_body_plain_text ( ) const

inline

Determine if the 'responseBodyPlainText' attribute was set.

Returns: true if the 'responseBodyPlainText' attribute was set.

◆ has_response_subject()

bool google_gmail_api::VacationSettings::has_response_subject ( ) const

inline

Determine if the 'responseSubject' attribute was set.

Returns: true if the 'responseSubject' attribute was set.

◆ has_restrict_to_contacts()

bool google_gmail_api::VacationSettings::has_restrict_to_contacts ( ) const

inline

Determine if the 'restrictToContacts' attribute was set.

Returns: true if the 'restrictToContacts' attribute was set.

◆ has_restrict_to_domain()

bool google_gmail_api::VacationSettings::has_restrict_to_domain ( ) const

inline

Determine if the 'restrictToDomain' attribute was set.

Returns: true if the 'restrictToDomain' attribute was set.

◆ has_start_time()

bool google_gmail_api::VacationSettings::has_start_time ( ) const

inline

Determine if the 'startTime' attribute was set.

Returns: true if the 'startTime' attribute was set.

◆ New()

VacationSettings * google_gmail_api::VacationSettings::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_enable_auto_reply()

void google_gmail_api::VacationSettings::set_enable_auto_reply ( bool value )

inline

Change the 'enableAutoReply' attribute.

Flag that controls whether Gmail automatically replies to messages.

Parameters

[in] value The new value.

◆ set_end_time()

void google_gmail_api::VacationSettings::set_end_time ( int64 value )

inline

Change the 'endTime' attribute.

An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

Parameters

[in] value The new value.

◆ set_response_body_html()

void google_gmail_api::VacationSettings::set_response_body_html ( const StringPiece & value )

inline

Change the 'responseBodyHtml' attribute.

Response body in HTML format. Gmail will sanitize the HTML before storing it.

Parameters

[in] value The new value.

◆ set_response_body_plain_text()

void google_gmail_api::VacationSettings::set_response_body_plain_text ( const StringPiece & value )

inline

Change the 'responseBodyPlainText' attribute.

Response body in plain text format.

Parameters

[in] value The new value.

◆ set_response_subject()

void google_gmail_api::VacationSettings::set_response_subject ( const StringPiece & value )

inline

Change the 'responseSubject' attribute.

Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.

Parameters

[in] value The new value.

◆ set_restrict_to_contacts()

void google_gmail_api::VacationSettings::set_restrict_to_contacts ( bool value )

inline

Change the 'restrictToContacts' attribute.

Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.

Parameters

[in] value The new value.

◆ set_restrict_to_domain()

void google_gmail_api::VacationSettings::set_restrict_to_domain ( bool value )

inline

Change the 'restrictToDomain' attribute.

Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for G Suite users.

Parameters

[in] value The new value.

◆ set_start_time()

void google_gmail_api::VacationSettings::set_start_time ( int64 value )

inline

Change the 'startTime' attribute.

An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.

Parameters

[in] value The new value.

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

google/gmail_api/vacation_settings.h
google/gmail_api/vacation_settings.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VacationSettings() [1/2]

◆ VacationSettings() [2/2]

◆ ~VacationSettings()

Member Function Documentation

◆ clear_enable_auto_reply()

◆ clear_end_time()

◆ clear_response_body_html()

◆ clear_response_body_plain_text()

◆ clear_response_subject()

◆ clear_restrict_to_contacts()

◆ clear_restrict_to_domain()

◆ clear_start_time()

◆ get_enable_auto_reply()

◆ get_end_time()

◆ get_response_body_html()

◆ get_response_body_plain_text()

◆ get_response_subject()

◆ get_restrict_to_contacts()

◆ get_restrict_to_domain()

◆ get_start_time()

◆ GetTypeName()

◆ has_enable_auto_reply()

◆ has_end_time()

◆ has_response_body_html()

◆ has_response_body_plain_text()

◆ has_response_subject()

◆ has_restrict_to_contacts()

◆ has_restrict_to_domain()

◆ has_start_time()

◆ New()

◆ set_enable_auto_reply()

◆ set_end_time()

◆ set_response_body_html()

◆ set_response_body_plain_text()

◆ set_response_subject()

◆ set_restrict_to_contacts()

◆ set_restrict_to_domain()

◆ set_start_time()