#include <gmail_service.h>

Inheritance diagram for google_gmail_api::UsersResource_MessagesResource_GetMethod:

Public Member Functions
	UsersResource_MessagesResource_GetMethod (const GmailService _service_, client::AuthorizationCredential _credential_, const absl::string_view &user_id, const absl::string_view &id)

virtual	~UsersResource_MessagesResource_GetMethod ()

void	clear_format ()

const string &	get_format () const

string *	mutable_format ()

void	set_format (const string &value)

void	clear_metadata_headers ()

const client::JsonCppArray< string > &	get_metadata_headers () const

client::JsonCppArray< string > *	mutable_metadataHeaders ()

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)

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

Detailed Description

Implements the get 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.addons.current.message.action https://www.googleapis.com/auth/gmail.addons.current.message.metadata https://www.googleapis.com/auth/gmail.addons.current.message.readonly https://www.googleapis.com/auth/gmail.metadata https://www.googleapis.com/auth/gmail.modify https://www.googleapis.com/auth/gmail.readonly

Constructor & Destructor Documentation

◆ UsersResource_MessagesResource_GetMethod()

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

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_id	The user's email address. The special value me can be used to indicate the authenticated user.
[in]	id	The ID of the message to retrieve.

◆ ~UsersResource_MessagesResource_GetMethod()

google_gmail_api::UsersResource_MessagesResource_GetMethod::~UsersResource_MessagesResource_GetMethod ( )

virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_gmail_api::UsersResource_MessagesResource_GetMethod::AppendOptionalQueryParameters ( string * target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out] target The URL string to append to.

Reimplemented from google_gmail_api::GmailServiceBaseRequest.

◆ AppendVariable()

util::Status google_gmail_api::UsersResource_MessagesResource_GetMethod::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_name	The name of the templated variable.
[in]	config	A pass-through parameter used for lists and maps.
[in,out]	target	The string to append the value to.

Reimplemented from google_gmail_api::GmailServiceBaseRequest.

◆ clear_format()

void google_gmail_api::UsersResource_MessagesResource_GetMethod::clear_format ( )

inline

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

◆ clear_metadata_headers()

void google_gmail_api::UsersResource_MessagesResource_GetMethod::clear_metadata_headers ( )

inline

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

◆ ExecuteAndParseResponse()

util::Status google_gmail_api::UsersResource_MessagesResource_GetMethod::ExecuteAndParseResponse ( Message * data )

inline

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

Parameters

[out] data Loads 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_format()

const string& google_gmail_api::UsersResource_MessagesResource_GetMethod::get_format ( ) const

inline

Gets the optional 'format' attribute.

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

◆ get_metadata_headers()

const client::JsonCppArray<string >& google_gmail_api::UsersResource_MessagesResource_GetMethod::get_metadata_headers ( ) const

inline

Gets the optional 'metadataHeaders' attribute.

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

◆ mutable_format()

string* google_gmail_api::UsersResource_MessagesResource_GetMethod::mutable_format ( )

inline

Gets a modifiable pointer to the optional format' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_metadataHeaders()

client::JsonCppArray<string >* google_gmail_api::UsersResource_MessagesResource_GetMethod::mutable_metadataHeaders ( )

inline

Gets a modifiable pointer to the optional metadataHeaders' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ set_format()

void google_gmail_api::UsersResource_MessagesResource_GetMethod::set_format ( const string & value )

inline

Sets the 'format' attribute.

Parameters

[in] value The format to return the message in.

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

google/gmail_api/gmail_service.h
google/gmail_api/gmail_service.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsersResource_MessagesResource_GetMethod()

◆ ~UsersResource_MessagesResource_GetMethod()

Member Function Documentation

◆ AppendOptionalQueryParameters()

◆ AppendVariable()

◆ clear_format()

◆ clear_metadata_headers()

◆ ExecuteAndParseResponse()

◆ get_format()

◆ get_metadata_headers()

◆ mutable_format()

◆ mutable_metadataHeaders()

◆ set_format()