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

#include <message_part.h>

Inheritance diagram for google_gmail_api::MessagePart:

Public Member Functions

 MessagePart (const Json::Value &storage)
 
 MessagePart (Json::Value *storage)
 
virtual ~MessagePart ()
 
const StringPiece GetTypeName () const
 
bool has_body () const
 
void clear_body ()
 
const MessagePartBody get_body () const
 
MessagePartBody mutable_body ()
 
bool has_filename () const
 
void clear_filename ()
 
const StringPiece get_filename () const
 
void set_filename (const StringPiece &value)
 
bool has_headers () const
 
void clear_headers ()
 
const client::JsonCppArray< MessagePartHeaderget_headers () const
 
client::JsonCppArray< MessagePartHeadermutable_headers ()
 
bool has_mime_type () const
 
void clear_mime_type ()
 
const StringPiece get_mime_type () const
 
void set_mime_type (const StringPiece &value)
 
bool has_part_id () const
 
void clear_part_id ()
 
const StringPiece get_part_id () const
 
void set_part_id (const StringPiece &value)
 
bool has_parts () const
 
void clear_parts ()
 
const client::JsonCppArray< MessagePartget_parts () const
 
client::JsonCppArray< MessagePartmutable_parts ()
 

Static Public Member Functions

static MessagePartNew ()
 

Detailed Description

A single MIME message part.

Constructor & Destructor Documentation

◆ MessagePart() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ MessagePart() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~MessagePart()

google_gmail_api::MessagePart::~MessagePart ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_body()

void google_gmail_api::MessagePart::clear_body ( )
inline

Clears the 'body' attribute.

◆ clear_filename()

void google_gmail_api::MessagePart::clear_filename ( )
inline

Clears the 'filename' attribute.

◆ clear_headers()

void google_gmail_api::MessagePart::clear_headers ( )
inline

Clears the 'headers' attribute.

◆ clear_mime_type()

void google_gmail_api::MessagePart::clear_mime_type ( )
inline

Clears the 'mimeType' attribute.

◆ clear_part_id()

void google_gmail_api::MessagePart::clear_part_id ( )
inline

Clears the 'partId' attribute.

◆ clear_parts()

void google_gmail_api::MessagePart::clear_parts ( )
inline

Clears the 'parts' attribute.

◆ get_body()

const MessagePartBody google_gmail_api::MessagePart::get_body ( ) const

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

◆ get_filename()

const StringPiece google_gmail_api::MessagePart::get_filename ( ) const
inline

Get the value of the 'filename' attribute.

◆ get_headers()

const client::JsonCppArray<MessagePartHeader > google_gmail_api::MessagePart::get_headers ( ) const

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

◆ get_mime_type()

const StringPiece google_gmail_api::MessagePart::get_mime_type ( ) const
inline

Get the value of the 'mimeType' attribute.

◆ get_part_id()

const StringPiece google_gmail_api::MessagePart::get_part_id ( ) const
inline

Get the value of the 'partId' attribute.

◆ get_parts()

const client::JsonCppArray<MessagePart > google_gmail_api::MessagePart::get_parts ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_gmail_api::MessagePart

◆ has_body()

bool google_gmail_api::MessagePart::has_body ( ) const
inline

Determine if the 'body' attribute was set.

Returns
true if the 'body' attribute was set.

◆ has_filename()

bool google_gmail_api::MessagePart::has_filename ( ) const
inline

Determine if the 'filename' attribute was set.

Returns
true if the 'filename' attribute was set.

◆ has_headers()

bool google_gmail_api::MessagePart::has_headers ( ) const
inline

Determine if the 'headers' attribute was set.

Returns
true if the 'headers' attribute was set.

◆ has_mime_type()

bool google_gmail_api::MessagePart::has_mime_type ( ) const
inline

Determine if the 'mimeType' attribute was set.

Returns
true if the 'mimeType' attribute was set.

◆ has_part_id()

bool google_gmail_api::MessagePart::has_part_id ( ) const
inline

Determine if the 'partId' attribute was set.

Returns
true if the 'partId' attribute was set.

◆ has_parts()

bool google_gmail_api::MessagePart::has_parts ( ) const
inline

Determine if the 'parts' attribute was set.

Returns
true if the 'parts' attribute was set.

◆ mutable_body()

MessagePartBody google_gmail_api::MessagePart::mutable_body ( )

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

The message part body for this part, which may be empty for container MIME message parts.

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

◆ mutable_headers()

client::JsonCppArray<MessagePartHeader > google_gmail_api::MessagePart::mutable_headers ( )

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

List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.

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

◆ mutable_parts()

client::JsonCppArray<MessagePart > google_gmail_api::MessagePart::mutable_parts ( )

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

The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.

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

◆ New()

MessagePart * google_gmail_api::MessagePart::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_filename()

void google_gmail_api::MessagePart::set_filename ( const StringPiece &  value)
inline

Change the 'filename' attribute.

The filename of the attachment. Only present if this message part represents an attachment.

Parameters
[in]valueThe new value.

◆ set_mime_type()

void google_gmail_api::MessagePart::set_mime_type ( const StringPiece &  value)
inline

Change the 'mimeType' attribute.

The MIME type of the message part.

Parameters
[in]valueThe new value.

◆ set_part_id()

void google_gmail_api::MessagePart::set_part_id ( const StringPiece &  value)
inline

Change the 'partId' attribute.

The immutable ID of the message part.

Parameters
[in]valueThe new value.

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