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::Loggerget_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< IEWSClientGetEWSClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials)
 Initializes a new instance of the EWSClient based class More...
 
static System::SharedPtr< IEWSClientGetEWSClient (System::String mailboxUri, System::String username, System::String password)
 Initializes a new instance of the EWSClient based class More...
 
static System::SharedPtr< IEWSClientGetEWSClient (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< IEWSClientGetEWSClient (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< IEWSClientGetEWSClient (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< IEWSClientGetEWSClient (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< IEWSClientGetEWSClient (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< IEWSClientGetEWSClient (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< IEWSClientGetEwsClient (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< IEWSClientGetEwsClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::WebProxy > proxy, System::SharedPtr< IHttpWebRequestCreate > httpWebRequestCreate, System::SharedPtr< ServiceBinding::IExchangeServiceBindingPrepare > exchangeServiceBindingPrepare)
 

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)
 

Friends

class Aspose::Email::Clients::Exchange::WebService::EWSClient2007
 

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
mailboxUriThe URI of mailbox
credentialsContains the credentials for authentication.
proxyContains HTTP proxy settings
exchangeLoggerDiagnostic 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/8]

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
serverVersionExchange server versions
formbasedAuthenticationRequiredSet true if form-based authentication is required, otherwise set false.
formbasedAuthenticationLocationurl for form-based authentication
mailboxUriThe URI of mailbox
credentialsContains the credentials for authentication.
proxyContains 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/8]

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
serverVersionExchange server versions
mailboxUriThe URI of mailbox
credentialsContains the credentials for authentication.
proxyContains HTTP proxy settings
Returns
Instance of the class based on the EWSClient class.

◆ GetEWSClient() [3/8]

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
mailboxUriThe URI of mailbox
credentialsContains the credentials for authentication.
Returns
Instance of the class based on the EWSClient class.

◆ GetEWSClient() [4/8]

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
mailboxUriThe URI of mailbox
credentialsContains the credentials for authentication.
proxyContains 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 
)
static

◆ GetEWSClient() [5/8]

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
mailboxUriThe URI of mailbox
usernameThe username
passwordThe password
Returns
Instance of the class based on the EWSClient class.

◆ GetEWSClient() [6/8]

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
mailboxUriThe URI of mailbox
usernameThe username
passwordThe password
proxyContains HTTP proxy settings
Returns
Instance of the class based on the EWSClient class.

◆ GetEWSClient() [7/8]

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
mailboxUriThe URI of mailbox
usernameThe username
passwordThe password
domainThe domain name
Returns
Instance of the class based on the EWSClient class.

◆ GetEWSClient() [8/8]

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
mailboxUriThe URI of mailbox
usernameThe username
passwordThe password
domainThe domain name
proxyContains HTTP proxy settings
Returns
Instance of the class based on the EWSClient class.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Exchange::WebService::EWSClient2007

friend class Aspose::Email::Clients::Exchange::WebService::EWSClient2007
friend