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

ASPOSE_EMAIL_SHARED_API EWSClient (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...
 
- Public Member Functions inherited from Aspose::Email::Clients::Exchange::ExchangeClientBase
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 System::SharedPtr< System::Net::ICredentials > get_Credentials ()
 Gets the credentials More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_Credentials (System::SharedPtr< System::Net::ICredentials > value)
 Sets the credentials More...
 
virtual ASPOSE_EMAIL_SHARED_API System::String get_MailboxUri ()
 Gets the mailbox uri More...
 
virtual ASPOSE_EMAIL_SHARED_API void set_MailboxUri (System::String value)
 Sets the mailbox uri 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 System::String get_LogFileName ()
 Gets log file name More...
 
ASPOSE_EMAIL_SHARED_API void set_LogFileName (System::String value)
 Sets log file name More...
 
ASPOSE_EMAIL_SHARED_API bool get_UseDateInLogFileName ()
 Gets value which indicates if date has to be used in log file name. More...
 
ASPOSE_EMAIL_SHARED_API void set_UseDateInLogFileName (bool value)
 Sets value which indicates if date has to be used in log file name. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< Aspose::Email::Tools::Logging::Logger > get_Logger ()
 Diagnostic logger More...
 
ASPOSE_EMAIL_SHARED_API ExchangeClientBase (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials, System::SharedPtr< System::Net::IWebProxy > proxy)
 Initializes a new instance of the ExchangeClientBase class More...
 
ASPOSE_EMAIL_SHARED_API void ResetLogSettings ()
 Resets logging settings to default. More...
 
ASPOSE_EMAIL_SHARED_API void initializeLogger ()
 
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 System::SharedPtr< IEWSClientGetEWSClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials)
 Initializes a new instance of the EWSClient based class More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< IEWSClientGetEWSClient (System::String mailboxUri, System::String username, System::String password)
 Initializes a new instance of the EWSClient based class More...
 
static ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Net::CookieCollection > doFormbasedAuthentication (System::String url, System::SharedPtr< System::Net::NetworkCredential > credential)
 

Static Protected Member Functions

static ASPOSE_EMAIL_SHARED_API ExchangeFolderType FolderClassToFolderType (System::String folderClass)
 
static ASPOSE_EMAIL_SHARED_API System::String FolderTypeToFolderClass (ExchangeFolderType folderType)
 
static ASPOSE_EMAIL_SHARED_API 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
 
- Static Public Attributes inherited from Aspose::Email::Clients::Exchange::ExchangeClientBase
static const ASPOSE_EMAIL_SHARED_API int32_t MaxEntriesReturned
 
- Protected Member Functions inherited from Aspose::Email::Clients::Exchange::ExchangeClientBase
virtual ASPOSE_EMAIL_SHARED_API 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_SHARED_API Aspose::Email::Clients::Exchange::WebService::EWSClient::EWSClient ( System::String  mailboxUri,
System::SharedPtr< System::Net::ICredentials >  credentials,
System::SharedPtr< System::Net::WebProxy >  proxy 
)

Initializes a new instance of the EWSClient based class

Parameters
mailboxUriThe URI of mailbox
credentialsContains the credentials for authentication.
proxyContains HTTP proxy settings

Member Function Documentation

◆ doFormbasedAuthentication()

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<System::Net::CookieCollection> Aspose::Email::Clients::Exchange::WebService::EWSClient::doFormbasedAuthentication ( System::String  url,
System::SharedPtr< System::Net::NetworkCredential >  credential 
)
static

◆ FolderClassToFolderType()

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

◆ FolderTypeToFolderClass() [1/2]

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

◆ FolderTypeToFolderClass() [2/2]

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

◆ GetEWSClient() [1/8]

static ASPOSE_EMAIL_SHARED_API 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() [2/8]

static ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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() [5/8]

static ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API 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