Aspose::Email::Clients::Exchange::WebService::EWSClient Class Reference

Provides access to MS Exchange Server by using Exchange Web Services (EWS). More...

Inherits Aspose::Email::Clients::Exchange::ExchangeClientBase.

Public Member Functions
	EWSClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::IWebProxy > proxy, System::SharedPtr< ExchangeLogger > exchangeLogger=nullptr)
	Initializes a new instance of the EWSClient based class More...
Public Member Functions inherited from Aspose::Email::Clients::Exchange::ExchangeClientBase
System::SharedPtr< System::Net::IWebProxy >	get_Proxy () override
	Gets the proxy. More...
void	set_Proxy (System::SharedPtr< System::Net::IWebProxy > value) override
	Sets the proxy. More...
System::SharedPtr< System::Net::ICredentials >	get_Credentials () override
	Gets the credentials More...
void	set_Credentials (System::SharedPtr< System::Net::ICredentials > value) override
	Sets the credentials More...
System::String	get_MailboxUri () override
	Gets the mailbox uri More...
void	set_MailboxUri (System::String value) override
	Sets the mailbox uri More...
int32_t	get_Timeout () override
	Gets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
void	set_Timeout (int32_t value) override
	Sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
System::String	get_LogFileName () override
	Gets log file name More...
void	set_LogFileName (System::String value) override
	Sets log file name More...
bool	get_UseDateInLogFileName () override
	Gets value which indicates if date has to be used in log file name. More...
void	set_UseDateInLogFileName (bool value) override
	Sets value which indicates if date has to be used in log file name. More...
System::SharedPtr< Aspose::Email::Tools::Logging::Logger >	get_Logger ()
	Diagnostic logger More...
	ExchangeClientBase (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::IWebProxy > proxy, System::SharedPtr< ExchangeLogger > exchangeLogger=nullptr)
	Initializes a new instance of the ExchangeClientBase class More...
void	Dispose () override
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Static Public Member Functions
static System::SharedPtr< IEWSClient >	GetEWSClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (System::String mailboxUri, System::String username, System::String password)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (System::String mailboxUri, System::String username, System::String password, System::SharedPtr< System::Net::WebProxy > proxy)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (System::String mailboxUri, System::String username, System::String password, System::String domain)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (System::String mailboxUri, System::String username, System::String password, System::String domain, System::SharedPtr< System::Net::WebProxy > proxy)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (ExchangeVersion serverVersion, System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (ExchangeVersion serverVersion, bool formbasedAuthenticationRequired, System::String formbasedAuthenticationLocation, System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (ExchangeVersion serverVersion, bool formbasedAuthenticationRequired, System::String formbasedAuthenticationLocation, System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy, System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >> headers)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEWSClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy, System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >> headers)
	Initializes a new instance of the EWSClient based class More...
static System::SharedPtr< IEWSClient >	GetEwsClient (ExchangeVersion serverVersion, bool formBasedAuthenticationRequired, System::String formBasedAuthenticationLocation, System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy, System::SharedPtr< IHttpWebRequestCreate > httpWebRequestCreate)
static System::SharedPtr< IEWSClient >	GetEwsClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy, System::SharedPtr< IHttpWebRequestCreate > httpWebRequestCreate, System::SharedPtr< ServiceBinding::IExchangeServiceBindingPrepare > exchangeServiceBindingPrepare, System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >> headers)

Static Protected Member Functions
static ExchangeFolderType	FolderClassToFolderType (System::String folderClass)
static System::String	FolderTypeToFolderClass (ExchangeFolderType folderType)
static System::String	FolderTypeToFolderClass (ExchangeFolderType folderType, System::String customFolderClass)

Additional Inherited Members
Public Attributes inherited from Aspose::Email::Clients::Exchange::ExchangeClientBase
System::SharedPtr< System::Object >	lockObject
Protected Member Functions inherited from Aspose::Email::Clients::Exchange::ExchangeClientBase
void	ResetLogSettings ()
	Resets logging settings to default. More...
virtual void	Dispose (bool disposing)
	Releases unmanaged and - optionally - managed resources More...

Detailed Description

Provides access to MS Exchange Server by using Exchange Web Services (EWS).

Constructor & Destructor Documentation

EWSClient()

Aspose::Email::Clients::Exchange::WebService::EWSClient::EWSClient	(	System::String	mailboxUri,
		System::SharedPtr< System::Net::ICredentials >	credentials,
		System::SharedPtr< System::Net::IWebProxy >	proxy,
		System::SharedPtr< ExchangeLogger >	exchangeLogger = nullptr
	)

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
credentials	Contains the credentials for authentication.
proxy	Contains HTTP proxy settings
exchangeLogger	Diagnostic logger

Member Function Documentation

FolderClassToFolderType()

static ExchangeFolderType Aspose::Email::Clients::Exchange::WebService::EWSClient::FolderClassToFolderType ( System::String  folderClass )

staticprotected

FolderTypeToFolderClass() [1/2]

static System::String Aspose::Email::Clients::Exchange::WebService::EWSClient::FolderTypeToFolderClass ( ExchangeFolderType  folderType )

staticprotected

FolderTypeToFolderClass() [2/2]

static System::String Aspose::Email::Clients::Exchange::WebService::EWSClient::FolderTypeToFolderClass ( ExchangeFolderType  folderType, System::String  customFolderClass  )

staticprotected

GetEWSClient() [1/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( ExchangeVersion  serverVersion, bool  formbasedAuthenticationRequired, System::String  formbasedAuthenticationLocation, System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials, System::SharedPtr< System::Net::WebProxy >  proxy  )

static

Initializes a new instance of the EWSClient based class

Parameters

serverVersion	Exchange server versions
formbasedAuthenticationRequired	Set true if form-based authentication is required, otherwise set false.
formbasedAuthenticationLocation	url for form-based authentication
mailboxUri	The URI of mailbox
credentials	Contains the credentials for authentication.
proxy	Contains HTTP proxy settings

Returns

Instance of the class based on the EWSClient class.

GetEwsClient() [1/2]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEwsClient ( ExchangeVersion  serverVersion, bool  formBasedAuthenticationRequired, System::String  formBasedAuthenticationLocation, System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials, System::SharedPtr< System::Net::WebProxy >  proxy, System::SharedPtr< IHttpWebRequestCreate >  httpWebRequestCreate  )

static

GetEWSClient() [2/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( ExchangeVersion  serverVersion, bool  formbasedAuthenticationRequired, System::String  formbasedAuthenticationLocation, System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials, System::SharedPtr< System::Net::WebProxy >  proxy, System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >>  headers  )

static

Initializes a new instance of the EWSClient based class

Parameters

serverVersion	Exchange server versions
formbasedAuthenticationRequired	Set true if form-based authentication is required, otherwise set false.
formbasedAuthenticationLocation	url for form-based authentication
mailboxUri	The URI of mailbox
credentials	Contains the credentials for authentication.
proxy	Contains HTTP proxy settings
headers	Additional headers for client.

Returns

Instance of the class based on the EWSClient class.

GetEWSClient() [3/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( ExchangeVersion  serverVersion, System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials, System::SharedPtr< System::Net::WebProxy >  proxy  )

static

Initializes a new instance of the EWSClient based class

Parameters

serverVersion	Exchange server versions
mailboxUri	The URI of mailbox
credentials	Contains the credentials for authentication.
proxy	Contains HTTP proxy settings

Returns

Instance of the class based on the EWSClient class.

GetEWSClient() [4/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials  )

static

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
credentials	Contains the credentials for authentication.

Returns

Instance of the class based on the EWSClient class.

GetEWSClient() [5/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials, System::SharedPtr< System::Net::WebProxy >  proxy  )

static

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
credentials	Contains the credentials for authentication.
proxy	Contains HTTP proxy settings

Returns

Instance of the class based on the EWSClient class.

GetEwsClient() [2/2]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEwsClient ( System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials, System::SharedPtr< System::Net::WebProxy >  proxy, System::SharedPtr< IHttpWebRequestCreate >  httpWebRequestCreate, System::SharedPtr< ServiceBinding::IExchangeServiceBindingPrepare >  exchangeServiceBindingPrepare, System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >>  headers  )

static

GetEWSClient() [6/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( System::String  mailboxUri, System::SharedPtr< System::Net::ICredentials >  credentials, System::SharedPtr< System::Net::WebProxy >  proxy, System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >>  headers  )

static

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
credentials	Contains the credentials for authentication.
proxy	Contains HTTP proxy settings
headers	Additional headers for client.

Returns

Instance of the class based on the EWSClient class.

GetEWSClient() [7/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( System::String  mailboxUri, System::String  username, System::String  password  )

static

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
username	The username
password	The password

Returns

Instance of the class based on the EWSClient class.

GetEWSClient() [8/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( System::String  mailboxUri, System::String  username, System::String  password, System::SharedPtr< System::Net::WebProxy >  proxy  )

static

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
username	The username
password	The password
proxy	Contains HTTP proxy settings

Returns

Instance of the class based on the EWSClient class.

GetEWSClient() [9/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( System::String  mailboxUri, System::String  username, System::String  password, System::String  domain  )

static

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
username	The username
password	The password
domain	The domain name

Returns

Instance of the class based on the EWSClient class.

GetEWSClient() [10/10]

static System::SharedPtr<IEWSClient> Aspose::Email::Clients::Exchange::WebService::EWSClient::GetEWSClient ( System::String  mailboxUri, System::String  username, System::String  password, System::String  domain, System::SharedPtr< System::Net::WebProxy >  proxy  )

static

Initializes a new instance of the EWSClient based class

Parameters

mailboxUri	The URI of mailbox
username	The username
password	The password
domain	The domain name
proxy	Contains HTTP proxy settings

Returns

Instance of the class based on the EWSClient class.