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

#include <gmail_service.h>

Inheritance diagram for google_gmail_api::UsersResource_MessagesResource_InsertMethod:
google_gmail_api::GmailServiceBaseRequest

Public Member Functions

 UsersResource_MessagesResource_InsertMethod (const GmailService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &user_id)
 
 UsersResource_MessagesResource_InsertMethod (const GmailService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &user_id, const Message *_metadata_, const StringPiece &_media_content_type_, client::DataReader *_media_content_reader_)
 
virtual ~UsersResource_MessagesResource_InsertMethod ()
 
void clear_deleted ()
 
bool get_deleted () const
 
void set_deleted (bool value)
 
void clear_internal_date_source ()
 
const string & get_internal_date_source () const
 
string * mutable_internalDateSource ()
 
void set_internal_date_source (const string &value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (Message *data)
 
- Public Member Functions inherited from google_gmail_api::GmailServiceBaseRequest
 GmailServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~GmailServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 

Static Public Attributes

static const client::MediaUploadSpec SIMPLE_MEDIA_UPLOAD
 
static const client::MediaUploadSpec RESUMABLE_MEDIA_UPLOAD
 

Additional Inherited Members

- Protected Member Functions inherited from google_gmail_api::GmailServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the insert method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://mail.google.com/ https://www.googleapis.com/auth/gmail.insert https://www.googleapis.com/auth/gmail.modify

Constructor & Destructor Documentation

◆ UsersResource_MessagesResource_InsertMethod() [1/2]

google_gmail_api::UsersResource_MessagesResource_InsertMethod::UsersResource_MessagesResource_InsertMethod ( const GmailService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  user_id 
)

The standard constructor takes all the required method parameters.

Deprecated:
in favor constructor that includes the media upload parameters.
Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]user_idThe user's email address. The special value me can be used to indicate the authenticated user.
[in]<em>content</em>The data object to insert.

◆ UsersResource_MessagesResource_InsertMethod() [2/2]

google_gmail_api::UsersResource_MessagesResource_InsertMethod::UsersResource_MessagesResource_InsertMethod ( const GmailService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  user_id,
const Message _metadata_,
const StringPiece &  _media_content_type_,
client::DataReader *  _media_content_reader_ 
)

The standard constructor takes all the required method parameters.

Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]user_idThe user's email address. The special value me can be used to indicate the authenticated user.
[in]<em>metadata</em>The metadata object to insert. If this is NULL then do not upload any metadata.
[in]<em>media_content_type</em>The content type of the data in the media_content_reader.
[in]<em>media_content_reader</em>The media content to insert. If this is NULL then do not upload any media and ignore media_content_type.

◆ ~UsersResource_MessagesResource_InsertMethod()

google_gmail_api::UsersResource_MessagesResource_InsertMethod::~UsersResource_MessagesResource_InsertMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_gmail_api::UsersResource_MessagesResource_InsertMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_gmail_api::GmailServiceBaseRequest.

◆ AppendVariable()

util::Status google_gmail_api::UsersResource_MessagesResource_InsertMethod::AppendVariable ( const StringPiece &  variable_name,
const client::UriTemplateConfig &  config,
string *  target 
)
virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters
[in]variable_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_gmail_api::GmailServiceBaseRequest.

◆ clear_deleted()

void google_gmail_api::UsersResource_MessagesResource_InsertMethod::clear_deleted ( )
inline

Clears the 'deleted' attribute so it is no longer set.

◆ clear_internal_date_source()

void google_gmail_api::UsersResource_MessagesResource_InsertMethod::clear_internal_date_source ( )
inline

Clears the 'internalDateSource' attribute so it is no longer set.

◆ ExecuteAndParseResponse()

util::Status google_gmail_api::UsersResource_MessagesResource_InsertMethod::ExecuteAndParseResponse ( Message data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_deleted()

bool google_gmail_api::UsersResource_MessagesResource_InsertMethod::get_deleted ( ) const
inline

Gets the optional 'deleted' attribute.

If the value is not set then the default value will be returned.

◆ get_internal_date_source()

const string& google_gmail_api::UsersResource_MessagesResource_InsertMethod::get_internal_date_source ( ) const
inline

Gets the optional 'internalDateSource' attribute.

If the value is not set then the default value will be returned.

◆ mutable_internalDateSource()

string* google_gmail_api::UsersResource_MessagesResource_InsertMethod::mutable_internalDateSource ( )
inline

Gets a modifiable pointer to the optional internalDateSource' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_deleted()

void google_gmail_api::UsersResource_MessagesResource_InsertMethod::set_deleted ( bool  value)
inline

Sets the 'deleted' attribute.

Parameters
[in]valueMark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.

◆ set_internal_date_source()

void google_gmail_api::UsersResource_MessagesResource_InsertMethod::set_internal_date_source ( const string &  value)
inline

Sets the 'internalDateSource' attribute.

Parameters
[in]valueSource for Gmail's internal date of the message.

Member Data Documentation

◆ RESUMABLE_MEDIA_UPLOAD

const client::MediaUploadSpec google_gmail_api::UsersResource_MessagesResource_InsertMethod::RESUMABLE_MEDIA_UPLOAD
static

Returns the specification for media upload using the resumable protocol.

◆ SIMPLE_MEDIA_UPLOAD

const client::MediaUploadSpec google_gmail_api::UsersResource_MessagesResource_InsertMethod::SIMPLE_MEDIA_UPLOAD
static

Returns MediaUploader for uploading the content. Returns the specification for media upload using the simple protocol.


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