#include <message.h>

Inheritance diagram for google_gmail_api::Message:

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

	Message (Json::Value *storage)

virtual	~Message ()

const StringPiece	GetTypeName () const

bool	has_history_id () const

void	clear_history_id ()

uint64	get_history_id () const

void	set_history_id (uint64 value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_internal_date () const

void	clear_internal_date ()

int64	get_internal_date () const

void	set_internal_date (int64 value)

bool	has_label_ids () const

void	clear_label_ids ()

const client::JsonCppArray< string >	get_label_ids () const

client::JsonCppArray< string >	mutable_labelIds ()

bool	has_payload () const

void	clear_payload ()

const MessagePart	get_payload () const

MessagePart	mutable_payload ()

bool	has_raw () const

void	clear_raw ()

const StringPiece	get_raw () const

void	set_raw (const StringPiece &value)

bool	has_size_estimate () const

void	clear_size_estimate ()

int32	get_size_estimate () const

void	set_size_estimate (int32 value)

bool	has_snippet () const

void	clear_snippet ()

const StringPiece	get_snippet () const

void	set_snippet (const StringPiece &value)

bool	has_thread_id () const

void	clear_thread_id ()

const StringPiece	get_thread_id () const

void	set_thread_id (const StringPiece &value)

Static Public Member Functions
static Message *	New ()

Detailed Description

An email message.

Constructor & Destructor Documentation

◆ Message() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Message() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Message()

google_gmail_api::Message::~Message ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_history_id()

void google_gmail_api::Message::clear_history_id ( )

inline

Clears the 'historyId' attribute.

◆ clear_id()

void google_gmail_api::Message::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_internal_date()

void google_gmail_api::Message::clear_internal_date ( )

inline

Clears the 'internalDate' attribute.

◆ clear_label_ids()

void google_gmail_api::Message::clear_label_ids ( )

inline

Clears the 'labelIds' attribute.

◆ clear_payload()

void google_gmail_api::Message::clear_payload ( )

inline

Clears the 'payload' attribute.

◆ clear_raw()

void google_gmail_api::Message::clear_raw ( )

inline

Clears the 'raw' attribute.

◆ clear_size_estimate()

void google_gmail_api::Message::clear_size_estimate ( )

inline

Clears the 'sizeEstimate' attribute.

◆ clear_snippet()

void google_gmail_api::Message::clear_snippet ( )

inline

Clears the 'snippet' attribute.

◆ clear_thread_id()

void google_gmail_api::Message::clear_thread_id ( )

inline

Clears the 'threadId' attribute.

◆ get_history_id()

uint64 google_gmail_api::Message::get_history_id ( ) const

inline

Get the value of the 'historyId' attribute.

◆ get_id()

const StringPiece google_gmail_api::Message::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_internal_date()

int64 google_gmail_api::Message::get_internal_date ( ) const

inline

Get the value of the 'internalDate' attribute.

◆ get_label_ids()

const client::JsonCppArray<string > google_gmail_api::Message::get_label_ids ( ) const

inline

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

◆ get_payload()

const MessagePart google_gmail_api::Message::get_payload ( ) const

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

◆ get_raw()

const StringPiece google_gmail_api::Message::get_raw ( ) const

inline

Get the value of the 'raw' attribute.

◆ get_size_estimate()

int32 google_gmail_api::Message::get_size_estimate ( ) const

inline

Get the value of the 'sizeEstimate' attribute.

◆ get_snippet()

const StringPiece google_gmail_api::Message::get_snippet ( ) const

inline

Get the value of the 'snippet' attribute.

◆ get_thread_id()

const StringPiece google_gmail_api::Message::get_thread_id ( ) const

inline

Get the value of the 'threadId' attribute.

◆ GetTypeName()

const StringPiece google_gmail_api::Message::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_gmail_api::Message

◆ has_history_id()

bool google_gmail_api::Message::has_history_id ( ) const

inline

Determine if the 'historyId' attribute was set.

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

◆ has_id()

bool google_gmail_api::Message::has_id ( ) const

inline

Determine if the 'id' attribute was set.

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

◆ has_internal_date()

bool google_gmail_api::Message::has_internal_date ( ) const

inline

Determine if the 'internalDate' attribute was set.

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

◆ has_label_ids()

bool google_gmail_api::Message::has_label_ids ( ) const

inline

Determine if the 'labelIds' attribute was set.

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

◆ has_payload()

bool google_gmail_api::Message::has_payload ( ) const

inline

Determine if the 'payload' attribute was set.

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

◆ has_raw()

bool google_gmail_api::Message::has_raw ( ) const

inline

Determine if the 'raw' attribute was set.

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

◆ has_size_estimate()

bool google_gmail_api::Message::has_size_estimate ( ) const

inline

Determine if the 'sizeEstimate' attribute was set.

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

◆ has_snippet()

bool google_gmail_api::Message::has_snippet ( ) const

inline

Determine if the 'snippet' attribute was set.

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

◆ has_thread_id()

bool google_gmail_api::Message::has_thread_id ( ) const

inline

Determine if the 'threadId' attribute was set.

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

◆ mutable_labelIds()

client::JsonCppArray<string > google_gmail_api::Message::mutable_labelIds ( )

inline

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

List of IDs of labels applied to this message.

Returns: The result can be modified to change the attribute value.

◆ mutable_payload()

MessagePart google_gmail_api::Message::mutable_payload ( )

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

The parsed email structure in the message parts.

Returns: The result can be modified to change the attribute value.

◆ New()

Message * google_gmail_api::Message::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_history_id()

void google_gmail_api::Message::set_history_id ( uint64 value )

inline

Change the 'historyId' attribute.

The ID of the last history record that modified this message.

Parameters

[in] value The new value.

◆ set_id()

void google_gmail_api::Message::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

The immutable ID of the message.

Parameters

[in] value The new value.

◆ set_internal_date()

void google_gmail_api::Message::set_internal_date ( int64 value )

inline

Change the 'internalDate' attribute.

The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.

Parameters

[in] value The new value.

◆ set_raw()

void google_gmail_api::Message::set_raw ( const StringPiece & value )

inline

Change the 'raw' attribute.

The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.

Parameters

[in] value The new value.

◆ set_size_estimate()

void google_gmail_api::Message::set_size_estimate ( int32 value )

inline

Change the 'sizeEstimate' attribute.

Estimated size in bytes of the message.

Parameters

[in] value The new value.

◆ set_snippet()

void google_gmail_api::Message::set_snippet ( const StringPiece & value )

inline

Change the 'snippet' attribute.

A short part of the message text.

Parameters

[in] value The new value.

◆ set_thread_id()

void google_gmail_api::Message::set_thread_id ( const StringPiece & value )

inline

Change the 'threadId' attribute.

The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met:

The requested threadId must be specified on the Message or Draft.Message you supply with your request.
The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard.
The Subject headers must match.

Parameters

[in] value The new value.

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

google/gmail_api/message.h
google/gmail_api/message.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Message() [1/2]

◆ Message() [2/2]

◆ ~Message()

Member Function Documentation

◆ clear_history_id()

◆ clear_id()

◆ clear_internal_date()

◆ clear_label_ids()

◆ clear_payload()

◆ clear_raw()

◆ clear_size_estimate()

◆ clear_snippet()

◆ clear_thread_id()

◆ get_history_id()

◆ get_id()

◆ get_internal_date()

◆ get_label_ids()

◆ get_payload()

◆ get_raw()

◆ get_size_estimate()

◆ get_snippet()

◆ get_thread_id()

◆ GetTypeName()

◆ has_history_id()

◆ has_id()

◆ has_internal_date()

◆ has_label_ids()

◆ has_payload()

◆ has_raw()

◆ has_size_estimate()

◆ has_snippet()

◆ has_thread_id()

◆ mutable_labelIds()

◆ mutable_payload()

◆ New()

◆ set_history_id()

◆ set_id()

◆ set_internal_date()

◆ set_raw()

◆ set_size_estimate()

◆ set_snippet()

◆ set_thread_id()