gmail  v1
Public Member Functions | Static Public Member Functions | List of all members
google_gmail_api::ImapSettings Class Reference
Gmail API Data Objects

#include <imap_settings.h>

Inheritance diagram for google_gmail_api::ImapSettings:

Public Member Functions

 ImapSettings (const Json::Value &storage)
 
 ImapSettings (Json::Value *storage)
 
virtual ~ImapSettings ()
 
const StringPiece GetTypeName () const
 
bool has_auto_expunge () const
 
void clear_auto_expunge ()
 
bool get_auto_expunge () const
 
void set_auto_expunge (bool value)
 
bool has_enabled () const
 
void clear_enabled ()
 
bool get_enabled () const
 
void set_enabled (bool value)
 
bool has_expunge_behavior () const
 
void clear_expunge_behavior ()
 
const StringPiece get_expunge_behavior () const
 
void set_expunge_behavior (const StringPiece &value)
 
bool has_max_folder_size () const
 
void clear_max_folder_size ()
 
int32 get_max_folder_size () const
 
void set_max_folder_size (int32 value)
 

Static Public Member Functions

static ImapSettings * New ()
 

Detailed Description

IMAP settings for an account.

Constructor & Destructor Documentation

◆ ImapSettings() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ ImapSettings() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~ImapSettings()

google_gmail_api::ImapSettings::~ImapSettings ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_expunge()

void google_gmail_api::ImapSettings::clear_auto_expunge ( )
inline

Clears the 'autoExpunge' attribute.

◆ clear_enabled()

void google_gmail_api::ImapSettings::clear_enabled ( )
inline

Clears the 'enabled' attribute.

◆ clear_expunge_behavior()

void google_gmail_api::ImapSettings::clear_expunge_behavior ( )
inline

Clears the 'expungeBehavior' attribute.

◆ clear_max_folder_size()

void google_gmail_api::ImapSettings::clear_max_folder_size ( )
inline

Clears the 'maxFolderSize' attribute.

◆ get_auto_expunge()

bool google_gmail_api::ImapSettings::get_auto_expunge ( ) const
inline

Get the value of the 'autoExpunge' attribute.

◆ get_enabled()

bool google_gmail_api::ImapSettings::get_enabled ( ) const
inline

Get the value of the 'enabled' attribute.

◆ get_expunge_behavior()

const StringPiece google_gmail_api::ImapSettings::get_expunge_behavior ( ) const
inline

Get the value of the 'expungeBehavior' attribute.

◆ get_max_folder_size()

int32 google_gmail_api::ImapSettings::get_max_folder_size ( ) const
inline

Get the value of the 'maxFolderSize' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_gmail_api::ImapSettings

◆ has_auto_expunge()

bool google_gmail_api::ImapSettings::has_auto_expunge ( ) const
inline

Determine if the 'autoExpunge' attribute was set.

Returns
true if the 'autoExpunge' attribute was set.

◆ has_enabled()

bool google_gmail_api::ImapSettings::has_enabled ( ) const
inline

Determine if the 'enabled' attribute was set.

Returns
true if the 'enabled' attribute was set.

◆ has_expunge_behavior()

bool google_gmail_api::ImapSettings::has_expunge_behavior ( ) const
inline

Determine if the 'expungeBehavior' attribute was set.

Returns
true if the 'expungeBehavior' attribute was set.

◆ has_max_folder_size()

bool google_gmail_api::ImapSettings::has_max_folder_size ( ) const
inline

Determine if the 'maxFolderSize' attribute was set.

Returns
true if the 'maxFolderSize' attribute was set.

◆ New()

ImapSettings * google_gmail_api::ImapSettings::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_auto_expunge()

void google_gmail_api::ImapSettings::set_auto_expunge ( bool  value)
inline

Change the 'autoExpunge' attribute.

If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.

Parameters
[in]valueThe new value.

◆ set_enabled()

void google_gmail_api::ImapSettings::set_enabled ( bool  value)
inline

Change the 'enabled' attribute.

Whether IMAP is enabled for the account.

Parameters
[in]valueThe new value.

◆ set_expunge_behavior()

void google_gmail_api::ImapSettings::set_expunge_behavior ( const StringPiece &  value)
inline

Change the 'expungeBehavior' attribute.

The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.

Parameters
[in]valueThe new value.

◆ set_max_folder_size()

void google_gmail_api::ImapSettings::set_max_folder_size ( int32  value)
inline

Change the 'maxFolderSize' attribute.

An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: