Aspose::Email::Clients::Google::GmailClient Class Reference

Base class for Gmail client More...

Inherits Aspose::Email::Clients::Google::IBaseGmailClient.

Public Member Functions
virtual ASPOSE_EMAIL_SHARED_API System::String	get_DefaultEmail ()
	Gets default email address More...
virtual ASPOSE_EMAIL_SHARED_API void	set_DefaultEmail (System::String value)
	Sets default email address More...
virtual ASPOSE_EMAIL_SHARED_API System::String	get_AccessToken ()
	Gets OAuth 2.0 access token In case if refresh token is set, access token is generated automatically. More...
virtual ASPOSE_EMAIL_SHARED_API void	set_AccessToken (System::String value)
	Sets OAuth 2.0 access token In case if refresh token is set, access token is generated automatically. More...
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Net::IWebProxy >	get_Proxy ()
	Gets the proxy. More...
virtual ASPOSE_EMAIL_SHARED_API void	set_Proxy (System::SharedPtr< System::Net::IWebProxy > value)
	Sets the proxy. More...
virtual ASPOSE_EMAIL_SHARED_API int32_t	get_Timeout ()
	Gets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
virtual ASPOSE_EMAIL_SHARED_API void	set_Timeout (int32_t value)
	Sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String clientId, System::String clientSecret, System::String refreshToken)
	Initializes a new instance of the GmailClient based class More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String clientId, System::String clientSecret, System::String refreshToken, System::SharedPtr< System::Net::IWebProxy > proxy)
	Initializes a new instance of the GmailClient based class More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String accessToken)
	Initializes a new instance of the GmailClient based class More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String accessToken, System::SharedPtr< System::Net::IWebProxy > proxy)
	Initializes a new instance of the GmailClient based class More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String clientId, System::String clientSecret, System::String refreshToken, System::String defaultEmail)
	Initializes a new instance of the GmailClient based class More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String clientId, System::String clientSecret, System::String refreshToken, System::SharedPtr< System::Net::IWebProxy > proxy, System::String defaultEmail)
	Initializes a new instance of the GmailClient based class More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String accessToken, System::String defaultEmail)
	Initializes a new instance of the GmailClient based class More...
ASPOSE_EMAIL_SHARED_API	GmailClient (System::String accessToken, System::SharedPtr< System::Net::IWebProxy > proxy, System::String defaultEmail)
	Initializes a new instance of the GmailClient based class More...
virtual ASPOSE_EMAIL_SHARED_API void	RefreshToken ()
	Refresh access token More...
virtual ASPOSE_EMAIL_SHARED_API void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Static Public Member Functions
static ASPOSE_EMAIL_SHARED_API int32_t	get_DefaultTimeout ()
	Gets the default timeout value for ActiveSync client instances The default value is 100,000 milliseconds (100 seconds). More...
static ASPOSE_EMAIL_SHARED_API void	set_DefaultTimeout (int32_t value)
	Sets the default timeout value for ActiveSync client instances The default value is 100,000 milliseconds (100 seconds). More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< IGmailClient >	GetInstance (System::String accessToken, System::String defaultEmail)
	Gets instance of Gmail client More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< IGmailClient >	GetInstance (System::String accessToken, System::SharedPtr< System::Net::IWebProxy > proxy, System::String defaultEmail)
	Gets instance of Gmail client More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< IGmailClient >	GetInstance (System::String clientId, System::String clientSecret, System::String refreshToken, System::String defaultEmail)
	Gets instance of Gmail client More...
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< IGmailClient >	GetInstance (System::String clientId, System::String clientSecret, System::String refreshToken, System::SharedPtr< System::Net::IWebProxy > proxy, System::String defaultEmail)
	Gets instance of Gmail client More...

Friends
class	Aspose::Email::Clients::Google::GmailClient_v3

Detailed Description

Base class for Gmail client

Constructor & Destructor Documentation

GmailClient() [1/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient	(	System::String	clientId,
		System::String	clientSecret,
		System::String	refreshToken
	)

Initializes a new instance of the GmailClient based class

Parameters

clientId	The client ID obtained from the Google Cloud Console during application registration.
clientSecret	The client secret obtained during application registration.
refreshToken	OAuth 2.0 refresh token

GmailClient() [2/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient	(	System::String	clientId,
		System::String	clientSecret,
		System::String	refreshToken,
		System::SharedPtr< System::Net::IWebProxy >	proxy
	)

Initializes a new instance of the GmailClient based class

Parameters

clientId	The client ID obtained from the Google Cloud Console during application registration.
clientSecret	The client secret obtained during application registration.
refreshToken	OAuth 2.0 refresh token
proxy	IWebProxy for Gmail client

GmailClient() [3/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient

(

System::String

accessToken

)

Initializes a new instance of the GmailClient based class

Parameters

accessToken

OAuth 2.0 access token

GmailClient() [4/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient	(	System::String	accessToken,
		System::SharedPtr< System::Net::IWebProxy >	proxy
	)

Initializes a new instance of the GmailClient based class

Parameters

accessToken	OAuth 2.0 access token
proxy	IWebProxy for Gmail client

GmailClient() [5/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient	(	System::String	clientId,
		System::String	clientSecret,
		System::String	refreshToken,
		System::String	defaultEmail
	)

Initializes a new instance of the GmailClient based class

Parameters

clientId	The client ID obtained from the Google Cloud Console during application registration.
clientSecret	The client secret obtained during application registration.
refreshToken	OAuth 2.0 refresh token
defaultEmail	Default email address

GmailClient() [6/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient	(	System::String	clientId,
		System::String	clientSecret,
		System::String	refreshToken,
		System::SharedPtr< System::Net::IWebProxy >	proxy,
		System::String	defaultEmail
	)

Initializes a new instance of the GmailClient based class

Parameters

clientId	The client ID obtained from the Google Cloud Console during application registration.
clientSecret	The client secret obtained during application registration.
refreshToken	OAuth 2.0 refresh token
proxy	IWebProxy for Gmail client
defaultEmail	Default email address

GmailClient() [7/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient	(	System::String	accessToken,
		System::String	defaultEmail
	)

Initializes a new instance of the GmailClient based class

Parameters

accessToken	OAuth 2.0 access token
defaultEmail	Default email address

GmailClient() [8/8]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Google::GmailClient::GmailClient	(	System::String	accessToken,
		System::SharedPtr< System::Net::IWebProxy >	proxy,
		System::String	defaultEmail
	)

Initializes a new instance of the GmailClient based class

Parameters

accessToken	OAuth 2.0 access token
proxy	IWebProxy for Gmail client
defaultEmail	Default email address

Member Function Documentation

Dispose()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Google::GmailClient::Dispose ( )

virtual

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

get_AccessToken()

virtual ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Clients::Google::GmailClient::get_AccessToken ( )

virtual

Gets OAuth 2.0 access token In case if refresh token is set, access token is generated automatically.

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

get_DefaultEmail()

virtual ASPOSE_EMAIL_SHARED_API System::String Aspose::Email::Clients::Google::GmailClient::get_DefaultEmail ( )

virtual

Gets default email address

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

get_DefaultTimeout()

static ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::Google::GmailClient::get_DefaultTimeout ( )

static

Gets the default timeout value for ActiveSync client instances The default value is 100,000 milliseconds (100 seconds).

get_Proxy()

virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr<System::Net::IWebProxy> Aspose::Email::Clients::Google::GmailClient::get_Proxy ( )

virtual

Gets the proxy.

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

get_Timeout()

virtual ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::Google::GmailClient::get_Timeout ( )

virtual

Gets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

GetInstance() [1/4]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<IGmailClient> Aspose::Email::Clients::Google::GmailClient::GetInstance ( System::String  accessToken, System::SharedPtr< System::Net::IWebProxy >  proxy, System::String  defaultEmail  )

static

Gets instance of Gmail client

Parameters

accessToken	OAuth 2.0 access token
proxy	IWebProxy for Gmail client
defaultEmail	Default email address

Returns

Returns instance of Gmail client

GetInstance() [2/4]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<IGmailClient> Aspose::Email::Clients::Google::GmailClient::GetInstance ( System::String  accessToken, System::String  defaultEmail  )

static

Gets instance of Gmail client

Parameters

accessToken	OAuth 2.0 access token
defaultEmail	Default email address

Returns

Returns instance of Gmail client

GetInstance() [3/4]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<IGmailClient> Aspose::Email::Clients::Google::GmailClient::GetInstance ( System::String  clientId, System::String  clientSecret, System::String  refreshToken, System::SharedPtr< System::Net::IWebProxy >  proxy, System::String  defaultEmail  )

static

Gets instance of Gmail client

Parameters

clientId	The client ID obtained from the Google Cloud Console during application registration.
clientSecret	The client secret obtained during application registration.
refreshToken	OAuth 2.0 refresh token
proxy	IWebProxy for Gmail client
defaultEmail	Default email address

Returns

Returns instance of Gmail client

GetInstance() [4/4]

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<IGmailClient> Aspose::Email::Clients::Google::GmailClient::GetInstance ( System::String  clientId, System::String  clientSecret, System::String  refreshToken, System::String  defaultEmail  )

static

Gets instance of Gmail client

Parameters

clientId	The client ID obtained from the Google Cloud Console during application registration.
clientSecret	The client secret obtained during application registration.
refreshToken	OAuth 2.0 refresh token
defaultEmail	Default email address

Returns

Returns instance of Gmail client

RefreshToken()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Google::GmailClient::RefreshToken ( )

virtual

Refresh access token

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

set_AccessToken()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Google::GmailClient::set_AccessToken ( System::String  value )

virtual

Sets OAuth 2.0 access token In case if refresh token is set, access token is generated automatically.

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

set_DefaultEmail()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Google::GmailClient::set_DefaultEmail ( System::String  value )

virtual

Sets default email address

set_DefaultTimeout()

static ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Google::GmailClient::set_DefaultTimeout ( int32_t  value )

static

Sets the default timeout value for ActiveSync client instances The default value is 100,000 milliseconds (100 seconds).

set_Proxy()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Google::GmailClient::set_Proxy ( System::SharedPtr< System::Net::IWebProxy >  value )

virtual

Sets the proxy.

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

set_Timeout()

virtual ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Google::GmailClient::set_Timeout ( int32_t  value )

virtual

Sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).

Implements Aspose::Email::Clients::Google::IBaseGmailClient.

Friends And Related Function Documentation

Aspose::Email::Clients::Google::GmailClient_v3

friend class Aspose::Email::Clients::Google::GmailClient_v3

friend