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

Public Member Functions
System::SharedPtr< System::Security::Cryptography::X509Certificates::X509Certificate >	get_ClientCertificate () const
	Gets the client certificate. More...

void	set_ClientCertificate (System::SharedPtr< System::Security::Cryptography::X509Certificates::X509Certificate > value)
	Sets the client certificate. More...

bool	get_KeepAlive () const
	Indicates whether to keep alive. More...

void	set_KeepAlive (bool value)
	Indicates whether to keep alive. More...

bool	get_PreAuthenticate () const
	Indicates whether to do pre-authentication. More...

void	set_PreAuthenticate (bool value)
	Indicates whether to do pre-authentication. More...

System::SharedPtr< System::Text::Encoding >	get_Encoding () const
	Gets the encoding. More...

void	set_Encoding (System::SharedPtr< System::Text::Encoding > value)
	Sets the encoding. More...

System::SharedPtr< ExchangeMailboxInfo >	get_MailboxInfo ()
	Gets the mailbox information. More...

System::SharedPtr< System::Net::CookieContainer >	get_CookieContainer () const
	Gets the cookie container. More...

void	set_CookieContainer (System::SharedPtr< System::Net::CookieContainer > value)
	Sets the cookie container. More...

bool	get_SendChunked () const
	Gets a value indicating whether [send chunked]. More...

void	set_SendChunked (bool value)
	Sets a value indicating whether [send chunked]. More...

	ExchangeClient (System::String mailboxUri, System::String username, System::String password)
	Initialize a new instance of the class ExchageClient More...

	ExchangeClient (System::String mailboxUri, System::String username, System::String password, System::String domain)
	Initialize a new instance of the class ExchageClient More...

	ExchangeClient (System::String mailboxUri, System::SharedPtr< System::Net::ICredentials > credentials)
	Initialize a new instance of the class ExchageClient More...

void	MoveMessage (System::SharedPtr< ExchangeMessageInfo > msgInfo, System::String destinationFolderUri)
	Moves the message. More...

void	MoveMessage (System::SharedPtr< ExchangeMessageInfo > msgInfo, System::String destinationFolderUri, bool overwrite)
	Moves the message. More...

void	MoveMessage (System::String destinationFolderUri, System::String messageUri)
	Moves the message. More...

void	MoveMessage (System::String destinationFolderUri, bool overwrite, System::String messageUri)
	Moves the message. More...

void	MoveItems (System::String destinationFolderUri, const System::ArrayPtr< System::String > &itemsUriArray)
	Moves items. More...

void	MoveItems (System::String destinationFolderUri, bool overwrite, const System::ArrayPtr< System::String > &itemsUriArray)
	Moves items. More...

int64_t	GetMailboxSize ()
	Get the size of the maibox More...

int64_t	GetMailboxSize (System::String mailbox)
	Get the size of the maibox More...

System::SharedPtr< ExchangeMailboxInfo >	GetMailboxInfo ()
	Get the information of the mailbox More...

System::String	GetVersionInfo ()
	Returns exchange server version info More...

System::SharedPtr< ExchangeMailboxInfo >	GetMailboxInfo (System::String mailbox)
	Gets the mailbox information More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder, System::String messageClass, bool recursive)
	Lists the messages. More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder, bool recursive)
	List the messages in the specified folder More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder, System::String query)
	Lists the messages. More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder, System::SharedPtr< Aspose::Email::Tools::Search::MailQuery > query, bool recursive)
	Lists the messages. More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessagesById (System::String folder, System::String messageId)
	Lists the messages by id. More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder, ExchangeListMessagesOptions options)
	Lists the mail message in the specified folder. More...

void	SaveMessage (System::String messageUri, System::String path)
	Saves mail message specified by the uri to local file system. The mail message file is RFC 822 compliant format (EML). More...

void	SaveMessage (System::String messageUri, System::SharedPtr< System::IO::Stream > stream)
	Saves the message. More...

void	Send (System::SharedPtr< MailMessage > message)
	Sends the mail message. More...

void	SetReadFlag (System::String messageUri)
	Marks the specifeid message as read. More...

void	SetReadFlag (System::String messageUri, bool suppressReceipt)
	Marks the specifeid message as read. More...

System::SharedPtr< ExchangeFolderInfoCollection >	ListPublicFolders ()
	Gets collection of public folders from root public folder More...

System::SharedPtr< ExchangeFolderInfoCollection >	ListSubFolders (System::String parentFolderUri)
	Gets collection of child folders from parent More...

System::SharedPtr< MailMessage >	FetchMessage (System::String messageUri)
	Fetches the mail message with specified uri. More...

System::SharedPtr< Aspose::Email::Mapi::MapiMessage >	FetchMapiMessage (System::String messageUri)
	Fetches the mapi message with specified uri. More...

void	DeleteMessage (System::String messageUri)
	Deletes the mail message. More...

void	DeleteMessage (System::String messageUri, bool suppressReceipt)
	Deletes the mail message. More...

System::String	AppendMessage (System::String folder, System::SharedPtr< MailMessage > message)
	Uploads the mail message to the specified folder More...

System::String	AppendMessage (System::String folder, System::SharedPtr< MailMessage > message, bool markAsSent)
	Uploads the mail message to the specified folder More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder, int32_t maxNumberOfMessages, ExchangeListMessagesOptions options)
	List the messages in the specified folder More...

System::SharedPtr< Attachment >	FetchAttachment (System::String attachmentUri)
	Fetches the attachment More...

void	Backup (System::SharedPtr< ExchangeFolderInfoCollection > folders, System::String fileName, Aspose::Email::Storage::Pst::BackupOptions options)
	Backups the content of the specified folders More...

void	Backup (System::SharedPtr< ExchangeFolderInfoCollection > folders, System::SharedPtr< System::IO::Stream > stream, Aspose::Email::Storage::Pst::BackupOptions options)
	Backups the content of the specified folders More...

System::SharedPtr< ExchangeFolderInfo >	GetFolderInfo (System::String folderUri)
	Gets the folder information. More...

bool	FolderExists (System::String parentFolderUri, System::String folderName, System::SharedPtr< ExchangeFolderInfo > &folder)
	Checks whether the specified folder exists. More...

void	CreateFolder (System::String parentFolderUri, System::String name)
	Creates the new folder with the specified name in the specified parent folder. More...

void	DeleteFolder (System::String folderUri)
	Deletes the folder More...

void	Restore (System::String fileName, Aspose::Email::Storage::Pst::RestoreOptions options)
	Restores exchange folders from the specified personal storage file. More...

void	Restore (System::SharedPtr< System::IO::Stream > stream, Aspose::Email::Storage::Pst::RestoreOptions options)
	Restores exchange folders from the given personal storage. More...

void	Restore (System::SharedPtr< Aspose::Email::Storage::Pst::PersonalStorage > pst, Aspose::Email::Storage::Pst::RestoreOptions options)
	Restores exchange folders from the given personal storage. More...

void	Restore (System::String fileName, System::SharedPtr< ExchangeFolderInfoCollection > folders, Aspose::Email::Storage::Pst::RestoreOptions options)
	Restores the specified exchange folders from the specified personal storage file. More...

void	Restore (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< ExchangeFolderInfoCollection > folders, Aspose::Email::Storage::Pst::RestoreOptions options)
	Restores the specified exchange folders from the given personal storage. More...

void	Restore (System::SharedPtr< Aspose::Email::Storage::Pst::PersonalStorage > pst, System::SharedPtr< ExchangeFolderInfoCollection > folders, Aspose::Email::Storage::Pst::RestoreOptions options)
	Restores the specified exchange folders from the given personal storage. More...

int64_t	ReadLong (System::SharedPtr< System::IO::Stream > input)

System::String	ParseQuery (System::SharedPtr< Aspose::Email::Tools::Search::MailQuery > query)
	Parses the query. More...

System::ArrayPtr< System::SharedPtr< CustomExchangeStoreProperty > >	GetCustomProperties (System::String address)
	Gets custom properties of the specified object on the server More...

System::ArrayPtr< System::SharedPtr< ExchangeStoreProperty > >	GetProperties (System::String address, System::ArrayPtr< System::SharedPtr< ExchangeStorePropertyName >> propertyName)

System::SharedPtr< MailMessage >	GetMimeMessage (System::String messageUri)

System::String	CreateContact (System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact)
	Creates a contact item in the Exchange store. More...

void	DeleteContact (System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact)
	Deletes the contact. More...

void	DeleteContact (System::SharedPtr< Aspose::Email::Mapi::MapiContact > contact)
	Deletes the contact. More...

void	DeleteContact (System::String id)
	Deletes the contact. More...

System::ArrayPtr< System::SharedPtr< Aspose::Email::PersonalInfo::Contact > >	GetContacts (System::String folderUri)
	Lists contacts located in the specified folder on server More...

System::ArrayPtr< System::SharedPtr< Aspose::Email::Mapi::MapiContact > >	ListContacts (System::String folderUri)
	Lists contacts located in the specified folder on server More...

System::ArrayPtr< System::SharedPtr< Aspose::Email::PersonalInfo::Contact > >	ResolveContacts (System::String unresolvedEntry)
	Resolves ambiguous mailbox display names. Note: the maximum count of returned contacts is 100. This is a restriction of used exchange command. More...

System::SharedPtr< Aspose::Email::Mapi::MapiContactCollection >	ListMailboxes ()
	Lists mailboxes in the global address list. More...

System::ArrayPtr< System::SharedPtr< Aspose::Email::PersonalInfo::Contact > >	GetMailboxes ()
	Lists mailboxes in the global address list. More...

System::SharedPtr< ExchangeFolderInfoCollection >	ListSubFolders (System::SharedPtr< ExchangeFolderInfo > parentFolder)
	Gets collection of child public folders from parent More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder)
	Lists the messages. More...

System::SharedPtr< ExchangeMessageInfoCollection >	ListMessages (System::String folder, int32_t maxNumberOfMessages)
	Lists the messages. More...

bool	FolderExists (System::String parentFolderUri, System::String folderName)
	Checks whether the specified folder exists. 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::String	Decode (System::String content)

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

The ExchangeClient class allows applications to manage E-Mail box in Microsoft Exchange Server by using WebDav Exchange Store Protocol.

Constructor & Destructor Documentation

◆ ExchangeClient() [1/3]

Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ExchangeClient	(	System::String	mailboxUri,
		System::String	username,
		System::String	password
	)

Initialize a new instance of the class ExchageClient

Parameters

mailboxUri	The url of the mailbox
username	The username of the mailbox
password	The password of the mailbox

◆ ExchangeClient() [2/3]

Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ExchangeClient	(	System::String	mailboxUri,
		System::String	username,
		System::String	password,
		System::String	domain
	)

Initialize a new instance of the class ExchageClient

Parameters

mailboxUri	The url of the mailbox
username	The username of the mailbox
password	The password of the mailbox
domain	The domain of the user

◆ ExchangeClient() [3/3]

Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ExchangeClient	(	System::String	mailboxUri,
		System::SharedPtr< System::Net::ICredentials >	credentials
	)

Initialize a new instance of the class ExchageClient

Parameters

mailboxUri	The url of the mailbox
credentials	The credentials used to log in

Member Function Documentation

◆ AppendMessage() [1/2]

System::String Aspose::Email::Clients::Exchange::Dav::ExchangeClient::AppendMessage	(	System::String	folder,
		System::SharedPtr< MailMessage >	message
	)

Uploads the mail message to the specified folder

Parameters

folder	A folder to which message is uploaded
message	A message to upload

Exceptions

AsposeArgumentException	A folder is not specified
AsposeArgumentNullException	message is `null`

Returns: An uri of created message

◆ AppendMessage() [2/2]

System::String Aspose::Email::Clients::Exchange::Dav::ExchangeClient::AppendMessage	(	System::String	folder,
		System::SharedPtr< MailMessage >	message,
		bool	markAsSent
	)

Uploads the mail message to the specified folder

Parameters

folder	An uri of folder to which message is uploaded
message	A message to upload
markAsSent	A value indicating whether the message should be appended as a sent message or a draft.

Exceptions

AsposeArgumentException	A folder is not specified
AsposeArgumentNullException	message is `null`

Returns: An uri of created message

◆ Backup() [1/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Backup	(	System::SharedPtr< ExchangeFolderInfoCollection >	folders,
		System::SharedPtr< System::IO::Stream >	stream,
		Aspose::Email::Storage::Pst::BackupOptions	options
	)

Backups the content of the specified folders

Parameters

folders	A folders to backup
stream	A stream to write into
options	A backup options

Exceptions

NotSupportedException	The given stream does not support writting
AsposeArgumentNullException	folders or stream is `null`

◆ Backup() [2/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Backup	(	System::SharedPtr< ExchangeFolderInfoCollection >	folders,
		System::String	fileName,
		Aspose::Email::Storage::Pst::BackupOptions	options
	)

Backups the content of the specified folders

Parameters

folders	A folders to backup
fileName	A path to the presonal storage file
options	A backup options

Exceptions

AsposeArgumentException	A fileName is `null` or `empty`
AsposeArgumentNullException	folders is `null`

◆ CreateContact()

System::String Aspose::Email::Clients::Exchange::Dav::ExchangeClient::CreateContact ( System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact )

Creates a contact item in the Exchange store.

Parameters

contact Contact item

Returns: The contact Uri

◆ CreateFolder()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::CreateFolder	(	System::String	parentFolderUri,
		System::String	name
	)

Creates the new folder with the specified name in the specified parent folder.

Parameters

parentFolderUri	An uri of parent folder.
name	A name of folder to be created.

Exceptions

AsposeArgumentException parentFolderUri or name is null or empty.

◆ Decode()

static System::String Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Decode ( System::String content )

static

◆ DeleteContact() [1/3]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::DeleteContact ( System::SharedPtr< Aspose::Email::Mapi::MapiContact > contact )

Deletes the contact.

Parameters

contact Contact

◆ DeleteContact() [2/3]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::DeleteContact ( System::SharedPtr< Aspose::Email::PersonalInfo::Contact > contact )

Deletes the contact.

Parameters

contact Contact

◆ DeleteContact() [3/3]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::DeleteContact ( System::String id )

Deletes the contact.

Parameters

id	The contact identifier.

◆ DeleteFolder()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::DeleteFolder ( System::String folderUri )

Deletes the folder

Parameters

folderUri The folder Uri

Exceptions

AsposeArgumentException folderUri is null or empty

◆ DeleteMessage() [1/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::DeleteMessage ( System::String messageUri )

Deletes the mail message.

Parameters

messageUri The message uri.

Exceptions

AsposeArgumentException	messageUri is `empty`.
AsposeArgumentNullException	messageUri is `null`.

◆ DeleteMessage() [2/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::DeleteMessage	(	System::String	messageUri,
		bool	suppressReceipt
	)

Deletes the mail message.

Parameters

messageUri	The message uri.
suppressReceipt	A value indicating whether the sending a non-read report should be suppressed.

Exceptions

AsposeArgumentException	messageUri is `empty`.
AsposeArgumentNullException	messageUri is `null`.

◆ FetchAttachment()

System::SharedPtr<Attachment> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::FetchAttachment ( System::String attachmentUri )

Fetches the attachment

Parameters

attachmentUri The attachment uri. (Attachment uri can be retrieved using ListMessages(folder, ExchangeListMessagesOptions.FetchAttachmentInformation) method)

Exceptions

AsposeArgumentException attachmentUri is null or empty

Returns: Attachment that represents fetched attachment

◆ FetchMapiMessage()

System::SharedPtr<Aspose::Email::Mapi::MapiMessage> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::FetchMapiMessage ( System::String messageUri )

Fetches the mapi message with specified uri.

Parameters

messageUri The message uri.

Returns: A MapiMessage object contains the message.

Exceptions

AsposeArgumentNullException	messageUri is null
AsposeArgumentException	messageUri is empty string

◆ FetchMessage()

System::SharedPtr<MailMessage> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::FetchMessage ( System::String messageUri )

Fetches the mail message with specified uri.

Parameters

messageUri The message uri.

Returns: A MailMessage object contains the message.

◆ FolderExists() [1/2]

bool Aspose::Email::Clients::Exchange::Dav::ExchangeClient::FolderExists	(	System::String	parentFolderUri,
		System::String	folderName
	)

Checks whether the specified folder exists.

Parameters

parentFolderUri	An uri of parent folder.
folderName	A folder name.

Exceptions

AsposeArgumentException parentFolderUri or folderName is null or empty

Returns: true if the specified folder exists in the specified parent folder; otherwise, false.

◆ FolderExists() [2/2]

bool Aspose::Email::Clients::Exchange::Dav::ExchangeClient::FolderExists	(	System::String	parentFolderUri,
		System::String	folderName,
		System::SharedPtr< ExchangeFolderInfo > &	folder
	)

Checks whether the specified folder exists.

Parameters

parentFolderUri	An uri of parent folder.
folderName	A folder name.
folder	A ExchangeFolderInfo that represents the found folder information, if folder exists.

Exceptions

AsposeArgumentException parentFolderUri or folderName is null or empty

Returns: true if the specified folder exists in the specified parent folder; otherwise, false.

◆ get_ClientCertificate()

System::SharedPtr<System::Security::Cryptography::X509Certificates::X509Certificate> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::get_ClientCertificate ( ) const

Gets the client certificate.

◆ get_CookieContainer()

System::SharedPtr<System::Net::CookieContainer> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::get_CookieContainer ( ) const

Gets the cookie container.

The cookie container.

◆ get_Encoding()

System::SharedPtr<System::Text::Encoding> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::get_Encoding ( ) const

Gets the encoding.

◆ get_KeepAlive()

bool Aspose::Email::Clients::Exchange::Dav::ExchangeClient::get_KeepAlive ( ) const

Indicates whether to keep alive.

◆ get_MailboxInfo()

System::SharedPtr<ExchangeMailboxInfo> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::get_MailboxInfo ( )

Gets the mailbox information.

◆ get_PreAuthenticate()

bool Aspose::Email::Clients::Exchange::Dav::ExchangeClient::get_PreAuthenticate ( ) const

Indicates whether to do pre-authentication.

◆ get_SendChunked()

bool Aspose::Email::Clients::Exchange::Dav::ExchangeClient::get_SendChunked ( ) const

Gets a value indicating whether [send chunked].

true if [send chunked]; otherwise, false.

◆ GetContacts()

System::ArrayPtr<System::SharedPtr<Aspose::Email::PersonalInfo::Contact> > Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetContacts ( System::String folderUri )

Lists contacts located in the specified folder on server

Parameters

folderUri The URI of folder

Returns: An array of read Contact that represents contact information

◆ GetCustomProperties()

System::ArrayPtr<System::SharedPtr<CustomExchangeStoreProperty> > Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetCustomProperties ( System::String address )

Gets custom properties of the specified object on the server

Parameters

address The uri.

Returns: An array of CustomExchangeStoreProperty received from server.

◆ GetFolderInfo()

System::SharedPtr<ExchangeFolderInfo> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetFolderInfo ( System::String folderUri )

Gets the folder information.

Parameters

folderUri A folder uri.

Exceptions

AsposeArgumentException	folderUri is `null` or `empty`.
ExchangeException	Server responded an error message.

Returns: A ExchangeFolderInfo that represents the folder information.

◆ GetMailboxes()

System::ArrayPtr<System::SharedPtr<Aspose::Email::PersonalInfo::Contact> > Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetMailboxes ( )

Lists mailboxes in the global address list.

Returns: An array of Contact objects.

◆ GetMailboxInfo() [1/2]

System::SharedPtr<ExchangeMailboxInfo> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetMailboxInfo ( )

Get the information of the mailbox

Returns: The information of the mailbox

◆ GetMailboxInfo() [2/2]

System::SharedPtr<ExchangeMailboxInfo> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetMailboxInfo ( System::String mailbox )

Gets the mailbox information

Parameters

mailbox A mailbox to read from. Note: if mailbox is set to null or empty the default mailbox will be used

Returns: ExchangeMailboxInfo that represents mailbox information

◆ GetMailboxSize() [1/2]

int64_t Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetMailboxSize ( )

Get the size of the maibox

Returns: The size of the mailbox

◆ GetMailboxSize() [2/2]

int64_t Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetMailboxSize ( System::String mailbox )

Get the size of the maibox

Parameters

mailbox A mailbox. Note: if it is set to null or empty the default mailbox will be used

Returns: The size of the mailbox

◆ GetMimeMessage()

System::SharedPtr<MailMessage> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetMimeMessage ( System::String messageUri )

◆ GetProperties()

System::ArrayPtr<System::SharedPtr<ExchangeStoreProperty> > Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetProperties	(	System::String	address,
		System::ArrayPtr< System::SharedPtr< ExchangeStorePropertyName >>	propertyName
	)

◆ GetVersionInfo()

System::String Aspose::Email::Clients::Exchange::Dav::ExchangeClient::GetVersionInfo ( )

Returns exchange server version info

Returns: Returns exchange server version info

◆ ListContacts()

System::ArrayPtr<System::SharedPtr<Aspose::Email::Mapi::MapiContact> > Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListContacts ( System::String folderUri )

Lists contacts located in the specified folder on server

Parameters

folderUri The URI of folder

Returns: An array of read MapiContact that represents contact information

◆ ListMailboxes()

System::SharedPtr<Aspose::Email::Mapi::MapiContactCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMailboxes ( )

Lists mailboxes in the global address list.

Returns: A MapiContactCollection that represents contact information.

◆ ListMessages() [1/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages ( System::String folder )

Lists the messages.

Parameters

folder The folder.

Returns: A ExchangeMessageInfoCollection

◆ ListMessages() [2/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages	(	System::String	folder,
		bool	recursive
	)

List the messages in the specified folder

Parameters

folder	The folder Uri
recursive	Indicates whether recursive listing or not.

Returns: A collection of message info

◆ ListMessages() [3/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages	(	System::String	folder,
		ExchangeListMessagesOptions	options
	)

Lists the mail message in the specified folder.

Parameters

folder	The folder url
options	Specifies the settings of listing

Returns: A ExchangeMessageInfoCollection collection.

◆ ListMessages() [4/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages	(	System::String	folder,
		int32_t	maxNumberOfMessages
	)

Lists the messages.

Parameters

folder	The folder.
maxNumberOfMessages	Maximum number of messages

Returns: A ExchangeMessageInfoCollection

◆ ListMessages() [5/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages	(	System::String	folder,
		int32_t	maxNumberOfMessages,
		ExchangeListMessagesOptions	options
	)

List the messages in the specified folder

Parameters

folder	The folder Uri
maxNumberOfMessages	Maximum number of messages
options	Specifies the settings of listing

Returns: A collection of message info

◆ ListMessages() [6/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages	(	System::String	folder,
		System::SharedPtr< Aspose::Email::Tools::Search::MailQuery >	query,
		bool	recursive
	)

Lists the messages.

Parameters

folder	The Uri of folder that contains messages.
query	The MailQuery that represents search criteria.
recursive	Indicates whether recursive listing or not.

Returns: The message info collection.

◆ ListMessages() [7/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages	(	System::String	folder,
		System::String	messageClass,
		bool	recursive
	)

Lists the messages.

Parameters

folder	The folder.
messageClass	The message class.
recursive	if set to `true` [recursive].

Returns

◆ ListMessages() [8/8]

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessages	(	System::String	folder,
		System::String	query
	)

Lists the messages.

Parameters

folder	The folder.
query	The query.

Returns

◆ ListMessagesById()

System::SharedPtr<ExchangeMessageInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListMessagesById	(	System::String	folder,
		System::String	messageId
	)

Lists the messages by id.

Parameters

folder	The folder.
messageId	The message id.

Returns

◆ ListPublicFolders()

System::SharedPtr<ExchangeFolderInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListPublicFolders ( )

Gets collection of public folders from root public folder

Returns: ExchangeFolderInfoCollection that contains subfolders from the root public folder

◆ ListSubFolders() [1/2]

System::SharedPtr<ExchangeFolderInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListSubFolders ( System::SharedPtr< ExchangeFolderInfo > parentFolder )

Gets collection of child public folders from parent

Parameters

parentFolder The parent ExchangeFolderInfo

Returns: ExchangeFolderInfoCollection that contains subfolders from the parent folder

◆ ListSubFolders() [2/2]

System::SharedPtr<ExchangeFolderInfoCollection> Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ListSubFolders ( System::String parentFolderUri )

Gets collection of child folders from parent

Parameters

parentFolderUri The uri of the parent folder

Returns: ExchangeFolderInfoCollection that contains subfolders from the parent folder

Exceptions

AsposeArgumentException parentFolderUri is null or empty

◆ MoveItems() [1/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::MoveItems	(	System::String	destinationFolderUri,
		bool	overwrite,
		const System::ArrayPtr< System::String > &	itemsUriArray
	)

Moves items.

Parameters

destinationFolderUri	The new destination for items.
overwrite	Specifies whether the server should overwrite a existing message while processing a MOVE operation.
itemsUriArray	Items uri arrray

◆ MoveItems() [2/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::MoveItems	(	System::String	destinationFolderUri,
		const System::ArrayPtr< System::String > &	itemsUriArray
	)

Moves items.

Parameters

destinationFolderUri	The new destination for items.
itemsUriArray	Items uri arrray

◆ MoveMessage() [1/4]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::MoveMessage	(	System::SharedPtr< ExchangeMessageInfo >	msgInfo,
		System::String	destinationFolderUri
	)

Moves the message.

Parameters

msgInfo	Represents the E-Mail message info fetched from the Exchange Store.
destinationFolderUri	An URI of a destination folder.

◆ MoveMessage() [2/4]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::MoveMessage	(	System::SharedPtr< ExchangeMessageInfo >	msgInfo,
		System::String	destinationFolderUri,
		bool	overwrite
	)

Moves the message.

Parameters

msgInfo	Represents the E-Mail message info fetched from the Exchange Store.
destinationFolderUri	An URI of a destination folder.
overwrite	Specifies whether the server should overwrite a existing message while processing a MOVE operation.

◆ MoveMessage() [3/4]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::MoveMessage	(	System::String	destinationFolderUri,
		bool	overwrite,
		System::String	messageUri
	)

Moves the message.

Parameters

destinationFolderUri	An URI of a destination folder.
overwrite	Specifies whether the server should overwrite a existing message while processing a MOVE operation.
messageUri	Represents the uri of E-Mail message.

◆ MoveMessage() [4/4]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::MoveMessage	(	System::String	destinationFolderUri,
		System::String	messageUri
	)

Moves the message.

Parameters

destinationFolderUri	An URI of a destination folder.
messageUri	Represents the uri of E-Mail message.

◆ ParseQuery()

System::String Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ParseQuery ( System::SharedPtr< Aspose::Email::Tools::Search::MailQuery > query )

Parses the query.

Parameters

query The query.

Returns: Query string.

◆ ReadLong()

int64_t Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ReadLong ( System::SharedPtr< System::IO::Stream > input )

◆ ResolveContacts()

System::ArrayPtr<System::SharedPtr<Aspose::Email::PersonalInfo::Contact> > Aspose::Email::Clients::Exchange::Dav::ExchangeClient::ResolveContacts ( System::String unresolvedEntry )

Resolves ambiguous mailbox display names. Note: the maximum count of returned contacts is 100. This is a restriction of used exchange command.

Parameters

unresolvedEntry A name of contact to resolve.

Returns: An array of Contact objects.

◆ Restore() [1/6]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Restore	(	System::SharedPtr< Aspose::Email::Storage::Pst::PersonalStorage >	pst,
		Aspose::Email::Storage::Pst::RestoreOptions	options
	)

Restores exchange folders from the given personal storage.

Parameters

pst	A personal storage containing the backuped imap folders.
options	Restore options.

Exceptions

AsposeArgumentNullException pst is null.

◆ Restore() [2/6]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Restore	(	System::SharedPtr< Aspose::Email::Storage::Pst::PersonalStorage >	pst,
		System::SharedPtr< ExchangeFolderInfoCollection >	folders,
		Aspose::Email::Storage::Pst::RestoreOptions	options
	)

Restores the specified exchange folders from the given personal storage.

Parameters

pst	A personal storage containing the backuped exchange folders.
folders	A folders to be restored.
options	Restore options.

Exceptions

AsposeArgumentNullException pst or folders is null.

◆ Restore() [3/6]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Restore	(	System::SharedPtr< System::IO::Stream >	stream,
		Aspose::Email::Storage::Pst::RestoreOptions	options
	)

Restores exchange folders from the given personal storage.

Parameters

stream	A stream containing personal storage.
options	Restore options.

Exceptions

NotSupportedException	The stream does not support reading.
AsposeArgumentNullException	stream is `null`.

◆ Restore() [4/6]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Restore	(	System::SharedPtr< System::IO::Stream >	stream,
		System::SharedPtr< ExchangeFolderInfoCollection >	folders,
		Aspose::Email::Storage::Pst::RestoreOptions	options
	)

Restores the specified exchange folders from the given personal storage.

Parameters

stream	A stream containing personal storage.
folders	A folders to be restored.
options	Restore options.

Exceptions

NotSupportedException	The stream does not support reading.
AsposeArgumentNullException	stream or folders is `null`.

◆ Restore() [5/6]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Restore	(	System::String	fileName,
		Aspose::Email::Storage::Pst::RestoreOptions	options
	)

Restores exchange folders from the specified personal storage file.

Parameters

fileName	A path to personal storage file.
options	Restore options.

Exceptions

AsposeArgumentException fileName is not specified.

◆ Restore() [6/6]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Restore	(	System::String	fileName,
		System::SharedPtr< ExchangeFolderInfoCollection >	folders,
		Aspose::Email::Storage::Pst::RestoreOptions	options
	)

Restores the specified exchange folders from the specified personal storage file.

Parameters

fileName	A path to personal storage file.
folders	A folders to be restored.
options	Restore options.

Exceptions

AsposeArgumentException	fileName is not specified.
AsposeArgumentNullException	folders is `null`.

◆ SaveMessage() [1/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::SaveMessage	(	System::String	messageUri,
		System::SharedPtr< System::IO::Stream >	stream
	)

Saves the message.

Parameters

messageUri	The message URI.
stream	The stream.

◆ SaveMessage() [2/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::SaveMessage	(	System::String	messageUri,
		System::String	path
	)

Saves mail message specified by the uri to local file system. The mail message file is RFC 822 compliant format (EML).

if you want to parse the mail message files, use MailMessage.

Parameters

messageUri	The Uri of the mail message
path	The target path to save the message

◆ Send()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::Send ( System::SharedPtr< MailMessage > message )

Sends the mail message.

Parameters

message The mail message to be sent.

◆ set_ClientCertificate()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::set_ClientCertificate ( System::SharedPtr< System::Security::Cryptography::X509Certificates::X509Certificate > value )

Sets the client certificate.

◆ set_CookieContainer()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::set_CookieContainer ( System::SharedPtr< System::Net::CookieContainer > value )

Sets the cookie container.

The cookie container.

◆ set_Encoding()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::set_Encoding ( System::SharedPtr< System::Text::Encoding > value )

Sets the encoding.

◆ set_KeepAlive()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::set_KeepAlive ( bool value )

Indicates whether to keep alive.

◆ set_PreAuthenticate()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::set_PreAuthenticate ( bool value )

Indicates whether to do pre-authentication.

◆ set_SendChunked()

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::set_SendChunked ( bool value )

Sets a value indicating whether [send chunked].

true if [send chunked]; otherwise, false.

◆ SetReadFlag() [1/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::SetReadFlag ( System::String messageUri )

Marks the specifeid message as read.

Parameters

messageUri A message uri.

Exceptions

AsposeArgumentException messageUri is null or empty.

◆ SetReadFlag() [2/2]

void Aspose::Email::Clients::Exchange::Dav::ExchangeClient::SetReadFlag	(	System::String	messageUri,
		bool	suppressReceipt
	)

Marks the specifeid message as read.

Parameters

messageUri	A message uri.
suppressReceipt	A value indicating whether the sending a read receipt should be suppressed.

Exceptions

AsposeArgumentException messageUri is null or empty.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExchangeClient() [1/3]

◆ ExchangeClient() [2/3]

◆ ExchangeClient() [3/3]

Member Function Documentation

◆ AppendMessage() [1/2]

◆ AppendMessage() [2/2]

◆ Backup() [1/2]

◆ Backup() [2/2]

◆ CreateContact()

◆ CreateFolder()

◆ Decode()

◆ DeleteContact() [1/3]

◆ DeleteContact() [2/3]

◆ DeleteContact() [3/3]

◆ DeleteFolder()

◆ DeleteMessage() [1/2]

◆ DeleteMessage() [2/2]

◆ FetchAttachment()

◆ FetchMapiMessage()

◆ FetchMessage()

◆ FolderExists() [1/2]

◆ FolderExists() [2/2]

◆ get_ClientCertificate()

◆ get_CookieContainer()

◆ get_Encoding()

◆ get_KeepAlive()

◆ get_MailboxInfo()

◆ get_PreAuthenticate()

◆ get_SendChunked()

◆ GetContacts()

◆ GetCustomProperties()

◆ GetFolderInfo()

◆ GetMailboxes()

◆ GetMailboxInfo() [1/2]

◆ GetMailboxInfo() [2/2]

◆ GetMailboxSize() [1/2]

◆ GetMailboxSize() [2/2]

◆ GetMimeMessage()

◆ GetProperties()

◆ GetVersionInfo()

◆ ListContacts()

◆ ListMailboxes()

◆ ListMessages() [1/8]

◆ ListMessages() [2/8]

◆ ListMessages() [3/8]

◆ ListMessages() [4/8]

◆ ListMessages() [5/8]

◆ ListMessages() [6/8]

◆ ListMessages() [7/8]

◆ ListMessages() [8/8]

◆ ListMessagesById()

◆ ListPublicFolders()

◆ ListSubFolders() [1/2]

◆ ListSubFolders() [2/2]

◆ MoveItems() [1/2]

◆ MoveItems() [2/2]

◆ MoveMessage() [1/4]

◆ MoveMessage() [2/4]

◆ MoveMessage() [3/4]

◆ MoveMessage() [4/4]

◆ ParseQuery()

◆ ReadLong()

◆ ResolveContacts()

◆ Restore() [1/6]

◆ Restore() [2/6]

◆ Restore() [3/6]

◆ Restore() [4/6]

◆ Restore() [5/6]

◆ Restore() [6/6]

◆ SaveMessage() [1/2]

◆ SaveMessage() [2/2]

◆ Send()

◆ set_ClientCertificate()

◆ set_CookieContainer()

◆ set_Encoding()