public interface IExchangeClientBase
extends com.aspose.ms.System.IDisposable
Represents the interface for base Exchange clients.
Modifier and Type | Method and Description |
---|---|
String |
appendMessage(String folder,
MailMessage message)
Uploads the mail message to the specified folder
|
String |
appendMessage(String folder,
MailMessage message,
boolean markAsSent)
Uploads the mail message to the specified folder
|
void |
backup(ExchangeFolderInfoCollection folders,
OutputStream stream,
int options)
Backups the content of the specified folders
|
void |
backup(ExchangeFolderInfoCollection folders,
String fileName,
int options)
Backups the content of the specified folders
|
void |
backupInternal(ExchangeFolderInfoCollection folders,
com.aspose.ms.System.IO.Stream stream,
int options)
Backups the content of the specified folders
|
String |
createContact(MapiContact contact)
Creates a contact item in the Exchange store.
|
ExchangeFolderInfo |
createFolder(String parentFolderUri,
String name)
Creates the new folder with the specified name in the specified parent folder.
|
void |
deleteContact(MapiContact contact)
Deletes the contact.
|
void |
deleteContact(String id)
Deletes the contact.
|
void |
deleteFolder(String folderUri)
Deletes the folder
|
void |
deleteMessage(String messageUri)
Deletes the mail message.
|
Attachment |
fetchAttachment(String attachmentUri)
Fetches the attachment
|
MailMessage |
fetchMessage(String messageUri)
Fetches the message.
|
boolean |
folderExists(String parentFolderUri,
String folderName)
Checks whether the specified folder exists.
|
boolean |
folderExists(String parentFolderUri,
String folderName,
ExchangeFolderInfo[] folder)
Checks whether the specified folder exists.
|
com.aspose.ms.System.Net.ICredentials |
getCredentials()
Gets or sets the credentials.
|
ExchangeMailboxInfo |
getMailboxInfo()
Gets the mailbox info.
|
ExchangeMailboxInfo |
getMailboxInfo(String mailbox)
Gets the mailbox information
|
long |
getMailboxSize()
Gets the size of the mailbox.
|
long |
getMailboxSize(String mailbox)
Gets the size of the mailbox
|
String |
getMailboxUri()
Gets or sets the mailbox uri.
|
com.aspose.ms.System.Net.WebProxy |
getProxy()
Gets or sets the proxy.
|
int |
getTimeout()
Gets or sets the number of milliseconds to wait before the operation times out.
|
String |
getVersionInfo()
Returns exchange server version info
|
MapiContact[] |
listContacts(String folderUri)
Lists contacts located in the specified folder on server
|
MapiContactCollection |
listMailboxes()
Lists mailboxes.
|
ExchangeMessageInfoCollection |
listMessages(String folder)
Lists the messages.
|
ExchangeMessageInfoCollection |
listMessages(String folder,
int maxNumberOfMessages,
int options)
Lists the messages.
|
ExchangeMessageInfoCollection |
listMessagesByMaxNumberOfMessages(String folder,
int maxNumberOfMessages)
Lists the messages.
|
ExchangeMessageInfoCollection |
listMessagesByOption(String folder,
int options)
Lists the messages.
|
ExchangeFolderInfoCollection |
listPublicFolders()
Gets collection of public folders from root public folder
|
ExchangeFolderInfoCollection |
listSubFolders(ExchangeFolderInfo parentFolder)
Gets collection of child public folders from parent
|
ExchangeFolderInfoCollection |
listSubFolders(String parentFolderUri)
Gets collection of child folders from parent
|
MapiContactCollection |
resolveContact(String unresolvedEntry)
Resolves ambiguous mailbox names.
|
void |
restore(InputStream stream,
ExchangeFolderInfoCollection folders,
int options)
Restores the specified exchange folders from the given personal storage.
|
void |
restore(InputStream stream,
int options)
Restores exchange folders from the given personal storage.
|
void |
restore(PersonalStorage pst,
ExchangeFolderInfoCollection folders,
int options)
Restores the specified exchange folders from the given personal storage.
|
void |
restore(PersonalStorage pst,
int options)
Restores exchange folders from the given personal storage.
|
void |
restore(String fileName,
ExchangeFolderInfoCollection folders,
int options)
Restores the specified exchange folders from the specified personal storage file.
|
void |
restore(String fileName,
int options)
Restores exchange folders from the specified personal storage file.
|
void |
restoreInternal(com.aspose.ms.System.IO.Stream stream,
ExchangeFolderInfoCollection folders,
int options)
Restores the specified exchange folders from the given personal storage.
|
void |
restoreInternal(com.aspose.ms.System.IO.Stream stream,
int options)
Restores exchange folders from the given personal storage.
|
void |
saveMessage(String messageUri,
OutputStream stream)
Saves the message.
|
void |
saveMessage(String messageUri,
String path)
Saves the message.
|
void |
saveMessageInternal(String messageUri,
com.aspose.ms.System.IO.Stream stream)
Saves the message.
|
void |
send(MailMessage message)
Sends the specified message.
|
void |
setCredentials(com.aspose.ms.System.Net.ICredentials value)
Gets or sets the credentials.
|
void |
setMailboxUri(String value)
Gets or sets the mailbox uri.
|
void |
setProxy(com.aspose.ms.System.Net.WebProxy value)
Gets or sets the proxy.
|
void |
setReadFlag(String messageUri)
Sets the read flag.
|
void |
setTimeout(int value)
Gets or sets the number of milliseconds to wait before the operation times out.
|
com.aspose.ms.System.Net.WebProxy getProxy()
Gets or sets the proxy.
void setProxy(com.aspose.ms.System.Net.WebProxy value)
Gets or sets the proxy.
int getTimeout()
Gets or sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).
void setTimeout(int value)
Gets or sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).
value
- A number of millisecondscom.aspose.ms.System.Net.ICredentials getCredentials()
Gets or sets the credentials.
void setCredentials(com.aspose.ms.System.Net.ICredentials value)
Gets or sets the credentials.
String getMailboxUri()
Gets or sets the mailbox uri.
void setMailboxUri(String value)
Gets or sets the mailbox uri.
ExchangeMailboxInfo getMailboxInfo()
Gets the mailbox info.
Value: The mailbox info.long getMailboxSize()
Gets the size of the mailbox.
long getMailboxSize(String mailbox)
Gets the size of the mailbox
mailbox
- A mailbox.ExchangeMailboxInfo getMailboxInfo(String mailbox)
Gets the mailbox information
mailbox
- A mailbox to read from.ExchangeMailboxInfo
that represents mailbox informationExchangeMessageInfoCollection listMessages(String folder)
Lists the messages.
folder
- The folder.ExchangeMessageInfoCollection
ExchangeMessageInfoCollection listMessagesByOption(String folder, int options)
Lists the messages.
folder
- The folder.options
- Specifies the settings of listingExchangeMessageInfoCollection
ExchangeMessageInfoCollection listMessagesByMaxNumberOfMessages(String folder, int maxNumberOfMessages)
Lists the messages.
folder
- The folder.maxNumberOfMessages
- Maximum number of messagesExchangeMessageInfoCollection
ExchangeMessageInfoCollection listMessages(String folder, int maxNumberOfMessages, int options)
Lists the messages.
folder
- The folder.maxNumberOfMessages
- Maximum number of messagesoptions
- Specifies the settings of listingExchangeMessageInfoCollection
void saveMessage(String messageUri, String path)
Saves the message.
messageUri
- The message URI.path
- The path to save message.void saveMessageInternal(String messageUri, com.aspose.ms.System.IO.Stream stream)
Saves the message.
messageUri
- The message URI.stream
- The stream.void saveMessage(String messageUri, OutputStream stream)
Saves the message.
messageUri
- The message URI.stream
- The stream.void send(MailMessage message)
Sends the specified message.
message
- The message.void setReadFlag(String messageUri)
Sets the read flag.
messageUri
- The message URI.MailMessage fetchMessage(String messageUri)
Fetches the message.
messageUri
- The message URI.void deleteMessage(String messageUri)
Deletes the mail message.
messageUri
- The message uri.void deleteContact(MapiContact contact)
Deletes the contact.
contact
- Contact for deletingvoid deleteContact(String id)
Deletes the contact.
id
- The contact identifier.MapiContact[] listContacts(String folderUri)
Lists contacts located in the specified folder on server
folderUri
- The URI of folderMapiContact
that represents contact informationExchangeFolderInfoCollection listPublicFolders()
Gets collection of public folders from root public folder
ExchangeFolderInfoCollection
that contains subfolders from the root public folderExchangeFolderInfoCollection listSubFolders(String parentFolderUri)
Gets collection of child folders from parent
parentFolderUri
- The uri of the parent folderExchangeFolderInfoCollection
that contains subfolders from the parent folderExchangeFolderInfoCollection listSubFolders(ExchangeFolderInfo parentFolder)
Gets collection of child public folders from parent
parentFolder
- The parent ExchangeFolderInfo
ExchangeFolderInfoCollection
that contains subfolders from the parent folderString appendMessage(String folder, MailMessage message)
Uploads the mail message to the specified folder
folder
- A folder to which message is uploadedmessage
- A message to uploadString appendMessage(String folder, MailMessage message, boolean markAsSent)
Uploads the mail message to the specified folder
folder
- An uri of folder to which message is uploadedmessage
- A message to uploadmarkAsSent
- A value indicating whether the message should be appended as a sent message or a draft.Attachment fetchAttachment(String attachmentUri)
Fetches the attachment
attachmentUri
- The attachment uriAttachment
that represents fetched attachmentExchangeFolderInfo createFolder(String parentFolderUri, String name)
Creates the new folder with the specified name in the specified parent folder.
parentFolderUri
- An uri of parent folder.name
- A name of folder to be created.ArgumentException
- parentFolderUri
or name
is null
or empty
.void deleteFolder(String folderUri)
Deletes the folder
folderUri
- The folder Uriboolean folderExists(String parentFolderUri, String folderName)
Checks whether the specified folder exists.
parentFolderUri
- An uri of parent folder.folderName
- A folder name.true
if the specified folder exists in the specified parent folder; otherwise, false
.ArgumentException
- parentFolderUri
or folderName
is null
or empty
boolean folderExists(String parentFolderUri, String folderName, ExchangeFolderInfo[] folder)
Checks whether the specified folder exists.
parentFolderUri
- An uri of parent folder.folderName
- A folder name.folder
- A ExchangeFolderInfo
that represents the found folder information, if folder exists.true
if the specified folder exists in the specified parent folder; otherwise, false
.void backup(ExchangeFolderInfoCollection folders, String fileName, int options)
Backups the content of the specified folders
folders
- A folders to backupfileName
- A path to the presonal storage fileoptions
- A backup optionsvoid backupInternal(ExchangeFolderInfoCollection folders, com.aspose.ms.System.IO.Stream stream, int options)
Backups the content of the specified folders
folders
- A folders to backupstream
- A stream to write intooptions
- A backup optionsvoid backup(ExchangeFolderInfoCollection folders, OutputStream stream, int options)
Backups the content of the specified folders
folders
- A folders to backupstream
- A stream to write intooptions
- A backup optionsvoid restore(String fileName, int options)
Restores exchange folders from the specified personal storage file.
fileName
- A path to personal storage file.options
- Restore options.void restoreInternal(com.aspose.ms.System.IO.Stream stream, int options)
Restores exchange folders from the given personal storage.
stream
- A stream containing personal storage.options
- Restore options.void restore(InputStream stream, int options)
Restores exchange folders from the given personal storage.
stream
- A stream containing personal storage.options
- Restore options.void restore(PersonalStorage pst, int options)
Restores exchange folders from the given personal storage.
pst
- A personal storage containing the backuped imap folders.options
- Restore options.void restore(String fileName, ExchangeFolderInfoCollection folders, int options)
Restores the specified exchange folders from the specified personal storage file.
fileName
- A path to personal storage file.folders
- A folders to be restored.options
- Restore options.void restoreInternal(com.aspose.ms.System.IO.Stream stream, ExchangeFolderInfoCollection folders, int options)
Restores the specified exchange folders from the given personal storage.
stream
- A stream containing personal storage.folders
- A folders to be restored.options
- Restore options.void restore(InputStream stream, ExchangeFolderInfoCollection folders, int options)
Restores the specified exchange folders from the given personal storage.
stream
- A stream containing personal storage.folders
- A folders to be restored.options
- Restore options.void restore(PersonalStorage pst, ExchangeFolderInfoCollection folders, int options)
Restores the specified exchange folders from the given personal storage.
pst
- A personal storage containing the backuped exchange folders.folders
- A folders to be restored.options
- Restore options.MapiContactCollection listMailboxes()
Lists mailboxes.
MapiContactCollection
that represents contact information.MapiContactCollection resolveContact(String unresolvedEntry)
Resolves ambiguous mailbox names.
unresolvedEntry
- A name of contact to resolve.MapiContactCollection
that represents contacts information.String createContact(MapiContact contact)
Creates a contact item in the Exchange store.
contact
- Contact itemString getVersionInfo()
Returns exchange server version info
Copyright (c) 2008-2016 Aspose Pty Ltd. All Rights Reserved.