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

#include <smime_info.h>

Inheritance diagram for google_gmail_api::SmimeInfo:

Public Member Functions

 SmimeInfo (const Json::Value &storage)
 
 SmimeInfo (Json::Value *storage)
 
virtual ~SmimeInfo ()
 
const StringPiece GetTypeName () const
 
bool has_encrypted_key_password () const
 
void clear_encrypted_key_password ()
 
const StringPiece get_encrypted_key_password () const
 
void set_encrypted_key_password (const StringPiece &value)
 
bool has_expiration () const
 
void clear_expiration ()
 
int64 get_expiration () const
 
void set_expiration (int64 value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (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_issuer_cn () const
 
void clear_issuer_cn ()
 
const StringPiece get_issuer_cn () const
 
void set_issuer_cn (const StringPiece &value)
 
bool has_pem () const
 
void clear_pem ()
 
const StringPiece get_pem () const
 
void set_pem (const StringPiece &value)
 
bool has_pkcs12 () const
 
void clear_pkcs12 ()
 
const StringPiece get_pkcs12 () const
 
void set_pkcs12 (const StringPiece &value)
 

Static Public Member Functions

static SmimeInfoNew ()
 

Detailed Description

An S/MIME email config.

Constructor & Destructor Documentation

◆ SmimeInfo() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ SmimeInfo() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~SmimeInfo()

google_gmail_api::SmimeInfo::~SmimeInfo ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_encrypted_key_password()

void google_gmail_api::SmimeInfo::clear_encrypted_key_password ( )
inline

Clears the 'encryptedKeyPassword' attribute.

◆ clear_expiration()

void google_gmail_api::SmimeInfo::clear_expiration ( )
inline

Clears the 'expiration' attribute.

◆ clear_id()

void google_gmail_api::SmimeInfo::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_is_default()

void google_gmail_api::SmimeInfo::clear_is_default ( )
inline

Clears the 'isDefault' attribute.

◆ clear_issuer_cn()

void google_gmail_api::SmimeInfo::clear_issuer_cn ( )
inline

Clears the 'issuerCn' attribute.

◆ clear_pem()

void google_gmail_api::SmimeInfo::clear_pem ( )
inline

Clears the 'pem' attribute.

◆ clear_pkcs12()

void google_gmail_api::SmimeInfo::clear_pkcs12 ( )
inline

Clears the 'pkcs12' attribute.

◆ get_encrypted_key_password()

const StringPiece google_gmail_api::SmimeInfo::get_encrypted_key_password ( ) const
inline

Get the value of the 'encryptedKeyPassword' attribute.

◆ get_expiration()

int64 google_gmail_api::SmimeInfo::get_expiration ( ) const
inline

Get the value of the 'expiration' attribute.

◆ get_id()

const StringPiece google_gmail_api::SmimeInfo::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_is_default()

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

Get the value of the 'isDefault' attribute.

◆ get_issuer_cn()

const StringPiece google_gmail_api::SmimeInfo::get_issuer_cn ( ) const
inline

Get the value of the 'issuerCn' attribute.

◆ get_pem()

const StringPiece google_gmail_api::SmimeInfo::get_pem ( ) const
inline

Get the value of the 'pem' attribute.

◆ get_pkcs12()

const StringPiece google_gmail_api::SmimeInfo::get_pkcs12 ( ) const
inline

Get the value of the 'pkcs12' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_gmail_api::SmimeInfo

◆ has_encrypted_key_password()

bool google_gmail_api::SmimeInfo::has_encrypted_key_password ( ) const
inline

Determine if the 'encryptedKeyPassword' attribute was set.

Returns
true if the 'encryptedKeyPassword' attribute was set.

◆ has_expiration()

bool google_gmail_api::SmimeInfo::has_expiration ( ) const
inline

Determine if the 'expiration' attribute was set.

Returns
true if the 'expiration' attribute was set.

◆ has_id()

bool google_gmail_api::SmimeInfo::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_is_default()

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

Determine if the 'isDefault' attribute was set.

Returns
true if the 'isDefault' attribute was set.

◆ has_issuer_cn()

bool google_gmail_api::SmimeInfo::has_issuer_cn ( ) const
inline

Determine if the 'issuerCn' attribute was set.

Returns
true if the 'issuerCn' attribute was set.

◆ has_pem()

bool google_gmail_api::SmimeInfo::has_pem ( ) const
inline

Determine if the 'pem' attribute was set.

Returns
true if the 'pem' attribute was set.

◆ has_pkcs12()

bool google_gmail_api::SmimeInfo::has_pkcs12 ( ) const
inline

Determine if the 'pkcs12' attribute was set.

Returns
true if the 'pkcs12' attribute was set.

◆ New()

SmimeInfo * google_gmail_api::SmimeInfo::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_encrypted_key_password()

void google_gmail_api::SmimeInfo::set_encrypted_key_password ( const StringPiece &  value)
inline

Change the 'encryptedKeyPassword' attribute.

Encrypted key password, when key is encrypted.

Parameters
[in]valueThe new value.

◆ set_expiration()

void google_gmail_api::SmimeInfo::set_expiration ( int64  value)
inline

Change the 'expiration' attribute.

When the certificate expires (in milliseconds since epoch).

Parameters
[in]valueThe new value.

◆ set_id()

void google_gmail_api::SmimeInfo::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The immutable ID for the SmimeInfo.

Parameters
[in]valueThe new value.

◆ set_is_default()

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

Change the 'isDefault' attribute.

Whether this SmimeInfo is the default one for this user's send-as address.

Parameters
[in]valueThe new value.

◆ set_issuer_cn()

void google_gmail_api::SmimeInfo::set_issuer_cn ( const StringPiece &  value)
inline

Change the 'issuerCn' attribute.

The S/MIME certificate issuer's common name.

Parameters
[in]valueThe new value.

◆ set_pem()

void google_gmail_api::SmimeInfo::set_pem ( const StringPiece &  value)
inline

Change the 'pem' attribute.

PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).

Parameters
[in]valueThe new value.

◆ set_pkcs12()

void google_gmail_api::SmimeInfo::set_pkcs12 ( const StringPiece &  value)
inline

Change the 'pkcs12' attribute.

PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.

Parameters
[in]valueThe new value.

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