Aspose::Email::Clients::Exchange::Dav::ExchangeClient Class Referencefinal

More...

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< ExchangeMailboxInfoget_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< ExchangeMailboxInfoGetMailboxInfo ()
 Get the information of the mailbox More...
 
System::String GetVersionInfo ()
 Returns exchange server version info More...
 
System::SharedPtr< ExchangeMailboxInfoGetMailboxInfo (System::String mailbox)
 Gets the mailbox information More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessages (System::String folder, System::String messageClass, bool recursive)
 Lists the messages. More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessages (System::String folder, bool recursive)
 List the messages in the specified folder More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessages (System::String folder, System::String query)
 Lists the messages. More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessages (System::String folder, System::SharedPtr< Aspose::Email::Tools::Search::MailQuery > query, bool recursive)
 Lists the messages. More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessagesById (System::String folder, System::String messageId)
 Lists the messages by id. More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessages (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< ExchangeFolderInfoCollectionListPublicFolders ()
 Gets collection of public folders from root public folder More...
 
System::SharedPtr< ExchangeFolderInfoCollectionListSubFolders (System::String parentFolderUri)
 Gets collection of child folders from parent More...
 
System::SharedPtr< MailMessageFetchMessage (System::String messageUri)
 Fetches the mail message with specified uri. More...
 
System::SharedPtr< Aspose::Email::Mapi::MapiMessageFetchMapiMessage (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< ExchangeMessageInfoCollectionListMessages (System::String folder, int32_t maxNumberOfMessages, ExchangeListMessagesOptions options)
 List the messages in the specified folder More...
 
System::SharedPtr< AttachmentFetchAttachment (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< ExchangeFolderInfoGetFolderInfo (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< MailMessageGetMimeMessage (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::MapiContactCollectionListMailboxes ()
 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< ExchangeFolderInfoCollectionListSubFolders (System::SharedPtr< ExchangeFolderInfo > parentFolder)
 Gets collection of child public folders from parent More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessages (System::String folder)
 Lists the messages. More...
 
System::SharedPtr< ExchangeMessageInfoCollectionListMessages (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::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::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
mailboxUriThe url of the mailbox
usernameThe username of the mailbox
passwordThe 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
mailboxUriThe url of the mailbox
usernameThe username of the mailbox
passwordThe password of the mailbox
domainThe 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
mailboxUriThe url of the mailbox
credentialsThe 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
folderA folder to which message is uploaded
messageA message to upload
Exceptions
AsposeArgumentExceptionA folder is not specified
AsposeArgumentNullExceptionmessage 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
folderAn uri of folder to which message is uploaded
messageA message to upload
markAsSentA value indicating whether the message should be appended as a sent message or a draft.
Exceptions
AsposeArgumentExceptionA folder is not specified
AsposeArgumentNullExceptionmessage 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
foldersA folders to backup
streamA stream to write into
optionsA backup options
Exceptions
NotSupportedExceptionThe given stream does not support writting
AsposeArgumentNullExceptionfolders 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
foldersA folders to backup
fileNameA path to the presonal storage file
optionsA backup options
Exceptions
AsposeArgumentExceptionA fileName is null or empty
AsposeArgumentNullExceptionfolders 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
contactContact 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
parentFolderUriAn uri of parent folder.
nameA name of folder to be created.
Exceptions
AsposeArgumentExceptionparentFolderUri 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
contactContact

◆ DeleteContact() [2/3]

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

Deletes the contact.

Parameters
contactContact

◆ DeleteContact() [3/3]

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

Deletes the contact.

Parameters
idThe contact identifier.

◆ DeleteFolder()

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

Deletes the folder

Parameters
folderUriThe folder Uri
Exceptions
AsposeArgumentExceptionfolderUri is null or empty

◆ DeleteMessage() [1/2]

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

Deletes the mail message.

Parameters
messageUriThe message uri.
Exceptions
AsposeArgumentExceptionmessageUri is empty.
AsposeArgumentNullExceptionmessageUri is null.

◆ DeleteMessage() [2/2]

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

Deletes the mail message.

Parameters
messageUriThe message uri.
suppressReceiptA value indicating whether the sending a non-read report should be suppressed.
Exceptions
AsposeArgumentExceptionmessageUri is empty.
AsposeArgumentNullExceptionmessageUri is null.

◆ FetchAttachment()

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

Fetches the attachment

Parameters
attachmentUriThe attachment uri. (Attachment uri can be retrieved using ListMessages(folder, ExchangeListMessagesOptions.FetchAttachmentInformation) method)
Exceptions
AsposeArgumentExceptionattachmentUri 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
messageUriThe message uri.
Returns
A MapiMessage object contains the message.
Exceptions
AsposeArgumentNullExceptionmessageUri is null
AsposeArgumentExceptionmessageUri 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
messageUriThe 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
parentFolderUriAn uri of parent folder.
folderNameA folder name.
Exceptions
AsposeArgumentExceptionparentFolderUri 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
parentFolderUriAn uri of parent folder.
folderNameA folder name.
folderA ExchangeFolderInfo that represents the found folder information, if folder exists.
Exceptions
AsposeArgumentExceptionparentFolderUri 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
folderUriThe 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
addressThe 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
folderUriA folder uri.
Exceptions
AsposeArgumentExceptionfolderUri is null or empty.
ExchangeExceptionServer 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
mailboxA 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
mailboxA 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
folderUriThe 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
folderThe 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
folderThe folder Uri
recursiveIndicates 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
folderThe folder url
optionsSpecifies 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
folderThe folder.
maxNumberOfMessagesMaximum 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
folderThe folder Uri
maxNumberOfMessagesMaximum number of messages
optionsSpecifies 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
folderThe Uri of folder that contains messages.
queryThe MailQuery that represents search criteria.
recursiveIndicates 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
folderThe folder.
messageClassThe message class.
recursiveif 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
folderThe folder.
queryThe 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
folderThe folder.
messageIdThe 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
parentFolderThe 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
parentFolderUriThe uri of the parent folder
Returns
ExchangeFolderInfoCollection that contains subfolders from the parent folder
Exceptions
AsposeArgumentExceptionparentFolderUri 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
destinationFolderUriThe new destination for items.
overwriteSpecifies whether the server should overwrite a existing message while processing a MOVE operation.
itemsUriArrayItems 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
destinationFolderUriThe new destination for items.
itemsUriArrayItems uri arrray

◆ MoveMessage() [1/4]

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

Moves the message.

Parameters
msgInfoRepresents the E-Mail message info fetched from the Exchange Store.
destinationFolderUriAn 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
msgInfoRepresents the E-Mail message info fetched from the Exchange Store.
destinationFolderUriAn URI of a destination folder.
overwriteSpecifies 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
destinationFolderUriAn URI of a destination folder.
overwriteSpecifies whether the server should overwrite a existing message while processing a MOVE operation.
messageUriRepresents 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
destinationFolderUriAn URI of a destination folder.
messageUriRepresents 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
queryThe 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
unresolvedEntryA 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
pstA personal storage containing the backuped imap folders.
optionsRestore options.
Exceptions
AsposeArgumentNullExceptionpst 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
pstA personal storage containing the backuped exchange folders.
foldersA folders to be restored.
optionsRestore options.
Exceptions
AsposeArgumentNullExceptionpst 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
streamA stream containing personal storage.
optionsRestore options.
Exceptions
NotSupportedExceptionThe stream does not support reading.
AsposeArgumentNullExceptionstream 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
streamA stream containing personal storage.
foldersA folders to be restored.
optionsRestore options.
Exceptions
NotSupportedExceptionThe stream does not support reading.
AsposeArgumentNullExceptionstream 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
fileNameA path to personal storage file.
optionsRestore options.
Exceptions
AsposeArgumentExceptionfileName 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
fileNameA path to personal storage file.
foldersA folders to be restored.
optionsRestore options.
Exceptions
AsposeArgumentExceptionfileName is not specified.
AsposeArgumentNullExceptionfolders 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
messageUriThe message URI.
streamThe 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
messageUriThe Uri of the mail message
pathThe target path to save the message

◆ Send()

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

Sends the mail message.

Parameters
messageThe 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
messageUriA message uri.
Exceptions
AsposeArgumentExceptionmessageUri 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
messageUriA message uri.
suppressReceiptA value indicating whether the sending a read receipt should be suppressed.
Exceptions
AsposeArgumentExceptionmessageUri is null or empty.