public interface IEWSClient extends IExchangeClientBase
Represents the interface for Exchange client.
Modifier and Type | Method and Description |
---|---|
void |
addHeader(String name,
String value)
Adds name and value to WebHeaderCollection in EWS request.
|
void |
addToDistributionList(ExchangeDistributionList distributionList,
MailAddressCollection members)
Appends the members to Distribution List
|
String |
appendMessage(MailMessage message)
Uploads the mail message to the Inbox folder
|
String |
appendMessage(String folder,
MailMessage message)
Uploads the mail message to the specified folder
|
String |
appendMessage(String folder,
MailMessage message,
boolean markAsSent)
Deprecated.
|
String[] |
appendMessages(Iterable<MailMessage> messages)
Uploads the mail message to the specified folder
|
String[] |
appendMessages(MailMessage... messages)
Uploads the mail message to the specified folder
|
String[] |
appendMessages(String folder,
Iterable<MailMessage> messages)
Uploads the mail message to the specified folder
|
String[] |
appendMessages(String folder,
MailMessage... messages)
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 |
cancelAppointment(Appointment appointment)
Cancels appointment.
|
void |
cancelAppointment(Appointment appointment,
String folderUri)
Cancels appointment.
|
void |
cancelAppointment(String uniqueId)
Cancels an exiting meeting on an organizers calendar
|
void |
cancelAppointment(String uniqueId,
String folderUri)
Cancels an exiting meeting on an organizers calendar
|
ExchangeUserAvailabilityCollection |
checkUserAvailability(com.aspose.ms.System.Collections.Specialized.StringCollection users,
DateRange timeWindow)
Checks users availability within the specified time window.
|
ExchangeUserAvailability |
checkUserAvailability(String user,
DateRange timeWindow)
Checks user availability within the specified time window.
|
void |
closeAccess(ExchangeDelegateUserCollection delegateUsers,
String mailbox)
Closes access on the specified mailbox for the specified user.
|
void |
closeAccess(ExchangeDelegateUser delegateUser,
String mailbox)
Closes access on the specified mailbox for the specified user.
|
void |
closeAccess(ExchangeFolderUserInfo userInfo,
String mailbox)
Closes access on the specified mailbox for the specified user.
|
void |
closeAccess(String delegateSmtpAddress,
String mailbox)
Closes access on the specified mailbox for the specified user.
|
void |
copyConversationItems(String conversationId,
String destinationFolderId)
Copies the conversation items into the specified target folder
|
void |
copyConversationItems(String conversationId,
String contextFolderId,
String destinationFolderId)
Copies the conversation items, which are located in the specified folder, into the specified target folder
|
String |
copyItem(String itemUri,
String destinationFolderUri)
Copies the item to specified folder
|
String |
createAppointment(Appointment appointment)
Creates appointment.
|
String |
createAppointment(Appointment appointment,
String folderUri)
Creates appointment.
|
MapiMessage |
createCalendarSharingInvitationMessage(String recipient)
Create calendar sharing invitation message.
|
String |
createContact(Contact contact)
Creates a contact item in the Exchange store.
|
String |
createContact(MapiContact contact)
Deprecated.
|
String |
createDistributionList(ExchangeDistributionList distributionList,
MailAddressCollection members)
Creates the private Distribution List
|
ExchangeFolderInfo |
createFolder(String name)
Creates new folder in the root folder.
|
ExchangeFolderInfo |
createFolder(String name,
int folderType)
Creates new folder in the root folder.
|
ExchangeFolderInfo |
createFolder(String parentFolderUri,
String name)
Creates the new folder with the specified name in the specified parent folder.
|
ExchangeFolderInfo |
createFolder(String parentFolderUri,
String name,
ExchangeFolderPermissionCollection permissions)
Creates the new folder
|
ExchangeFolderInfo |
createFolder(String parentFolderUri,
String name,
ExchangeFolderPermissionCollection permissions,
String folderClass)
Creates the new folder
|
ExchangeFolderInfo |
createFolder(String parentFolderUri,
String name,
int folderType)
Creates the new folder
|
void |
createInboxRule(InboxRule rule)
Creates the specified inbox rule
|
void |
createInboxRule(InboxRule rule,
String mailbox)
Creates the specified inbox rule
|
ExchangeUploadItemResult[] |
createItems(ExchangeStreamedItem[] items,
String parentFolderUri)
Creates the specified items in the speciifed folder
|
ExchangeFolderInfo |
createPublicFolder(String name,
ExchangeFolderPermissionCollection permissions)
Creates the specified public folder in the root public folder
|
ExchangeFolderInfo |
createPublicFolder(String name,
ExchangeFolderPermissionCollection permissions,
int folderType)
Creates the specified public folder in the root public folder
|
ExchangeFolderInfo |
createPublicFolder(String parentFolderUri,
String name,
ExchangeFolderPermissionCollection permissions)
Creates the specified public folder in the root public folder
|
String |
createTask(ExchangeTask task) |
String |
createTask(String folder,
ExchangeTask task)
Creates the given task in the specified folder.
|
void |
createUserConfiguration(UserConfiguration userConfiguration)
Creates the specified user configuration
|
void |
delegateAccess(ExchangeDelegateUserCollection delegateUsers,
String mailbox)
Delegates access on the mailbox to the specified users.
|
void |
delegateAccess(ExchangeDelegateUser delegateUser,
String mailbox)
Delegates access on the specified mailbox to the specified user.
|
void |
delegateAccess(String delegateSmtpAddress,
int permissionLevel,
String mailbox)
Delegates access on the principal mailbox to the specified user.
|
void |
deleteContact(Contact contact)
Deletes the contact.
|
void |
deleteContact(Contact contact,
boolean deletePermanently)
Deletes the contact.
|
void |
deleteContact(MapiContact contact)
Deprecated.
|
void |
deleteContact(String id)
Deletes the contact.
|
void |
deleteContact(String id,
boolean deletePermanently)
Deletes the contact.
|
void |
deleteContacts(com.aspose.ms.System.Collections.Specialized.StringCollection contactIds)
Deletes the contacts.
|
void |
deleteContacts(com.aspose.ms.System.Collections.Specialized.StringCollection contactIds,
boolean deletePermanently)
Deletes the contacts.
|
void |
deleteConversationItems(String conversationId)
Deletes all items of the specified conversation
|
void |
deleteConversationItems(String conversationId,
String contextFolderId)
Deletes the conversation items, which are located in the specified folder
|
void |
deleteDistributionList(ExchangeDistributionList distributionList,
boolean deletePermanently)
Deletes the Distribution List
|
void |
deleteFolder(String folderUri)
Deletes the folder
|
void |
deleteFolder(String folderUri,
boolean deletePermanently)
Deletes the folder
|
void |
deleteFolders(ExchangeFolderInfoCollection folders)
Deletes the specified folders
|
void |
deleteFolders(ExchangeFolderInfoCollection folders,
boolean deletePermanently)
Deletes the specified folders
|
void |
deleteFolders(com.aspose.ms.System.Collections.Specialized.StringCollection folderUris)
Deletes the specified folders
|
void |
deleteFolders(com.aspose.ms.System.Collections.Specialized.StringCollection folderUris,
boolean deletePermanently)
Deletes the folder
|
void |
deleteFromDistributionList(ExchangeDistributionList distributionList,
MailAddressCollection members)
Deletes the members from Distribution List
|
void |
deleteInboxRule(String ruleId)
Deletes the specified inbox rule
|
void |
deleteInboxRule(String ruleId,
String mailbox)
Deletes the specified inbox rule
|
void |
deleteMessage(String messageUri)
Deletes the mail message.
|
void |
deleteMessage(String messageUri,
boolean deletePermanently)
Deletes the mail message
|
void |
deleteMessages(ExchangeMessageInfoCollection messages)
Deletes the specified mail messages
|
void |
deleteMessages(ExchangeMessageInfoCollection messages,
boolean deletePermanently)
Deletes the specified mail messages
|
void |
deleteMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris)
Deletes the specified mail messages
|
void |
deleteMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris,
boolean deletePermanently)
Deletes the specified mail messages
|
void |
deleteMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris,
boolean deletePermanently,
int options)
Deletes the specified mail messages
|
void |
deleteTask(String taskUri)
Deletes the specified task.
|
void |
deleteTask(String taskUri,
int options)
Deletes the specified task.
|
void |
deleteTasks(com.aspose.ms.System.Collections.Specialized.StringCollection taskUris,
int options)
Deletes the specified tasks.
|
void |
deleteUserConfiguration(UserConfigurationName userConfigurationName)
Deletes the specified user configuration
|
void |
disconnectPhoneCall(String callId)
Disconnects a phone call specified by id.
|
void |
emptyFolder(String folderUri)
Empties the specified folder.
|
void |
emptyFolder(String folderUri,
int options)
Empties the specified folder
|
MailAddressCollection |
expandDistributionList(MailAddress mailAddress)
Expands the public Distribution List members
|
ExchangeStreamedItem[] |
exportItems(String... itemIds)
Exports the specified items from mailbox
|
Appointment |
fetchAppointment(String appointmentUri)
Fetch the specified appointment from server.
|
Appointment |
fetchAppointment(String appointmentUri,
String folderUri)
Fetch the specified appointment from server.
|
Attachment |
fetchAttachment(String attachmentUri)
Fetches the attachment
|
MailAddressCollection |
fetchDistributionList(ExchangeDistributionList distributionList)
Fetches the private Distribution List members
|
com.aspose.ms.System.Collections.Generic.IGenericList<MapiCalendar> |
fetchMapiCalendar(Iterable<String> calendarUris)
Fetch array of MapiCalendar objects.
|
com.aspose.ms.System.Collections.Generic.IGenericList<MapiCalendar> |
fetchMapiCalendar(Iterable<String> calendarUris,
Iterable<PropertyDescriptor> customProperties)
Fetch array of MapiCalendar objects.
|
MailMessage |
fetchMessage(String messageUri)
Fetches the message.
|
MailMessage |
fetchMessage(String messageUri,
Iterable<PropertyDescriptor> extendedProperties)
Fetches the message from server
|
MailMessage |
fetchMessage(String messageUri,
String[] extendedProperties)
Deprecated.
|
MailMessageCollection |
fetchMessages(ExchangeMessageInfoCollection messageInfos)
Fetches the speciifed messages
|
MailMessageCollection |
fetchMessages(Iterable<String> uris)
Fetches the speciifed messages
|
MailMessageCollection |
fetchMessages(Iterable<String> uris,
Iterable<PropertyDescriptor> extendedProperties)
Fetches the speciifed messages
|
MailMessageCollection |
fetchMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris)
Fetches the speciifed messages
|
ExchangeTask |
fetchTask(String taskUri)
Fetches the specified task.
|
ExchangeConversation[] |
findConversations(String folderId)
Finds conversations in the specified folder
|
ExchangeMessageInfoCollection |
findMessages(String uri)
Deprecated.
|
MessageTrackingReportInfo[] |
findMessageTrackingReport(FindMessageTrackingReportOptions options)
Finds messages that meet the specified criteria.
|
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.
|
void |
forward(MailMessage message,
ExchangeMessageInfo referencedMessage)
Forward a message.
|
int |
getCalendarFolderEventFilter()
Specifies event types for Calendar folder
|
CallInformation |
getCallInfo(String callId)
Retrieves phone call information by call id
|
Contact |
getContact(ObjectIdentifier contactId)
Retrieves contact information according to specified identifier.
|
Contact |
getContact(ObjectIdentifier contactId,
int options)
Retrieves contact information according to specified identifier.
|
Contact |
getContact(String contactId)
Retrieves contact information according to specified identifier.
|
Contact |
getContact(String contactId,
int options)
Retrieves contact information according to specified identifier.
|
com.aspose.ms.System.Collections.Generic.IGenericList<String> |
getContactExtendedPropertiesDefinition()
Gets extended properties definition for contact object
|
Contact[] |
getContacts(String folder)
Lists contacts located in the specified folder on server
|
Contact[] |
getContacts(String folder,
int options)
Lists contacts located in the specified folder on server
|
int |
getContactsFolderEventFilter()
Specifies event types for Contacts folder
|
String |
getCurrentCalendarFolderUri()
Gets or sets current calendar folder uri
|
int |
getDeletedItemsFolderEventFilter()
Specifies event types for DeletedItems folder
|
int |
getDraftsFolderEventFilter()
Specifies event types for Drafts folder
|
boolean |
getEnableDecompression()
Gets or sets a value that indicates whether decompression is enabled
|
int |
getExchangeType()
Gets the information about the current version of MS Exchange.
|
ExchangeFolderInfo |
getFolderInfo(String folder)
Gets the folder information
|
ExchangePermissionCollection |
getFolderPermissions(String folderUrl)
Gets the folder permissions.
|
com.aspose.ms.System.Collections.Generic.List<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,String>> |
getHeaders()
Gets array of name value pairs wich are added to WebHeaderCollection in EWS request.
|
int |
getInboxFolderEventFilter()
Specifies event types for Inbox folder
|
InboxRule[] |
getInboxRules()
Gets inbox rules
|
InboxRule[] |
getInboxRules(String mailbox)
Gets inbox rules
|
int |
getJournalFolderEventFilter()
Specifies event types for Journal folder
|
String |
getLogFileName()
Gets or sets log file name
|
Contact[] |
getMailboxes()
Lists mailboxes having smtp addresses.
|
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)
Deprecated.
|
long |
getMailboxSizeEx(String folderUri)
Gets the size of the mailbox.
|
String |
getMailboxUri()
Gets or sets the mailbox uri.
|
MailTips[] |
getMailTips(GetMailTipsOptions options)
Gets mail tips
|
MessageTrackingReport |
getMessageTrackingReport(GetMessageTrackingReportOptions options)
Gets message tracking report
|
int |
getNotesFolderEventFilter()
Specifies event types for Notes folder
|
int |
getNotificationsCheckInterval()
Defines interval for notification check
|
int |
getNotificationTimeout()
Defines timeout for server notifications
|
int |
getOutboxFolderEventFilter()
Specifies event types for Outbox folder
|
int |
getRootFolderEventFilter()
Specifies event types for Root folder
|
int |
getSentItemsFolderEventFilter()
Specifies event types for SentItems folder
|
String[] |
getServerTimeZoneIds()
The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
|
String[] |
getServerTimeZoneIds(Iterable<String> timeZoneIds)
The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
|
String[] |
getServerTimeZoneIds(String... timeZoneIds)
The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
|
int |
getTasksFolderEventFilter()
Specifies event types for Tasks folder
|
String |
getTimezoneId()
Gets or sets timezone id
|
UnifiedMessagingConfiguration |
getUMConfiguration()
Retrieves unified messaging configuration
|
boolean |
getUseDateInLogFileName()
Gets or sets value which indicates if date has to be used in log file name.
|
UserConfiguration |
getUserConfiguration(UserConfigurationName userConfigurationName)
Gets the specified user configuration
|
boolean |
getUseSlashAsFolderSeparator()
Gets or sets value that determines whether the slash '/' is used as folder separator.
|
String |
getVersionInfo()
Returns exchange server version info
|
void |
impersonateUser(int valueType,
String value)
Impersonates the user.
|
Appointment[] |
listAppointments()
Retrieves list of appointments for default calendar folder
|
Appointment[] |
listAppointments(boolean recursive)
Retrieves list of appointments for default calendar folder
|
Appointment[] |
listAppointments(MailQuery query)
Retrieves list of appointments for default calendar folder
|
Appointment[] |
listAppointments(MailQuery query,
boolean recursive)
Retrieves list of appointments for default calendar folder
|
Appointment[] |
listAppointments(String folderUri)
Retrieves list of appointments for specified calendar folder
|
Appointment[] |
listAppointments(String folderUri,
boolean recursive)
Retrieves list of appointments for specified calendar folder
|
Appointment[] |
listAppointments(String folderUri,
MailQuery query)
Retrieves list of appointments for specified calendar folder
|
Appointment[] |
listAppointments(String folderUri,
MailQuery query,
boolean recursive)
Retrieves list of appointments for specified calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(int itemsPerPage)
Retrieves page with appointments for calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(int itemsPerPage,
int itemOffset)
Retrieves page with appointments for calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(MailQuery query,
int itemsPerPage)
Retrieves page with appointments for calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(MailQuery query,
int itemsPerPage,
int itemOffset)
Retrieves page with appointments for calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(String folderUri,
int itemsPerPage)
Retrieves page with appointments for specified calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(String folderUri,
int itemsPerPage,
int itemOffset)
Retrieves page with appointments for specified calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(String folderUri,
MailQuery query,
int itemsPerPage)
Retrieves page with appointments for specified calendar folder
|
AppointmentPageInfo |
listAppointmentsByPage(String folderUri,
MailQuery query,
int itemsPerPage,
int itemOffset)
Retrieves page with appointments for specified calendar folder
|
MapiContact[] |
listContacts(String folderUri)
Deprecated.
|
ExchangeDelegateUserCollection |
listDelegates(String mailbox)
Lists the users who are granted access on the specified mailbox.
|
ExchangeDistributionList[] |
listDistributionLists()
List the private Distribution Lists
|
String[] |
listItems(String folder)
Retrieve list of item uries in specified folder
|
String[] |
listItems(String folder,
MailQuery query)
Retrieve list of item uries in specified folder
|
String[] |
listItems(String folder,
MailQuery query,
boolean recursive)
Retrieve list of item uries in specified folder
|
MapiContactCollection |
listMailboxes()
Deprecated.
|
ExchangeMessageInfoCollection |
listMessages()
List the messages in the inbox folder.
|
ExchangeMessageInfoCollection |
listMessages(Iterable<String> iDs)
List the messages in the specified folder.
|
ExchangeMessageInfoCollection |
listMessages(String folder)
Lists the messages.
|
ExchangeMessageInfoCollection |
listMessages(String folder,
boolean recursive)
List the messages in the specified folder
|
ExchangeMessageInfoCollection |
listMessages(String folder,
int maxNumberOfMessages)
Lists the messages.
|
ExchangeMessageInfoCollection |
listMessages(String folder,
int options,
Iterable<String> extendedProperties)
Deprecated.
|
ExchangeMessageInfoCollection |
listMessages(String folder,
int maxNumberOfMessages,
MailQuery query)
List the messages in the specified folder.
|
ExchangeMessageInfoCollection |
listMessages(String folder,
int maxNumberOfMessages,
MailQuery query,
boolean recursive)
List the messages in the specified folder.
|
ExchangeMessageInfoCollection |
listMessages(String folder,
MailQuery query)
List the messages in the specified folder.
|
ExchangeMessageInfoCollection |
listMessages(String folder,
MailQuery query,
boolean recursive)
List the messages in the specified folder.
|
ExchangeMessageInfoCollection |
listMessagesByMaxNumberOfMessages(String folder,
int maxNumberOfMessages)
Lists the messages.
|
ExchangeMessageInfoCollection |
listMessagesByOption(String folder,
int options)
Lists the messages.
|
ExchangeMessageInfoCollection |
listMessagesByOption(String folder,
int maxNumberOfMessages,
int options)
Lists the messages.
|
ExchangeMessagePageInfo |
listMessagesByPage(String folder,
int itemsPerPage)
List the messages in the specified folder.
|
ExchangeMessagePageInfo |
listMessagesByPage(String folder,
int itemsPerPage,
int offset)
List the messages in the specified folder.
|
ExchangeMessagePageInfo |
listMessagesByPage(String folder,
int itemsPerPage,
int pageOffset,
int options)
List the messages in the specified folder.
|
ExchangeMessagePageInfo |
listMessagesByPage(String folder,
MailQuery query,
int itemsPerPage)
List the messages in the specified folder.
|
ExchangeMessagePageInfo |
listMessagesByPage(String folder,
MailQuery query,
int itemsPerPage,
int offset)
List the messages in the specified folder.
|
ExchangeMessagePageInfo |
listMessagesByPage(String folder,
PageInfo pageInfo)
List the messages in the specified folder.
|
ExchangeMessagePageInfo |
listMessagesByPage(String folder,
PageInfo pageInfo,
int options)
List the messages in the specified folder.
|
ExchangeMessageInfoCollection |
listMessagesByPropertyDescriptor(String folder,
int options,
Iterable<PropertyDescriptor> extendedProperties)
List the messages in the specified folder.
|
ExchangeMessageInfoCollection |
listMessagesFromPublicFolder(ExchangeFolderInfo folder)
Get collection of messages from public folder
|
ExchangeMessageInfoCollection |
listMessagesFromPublicFolder(String folderUri)
Get collection of messages from public folder
|
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
|
ExchangeFolderPageInfo |
listSubFoldersByPage(String parentFolderUri,
int itemsPerPage)
Searches the specified folder in the given parent folder with paging
Method supports paging.
|
ExchangeFolderPageInfo |
listSubFoldersByPage(String parentFolderUri,
int itemsPerPage,
int pageOffset)
Searches the specified folder in the given parent folder with paging
Method supports paging.
|
ExchangeFolderPageInfo |
listSubFoldersByPage(String parentFolderUri,
PageInfo page)
Searches the specified folder in the given parent folder with paging
Method supports paging.
|
TaskCollection |
listTasks()
Retrieves lists of exchange tasks for default folder.
|
TaskCollection |
listTasks(String folder)
Retrieves lists of exchange tasks.
|
TaskCollection |
listTasks(String folder,
int maxNumberOfItems)
Retrieves lists of exchange tasks.
|
TaskCollection |
listTasks(String folder,
int maxNumberOfItems,
MailQuery query)
Retrieves lists of exchange tasks.
|
TaskCollection |
listTasks(String folder,
int maxNumberOfItems,
MailQuery query,
boolean recursive)
Retrieves lists of exchange tasks.
|
TaskCollection |
listTasks(String folder,
MailQuery query)
Retrieves lists of exchange tasks.
|
void |
loadContactPhoto(ContactPhoto photo)
Loads contact photo binary data
|
void |
mailDisablePublicFolder(String folderUri)
Mail-disable a public folder
|
void |
mailEnablePublicFolder(String folderUri)
Mail-enable a public folder
|
void |
markAllItems(boolean read,
boolean suppressReadReceipts,
Iterable<String> folderIds)
Marks all items in specified folders.
|
void |
markAllItems(boolean read,
boolean suppressReadReceipts,
String... folderIds)
Marks all items in specified folders.
|
void |
markAllItems(boolean read,
String... folderIds)
Marks all items in specified folders.
|
void |
markAllItemsAsRead()
Marks all items in inbox folder as read without receipts.
|
void |
markAllItemsAsRead(Iterable<String> folderIds)
Marks all items in specified folders as read without receipts.
|
void |
markAllItemsAsRead(String... folderIds)
Marks all items in specified folders as read without receipts.
|
void |
markAllItemsAsUnread()
Marks all items in inbox folder as unread.
|
void |
markAllItemsAsUnread(Iterable<String> folderIds)
Marks all items in specified folders as unread.
|
void |
markAllItemsAsUnread(String... folderIds)
Marks all items in specified folders as unread.
|
String[] |
markAsJunk(boolean isJunk,
boolean moveItem,
Iterable<String> messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
|
void |
markAsJunk(boolean isJunk,
boolean moveItem,
Iterable<String> messageUriEn,
String[][] movedMessageIds,
String[][] failedMessageIds,
String[][] errorMessages)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
|
String[] |
markAsJunk(boolean isJunk,
boolean moveItem,
String... messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
|
String[] |
markAsJunk(boolean isJunk,
Iterable<String> messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
|
String[] |
markAsJunk(boolean isJunk,
String... messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
|
void |
moveConversationItems(String conversationId,
String destinationFolderId)
Moves the conversation items into the specified target folder
|
void |
moveConversationItems(String conversationId,
String contextFolderId,
String destinationFolderId)
Moves the conversation items, which are located in the specified folder, into the specified target folder
|
String |
moveItem(String itemUri,
String destinationFolderUri)
Moves the item to specified folder
|
String |
playOnPhone(String messageId,
String dialString)
The PlayOnPhone operation initiates an outbound call and plays a message over the telephone.
|
void |
removeHeader(String name)
Remove WebHeader from WebHeaderCollection in EWS request.
|
void |
reply(MailMessage message,
ExchangeMessageInfo referencedMessage)
Reply to the sender's message.
|
void |
replyAll(MailMessage message,
ExchangeMessageInfo referencedMessage)
Reply to the sender and all recipients of a message.
|
void |
resetImpersonation()
Makes the impersonation reset.
|
void |
resetSubscription()
Reset all subscriptions
|
MapiContactCollection |
resolveContact(String unresolvedEntry)
Deprecated.
|
Contact[] |
resolveContacts(String unresolvedEntry)
Resolves ambiguous mailbox display names.
|
Contact[] |
resolveContacts(String unresolvedEntry,
int options)
Resolves ambiguous e-mail addresses and display names
Note: the maximum count of returned contacts is 100.
|
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 |
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 |
send(MailMessage message,
FollowUpOptions messageOptions)
Sends the message.
|
void |
send(String from,
String to,
String subject,
String body)
Sends the specified message
|
void |
setCalendarFolderEventFilter(int value)
Specifies event types for Calendar folder
|
void |
setContactsFolderEventFilter(int value)
Specifies event types for Contacts folder
|
void |
setConversationReadState(String conversationId,
boolean isRead)
Set read state of the conversation items to the specified value
|
void |
setConversationReadState(String conversationId,
String contextFolderId,
boolean isRead)
Set read state of the conversation items, which are located in the specified folder, to the specified value
|
void |
setCurrentCalendarFolderUri(String value)
Gets or sets current calendar folder uri
|
void |
setDeletedItemsFolderEventFilter(int value)
Specifies event types for DeletedItems folder
|
void |
setDraftsFolderEventFilter(int value)
Specifies event types for Drafts folder
|
void |
setEnableDecompression(boolean value)
Gets or sets a value that indicates whether decompression is enabled
|
void |
setInboxFolderEventFilter(int value)
Specifies event types for Inbox folder
|
void |
setJournalFolderEventFilter(int value)
Specifies event types for Journal folder
|
void |
setLogFileName(String value)
Gets or sets log file name
|
void |
setMailboxUri(String value)
Gets or sets the mailbox uri.
|
void |
setNotesFolderEventFilter(int value)
Specifies event types for Notes folder
|
void |
setNotificationsCheckInterval(int value)
Defines interval for notification check
|
void |
setNotificationTimeout(int value)
Defines timeout for server notifications
|
void |
setOutboxFolderEventFilter(int value)
Specifies event types for Outbox folder
|
void |
setReadFlag(String messageUri)
Sets the read flag.
|
void |
setReadFlag(String messageUri,
boolean isRead)
Marks the specifeid message as read.
|
void |
setRootFolderEventFilter(int value)
Specifies event types for Root folder
|
void |
setSentItemsFolderEventFilter(int value)
Specifies event types for SentItems folder
|
void |
setTasksFolderEventFilter(int value)
Specifies event types for Tasks folder
|
void |
setTimezoneId(String value)
Gets or sets timezone id
|
void |
setUseDateInLogFileName(boolean value)
Gets or sets value which indicates if date has to be used in log file name.
|
void |
setUseSlashAsFolderSeparator(boolean value)
Gets or sets value that determines whether the slash '/' is used as folder separator.
|
SyncFolderResult |
syncFolder(String folderUri)
Retrieves changes of the items and subfolders in a specified folder.
|
SyncFolderResult |
syncFolder(String folderUri,
int syncType)
Retrieves changes of the items and subfolders in a specified folder.
|
SyncFolderResult |
syncFolder(String folder,
String syncState)
Retrieves changes of the items in a specified folder.
|
SyncFolderResult |
syncFolder(String folder,
String syncState,
Iterable<String> ignoreList)
Retrieves changes of the items in a specified folder.
|
SyncFolderResult |
syncFolder(SyncState syncState)
Retrieves changes of the items in a specified folder.
|
void |
updateAppointment(Appointment appointment)
Updates appointment.
|
void |
updateAppointment(Appointment appointment,
String folderUri)
Updates appointment.
|
void |
updateContact(Contact contact)
Updates a contact item in the Exchange store.
|
void |
updateDelegate(ExchangeDelegateUser delegateUser,
String mailbox)
Updates the delegate user settings who is granted access on the specified mailbox.
|
void |
updateDelegates(ExchangeDelegateUserCollection delegateUsers,
String mailbox)
Updates the delegate users settings who are granted access on the specified mailbox.
|
void |
updateInboxRule(InboxRule rule)
Updates the specified inbox rule
|
void |
updateInboxRule(InboxRule rule,
String mailbox)
Updates the specified inbox rule
|
ExchangeUploadItemResult[] |
updateItems(ExchangeStreamedItem[] items,
String parentFolderUri)
Updates the specified items in to a mailbox
|
void |
updateSubscription()
Updates subscriptions
|
void |
updateTask(ExchangeTask task)
Updates the specified task.
|
void |
updateTask(ExchangeTask task,
int options)
Updates the specified task.
|
void |
updateUserConfiguration(UserConfiguration userConfiguration)
Updates the specified user configuration
|
getCredentials, getProxy, getTimeout, setCredentials, setProxy, setTimeout
boolean getUseDateInLogFileName()
Gets or sets value which indicates if date has to be used in log file name.
void setUseDateInLogFileName(boolean value)
Gets or sets value which indicates if date has to be used in log file name.
String getLogFileName()
Gets or sets log file name
void setLogFileName(String value)
Gets or sets log file name
com.aspose.ms.System.Collections.Generic.IGenericList<String> getContactExtendedPropertiesDefinition()
Gets extended properties definition for contact object
void setTimezoneId(String value)
Gets or sets timezone id
value
- a String
object.String getCurrentCalendarFolderUri()
Gets or sets current calendar folder uri
String
object.void setCurrentCalendarFolderUri(String value)
Gets or sets current calendar folder uri
value
- a String
object.boolean getEnableDecompression()
Gets or sets a value that indicates whether decompression is enabled
void setEnableDecompression(boolean value)
Gets or sets a value that indicates whether decompression is enabled
value
- a boolean.boolean getUseSlashAsFolderSeparator()
Gets or sets value that determines whether the slash '/' is used as folder separator.
void setUseSlashAsFolderSeparator(boolean value)
Gets or sets value that determines whether the slash '/' is used as folder separator.
value
- a boolean.ExchangeMessageInfoCollection listMessages(String folder, boolean recursive)
List the messages in the specified folder
A
- folder to search messages in. String
object.Indicates
- whether recursive listing or not. boolean.ExchangeMessageInfoCollection
that contains messages from the specified folder.@Deprecated ExchangeMessageInfoCollection listMessages(String folder, int options, Iterable<String> extendedProperties)
List the messages in the specified folder.
A
- folder to search messages in. String
object.An
- options Specifies the settings of listing.An
- extendedProperties Extended properties of retrieved messages.ExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessageInfoCollection listMessagesByPropertyDescriptor(String folder, int options, Iterable<PropertyDescriptor> extendedProperties)
List the messages in the specified folder.
A
- folder to search messages in. String
object.An
- options Specifies the settings of listing.An
- extendedProperties Extended properties of retrieved messages.ExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessageInfoCollection listMessages(String folder, MailQuery query)
List the messages in the specified folder.
folder
- A folder to search messages in.query
- MailQuery
that represents message search criteria.ExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessageInfoCollection listMessages(String folder, MailQuery query, boolean recursive)
List the messages in the specified folder.
folder
- A folder to search messages in.query
- MailQuery
that represents message search criteria.recursive
- Indicates whether recursive listing or not.ExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessageInfoCollection listMessages(String folder, int maxNumberOfMessages, MailQuery query, boolean recursive)
List the messages in the specified folder.
folder
- A folder to search messages in.maxNumberOfMessages
- Maximum number of messages.query
- MailQuery
that represents message search criteria.recursive
- Indicates whether recursive listing or not.ExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessageInfoCollection listMessages(Iterable<String> iDs)
List the messages in the specified folder.
iDs
- Enumeration of message idsExchangeMessageInfoCollection
that contains messages with.ExchangeMessageInfoCollection listMessages()
List the messages in the inbox folder.
ExchangeMessageInfoCollection
from the inbox folder.ExchangeMessageInfoCollection listMessages(String folder, int maxNumberOfMessages, MailQuery query)
List the messages in the specified folder.
folder
- A folder to search messages in.maxNumberOfMessages
- Maximum number of messages.query
- MailQuery
that represents message search criteria.ExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessageInfoCollection listMessagesFromPublicFolder(String folderUri)
Get collection of messages from public folder
folderUri
- The uri of folderExchangeMessageInfoCollection
that contains messages from the specified folderExchangeMessageInfoCollection listMessagesFromPublicFolder(ExchangeFolderInfo folder)
Get collection of messages from public folder
folder
- ExchangeFolderInfo
that represents information about folderExchangeMessageInfoCollection
that contains messages from the specified folderString moveItem(String itemUri, String destinationFolderUri)
Moves the item to specified folder
itemUri
- The item URIdestinationFolderUri
- The destination folder URIvoid send(String from, String to, String subject, String body)
Sends the specified message
from
- From addressto
- To addresssubject
- The subject of messagebody
- The body of messagevoid send(MailMessage message, FollowUpOptions messageOptions)
Sends the message.
message
- The MailMessage
to be sent.messageOptions
- The FollowUpOptions
that represents additional options for using
follow-up flags and voting buttons.void deleteFolder(String folderUri, boolean deletePermanently)
Deletes the folder
folderUri
- The folder UrideletePermanently
- Indicates whether the folder should be deleted permanently or should be moved into DeletedItems foldervoid deleteMessage(String messageUri, boolean deletePermanently)
Deletes the mail message
messageUri
- The message urideletePermanently
- Indicates whether the specified message should be deleted permanently or should be moved into DeletedItems folder@Deprecated ExchangeMessageInfoCollection findMessages(String uri)
Gets the collection of messages from specified folder
uri
- The URI of folder
ExchangeMessageInfoCollection
that contains messages from the specified folderint getExchangeType()
Gets the information about the current version of MS Exchange.
void setReadFlag(String messageUri, boolean isRead)
Marks the specifeid message as read.
messageUri
- A message uri.isRead
- A value indicating whether the message was readArgumentException
- messageUri
is null
or empty
.MessageTrackingReportInfo[] findMessageTrackingReport(FindMessageTrackingReportOptions options)
Finds messages that meet the specified criteria.
options
- Options specifying a search criteriaMessageTrackingReportInfo
that represents message tracking report informationArgumentNullException
- throws when options
is null
MessageTrackingReport getMessageTrackingReport(GetMessageTrackingReportOptions options)
Gets message tracking report
options
- Options specifying a search criteriaMessageTrackingReport
or null
if no message tracking report was foundArgumentNullException
- throws when options
is null
MailTips[] getMailTips(GetMailTipsOptions options)
Gets mail tips
options
- Options specifying a search criteriaMailTips
ArgumentNullException
- throws when options
is null
void createUserConfiguration(UserConfiguration userConfiguration)
Creates the specified user configuration
userConfiguration
- UserConfiguration
to be createdArgumentNullException
- throws when userConfiguration
is null
void updateUserConfiguration(UserConfiguration userConfiguration)
Updates the specified user configuration
userConfiguration
- UserConfiguration
to updateArgumentNullException
- throws when userConfiguration
is null
UserConfiguration getUserConfiguration(UserConfigurationName userConfigurationName)
Gets the specified user configuration
userConfigurationName
- Specifies a user configuration to searchUserConfiguration
ArgumentNullException
- throws when userConfigurationName
is null
void deleteUserConfiguration(UserConfigurationName userConfigurationName)
Deletes the specified user configuration
userConfigurationName
- Specifies a user configuration to deleteArgumentNullException
- throws when userConfigurationName
is null
void createInboxRule(InboxRule rule)
Creates the specified inbox rule
rule
- A inbox rule to createArgumentNullException
- throws when rule
is null
void createInboxRule(InboxRule rule, String mailbox)
Creates the specified inbox rule
rule
- A inbox rule to createmailbox
- A mailbox to create rule for. Note: if it is set to null
or empty
, the rule will be created in the default mailboxArgumentNullException
- throws when rule
is null
void updateInboxRule(InboxRule rule)
Updates the specified inbox rule
rule
- A inbox rule to updateArgumentNullException
- throws when rule
is null
void updateInboxRule(InboxRule rule, String mailbox)
Updates the specified inbox rule
rule
- A inbox rule to updatemailbox
- A mailbox where rule is located. Note: if it is set to null
or empty
, the rule will be searched in the default mailboxArgumentNullException
- throws when rule
is null
void deleteInboxRule(String ruleId)
Deletes the specified inbox rule
ruleId
- An id of inbox rule to deleteArgumentException
- throws when ruleId
is null
or empty
void deleteInboxRule(String ruleId, String mailbox)
Deletes the specified inbox rule
ruleId
- An id of inbox rule to deletemailbox
- A mailbox where rule is located. Note: if it is set to null
or empty
, the rule will be searched in the default mailboxArgumentException
- throws when ruleId
is null
or empty
InboxRule[] getInboxRules()
Gets inbox rules
InboxRule
InboxRule[] getInboxRules(String mailbox)
Gets inbox rules
mailbox
- A mailbox to read inbox rule from. Note: if it is set to null
or empty
, the rules will be read from the default mailboxInboxRule
ExchangeStreamedItem[] exportItems(String... itemIds)
Exports the specified items from mailbox
itemIds
- Ids of itmes to be exportedExchangeStreamedItem
ArgumentNullException
- itemIds
is null
ArgumentException
- itemIds
is empty
ExchangeUploadItemResult[] updateItems(ExchangeStreamedItem[] items, String parentFolderUri)
Updates the specified items in to a mailbox
items
- An items to be updatedparentFolderUri
- Specifies the folder that contains the items to updateExchangeUploadItemResult
ArgumentNullException
- items
is null
ArgumentException
- items
is empty
ArgumentException
- parentFolderUri
is null
or empty
ExchangeUploadItemResult[] createItems(ExchangeStreamedItem[] items, String parentFolderUri)
Creates the specified items in the speciifed folder
items
- An items to be uploadedparentFolderUri
- Specifies the folder in which to place the itemsExchangeUploadItemResult
ArgumentNullException
- items
is null
ArgumentException
- items
is empty
ArgumentException
- parentFolderUri
is null
or empty
ExchangeConversation[] findConversations(String folderId)
Finds conversations in the specified folder
folderId
- An id of folder in which searchExchangeConversation
ArgumentException
- folderId
is null
or empty
void deleteConversationItems(String conversationId)
Deletes all items of the specified conversation
conversationId
- Id of conversation to deleteArgumentException
- conversationId
is null
or empty
void deleteConversationItems(String conversationId, String contextFolderId)
Deletes the conversation items, which are located in the specified folder
conversationId
- Id of conversation to deletecontextFolderId
- Id of folder in which delete conversation items. Note: If it's set to null(or empty), all conversation items will be deletedArgumentException
- conversationId
is null
or empty
void moveConversationItems(String conversationId, String destinationFolderId)
Moves the conversation items into the specified target folder
conversationId
- Id of conversation to deletedestinationFolderId
- Id of folder into which move itemsArgumentException
- conversationId
is null
or empty
ArgumentException
- destinationFolderId
is null
or empty
void moveConversationItems(String conversationId, String contextFolderId, String destinationFolderId)
Moves the conversation items, which are located in the specified folder, into the specified target folder
conversationId
- Id of conversation to movecontextFolderId
- Id of folder from which move conversation items. Note: If it's set to null(or empty), all conversation items will be moveddestinationFolderId
- Id of folder into which move itemsArgumentException
- conversationId
is null
or empty
ArgumentException
- destinationFolderId
is null
or empty
void copyConversationItems(String conversationId, String destinationFolderId)
Copies the conversation items into the specified target folder
conversationId
- Id of conversation to copydestinationFolderId
- Id of folder into which copy itemsArgumentException
- conversationId
is null
or empty
ArgumentException
- destinationFolderId
is null
or empty
void copyConversationItems(String conversationId, String contextFolderId, String destinationFolderId)
Copies the conversation items, which are located in the specified folder, into the specified target folder
conversationId
- Id of conversation to copycontextFolderId
- Id of folder in which conversation items are located. Note: If it's set to null(or empty), all conversation items will be copieddestinationFolderId
- Id of folder into which copy itemsArgumentException
- conversationId
is null
or empty
ArgumentException
- destinationFolderId
is null
or empty
void setConversationReadState(String conversationId, boolean isRead)
Set read state of the conversation items to the specified value
conversationId
- Id of conversation to be changedisRead
- A flag that enables setting the read state of items in a conversation.ArgumentException
- conversationId
is null
or empty
void setConversationReadState(String conversationId, String contextFolderId, boolean isRead)
Set read state of the conversation items, which are located in the specified folder, to the specified value
conversationId
- Id of conversation to be changedcontextFolderId
- Id of folder in which conversation items are located. Note: If it's set to null(or empty), all conversation items will be copiedisRead
- A flag that enables setting the read state of items in a conversation.ArgumentException
- conversationId
is null
or empty
String copyItem(String itemUri, String destinationFolderUri)
Copies the item to specified folder
itemUri
- The item URIdestinationFolderUri
- The destination folder URIArgumentException
- itemUri
is null
or empty
ArgumentException
- destinationFolderUri
is null
or empty
void emptyFolder(String folderUri)
Empties the specified folder. Subfolders will not be deleted; deleted items will be moved into DeletedItems folder
folderUri
- Specifies the folder to be emptyExchangeException
- EmptyFolder operation failedArgumentException
- folderUri
is null
or empty
void emptyFolder(String folderUri, int options)
Empties the specified folder
folderUri
- Specifies the folder to be emptyoptions
- Specifies the options of clearing folderExchangeException
- EmptyFolder operation failedArgumentException
- folderUri
is null
or empty
ExchangeFolderInfo createPublicFolder(String name, ExchangeFolderPermissionCollection permissions)
Creates the specified public folder in the root public folder
name
- A name of new folderpermissions
- A permission on new folderExchangeFolderInfo createPublicFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions)
Creates the specified public folder in the root public folder
parentFolderUri
- The URI of parent foldername
- A name of new folderpermissions
- A permission on new folderExchangeFolderInfo createPublicFolder(String name, ExchangeFolderPermissionCollection permissions, int folderType)
Creates the specified public folder in the root public folder
name
- A name of new folderpermissions
- A permission on new foldervoid mailEnablePublicFolder(String folderUri)
Mail-enable a public folder
folderUri
- A folder uriArgumentException
- folderUri
is null
or empty
void mailDisablePublicFolder(String folderUri)
Mail-disable a public folder
folderUri
- A folder uriArgumentException
- folderUri
is null
or empty
ExchangeFolderInfo getFolderInfo(String folder)
Gets the folder information
folder
- A folder uri or distinguished folder nameExchangeFolderInfo
that represents the folder informationArgumentException
- folder
is null
or empty
ExchangeException
- Server responded an error messagevoid impersonateUser(int valueType, String value)
Impersonates the user.
valueType
- The ItemChoiceType enumeration value to use for impersonation.value
- The item name.void resetImpersonation()
Makes the impersonation reset.
void delegateAccess(String delegateSmtpAddress, int permissionLevel, String mailbox)
Delegates access on the principal mailbox to the specified user.
delegateSmtpAddress
- A primary smtp address of user.permissionLevel
- A permission level that is granted to the user on all folders.mailbox
- A mailbox to grant access on.ArgumentException
- delegateSmtpAddress
or mailbox
is null
or empty
.void delegateAccess(ExchangeDelegateUser delegateUser, String mailbox)
Delegates access on the specified mailbox to the specified user.
delegateUser
- A ExchangeDelegateUser
containing user information and delegation settings.mailbox
- A mailbox to grant access on.ArgumentNullException
- delegateUser
is null.ArgumentException
- mailbox
is null
or empty
.void delegateAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox)
Delegates access on the mailbox to the specified users.
delegateUsers
- A ExchangeDelegateUserCollection
containing the users information and delegation settings.mailbox
- A mailbox to grant access on.ArgumentNullException
- delegateUsers
is null
.ArgumentException
- mailbox
is null
or empty
.ExchangeDelegateUserCollection listDelegates(String mailbox)
Lists the users who are granted access on the specified mailbox.
mailbox
- A mailbox.ExchangeDelegateUserCollection
representing the delegate users.ArgumentException
- mailbox
is null
or empty
.void updateDelegate(ExchangeDelegateUser delegateUser, String mailbox)
Updates the delegate user settings who is granted access on the specified mailbox.
delegateUser
- A new settings of delegate user.mailbox
- A mailbox on which the delegate user is granted access.ArgumentNullException
- delegateUser
is null
.ArgumentException
- mailbox
is null
or empty
.void updateDelegates(ExchangeDelegateUserCollection delegateUsers, String mailbox)
Updates the delegate users settings who are granted access on the specified mailbox.
delegateUsers
- A ExchangeDelegateUserCollection
containing the new settings of delegates.mailbox
- A mailbox on which the delegate users are granted access.ArgumentNullException
- delegateUsers
is null
.ArgumentException
- mailbox
is null
or empty
.void closeAccess(String delegateSmtpAddress, String mailbox)
Closes access on the specified mailbox for the specified user.
delegateSmtpAddress
- A primary smtp address of delegate user.mailbox
- A mailbox.ArgumentException
- delegateSmtpAddress
or mailbox
is null
or empty
.void closeAccess(ExchangeFolderUserInfo userInfo, String mailbox)
Closes access on the specified mailbox for the specified user.
userInfo
- A user information.mailbox
- A mailbox.ArgumentNullException
- userInfo
is null
.ArgumentException
- mailbox
is null
or empty
.void closeAccess(ExchangeDelegateUser delegateUser, String mailbox)
Closes access on the specified mailbox for the specified user.
delegateUser
- A delegate user.mailbox
- A mailbox.ArgumentNullException
- delegateUser
is null
.ArgumentException
- mailbox
is null
or empty
.void closeAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox)
Closes access on the specified mailbox for the specified user.
delegateUsers
- A delegate users.mailbox
- A mailbox.ArgumentNullException
- delegateUsers
is null
.ArgumentException
- mailbox
is null
or empty
.void deleteFolders(ExchangeFolderInfoCollection folders)
Deletes the specified folders
folders
- A ExchangeFolderInfoCollection
containing information about folders to deleteArgumentNullException
- folders
is null
void deleteFolders(com.aspose.ms.System.Collections.Specialized.StringCollection folderUris)
Deletes the specified folders
folderUris
- The folder urisArgumentNullException
- folderUris
is null
void deleteFolders(ExchangeFolderInfoCollection folders, boolean deletePermanently)
Deletes the specified folders
folders
- A ExchangeFolderInfoCollection
containing information about folders to deletedeletePermanently
- Indicates whether the folder should be deleted permanently or should be moved into DeletedItems folderArgumentNullException
- folders
is null
void deleteFolders(com.aspose.ms.System.Collections.Specialized.StringCollection folderUris, boolean deletePermanently)
Deletes the folder
folderUris
- The folder UrideletePermanently
- Indicates whether the folder should be deleted permanently or should be moved into DeletedItems folderArgumentNullException
- folderUris
is null
void deleteMessages(ExchangeMessageInfoCollection messages)
Deletes the specified mail messages
messages
- A ExchangeMessageInfoCollection
containing message informationsArgumentNullException
- messages
is null
void deleteMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris)
Deletes the specified mail messages
messageUris
- The message urisArgumentNullException
- messageUris
is null
void deleteMessages(ExchangeMessageInfoCollection messages, boolean deletePermanently)
Deletes the specified mail messages
messages
- A ExchangeMessageInfoCollection
containing message informationsdeletePermanently
- Indicates whether the specified message should be deleted permanently or should be moved into DeletedItems folderArgumentNullException
- messages
is null
void deleteMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris, boolean deletePermanently)
Deletes the specified mail messages
messageUris
- The message urisdeletePermanently
- Indicates whether the specified message should be deleted permanently or should be moved into DeletedItems folderArgumentNullException
- messageUris
is null
void deleteMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris, boolean deletePermanently, int options)
Deletes the specified mail messages
messageUris
- The message urisdeletePermanently
- Indicates whether the specified message should be deleted permanently or should be moved into DeletedItems folderoptions
- Describes how meeting requests and cancellations are handled.ArgumentNullException
- messageUris
is null
ExchangeUserAvailability checkUserAvailability(String user, DateRange timeWindow)
Checks user availability within the specified time window.
user
- An user smtp address.timeWindow
- A time span for the queried user's availability.ExchangeUserAvailability
containing user availability information.ArgumentException
- user
is null
or empty
.ArgumentNullException
- timeWindow
is null
.ExchangeUserAvailabilityCollection checkUserAvailability(com.aspose.ms.System.Collections.Specialized.StringCollection users, DateRange timeWindow)
Checks users availability within the specified time window.
users
- An users smtp addresses.timeWindow
- A time span for the queried user's availability.ExchangeUserAvailabilityCollection
containing the users availability informaiton.ArgumentNullException
- timeWindow
or users
is null
.Appointment fetchAppointment(String appointmentUri)
Fetch the specified appointment from server.
appointmentUri
- An uri of appointment to be fetched.Appointment
.ArgumentException
- appointmentUri
is null
or empty
.Appointment fetchAppointment(String appointmentUri, String folderUri)
Fetch the specified appointment from server.
appointmentUri
- An uri of appointment to be fetched.folderUri
- An uri of appointments parent folder.Appointment
.ArgumentException
- appointmentUri
is null
or empty
.ExchangeFolderInfo createFolder(String name)
Creates new folder in the root folder.
name
- The name of new folderExchangeFolderInfo createFolder(String parentFolderUri, String name)
Creates the new folder with the specified name in the specified parent folder.
parentFolderUri
- The URI of parent foldername
- The name of new folderArgumentException
- parentFolderUri
or name
is null
or empty
.ExchangeFolderInfo createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions)
Creates the new folder
parentFolderUri
- The URI of parent foldername
- The name of new folderpermissions
- A permission on new folderExchangeFolderInfo createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions, String folderClass)
Creates the new folder
parentFolderUri
- The URI of parent foldername
- The name of new folderpermissions
- A permission on new folderfolderClass
- The class of new folderExchangeFolderInfo createFolder(String name, int folderType)
Creates new folder in the root folder.
name
- The name of new folderfolderType
- Type of folderExchangeFolderInfo createFolder(String parentFolderUri, String name, int folderType)
Creates the new folder
parentFolderUri
- The URI of parent foldername
- The name of new folderfolderType
- Type of folderString createTask(ExchangeTask task)
String createTask(String folder, ExchangeTask task)
Creates the given task in the specified folder.
folder
- A folder where task should be created.task
- A task to create.
/// ArgumentException
- folder
is null
or empty
.ArgumentNullException
- task
is null
.ExchangeTask fetchTask(String taskUri)
Fetches the specified task.
taskUri
- A task uri.ExchangeTask
ArgumentException
- taskUri
is null
or empty
.void updateTask(ExchangeTask task)
Updates the specified task.
task
- An ExchangeTask
containing the task information.ArgumentException
- An UniqueUri property of task
is null
or empty
.ArgumentNullException
- task
is null
.void updateTask(ExchangeTask task, int options)
Updates the specified task.
task
- An ExchangeTask
containing the task information.options
- An updation options.ArgumentException
- An UniqueUri property of task
is null
or empty
.ArgumentNullException
- task
is null
.void deleteTask(String taskUri)
Deletes the specified task.
taskUri
- Uri of task to be deleted.ArgumentException
- taskUri
is null
or empty
.void deleteTask(String taskUri, int options)
Deletes the specified task.
taskUri
- Uri of task to be deleted.options
- A deletion options.ArgumentException
- taskUri
is null
or empty
.void deleteTasks(com.aspose.ms.System.Collections.Specialized.StringCollection taskUris, int options)
Deletes the specified tasks.
taskUri
- The Task uris.options
- A deletion options.ArgumentException
- taskUri
is null
or empty
.ExchangePermissionCollection getFolderPermissions(String folderUrl)
Gets the folder permissions.
folderUrl
- The folder URL.ExchangePermissionCollection
int getRootFolderEventFilter()
Specifies event types for Root folder
void setRootFolderEventFilter(int value)
Specifies event types for Root folder
value
- An event types for Root folderint getCalendarFolderEventFilter()
Specifies event types for Calendar folder
void setCalendarFolderEventFilter(int value)
Specifies event types for Calendar folder
value
- An event types for Calendar folderint getContactsFolderEventFilter()
Specifies event types for Contacts folder
void setContactsFolderEventFilter(int value)
Specifies event types for Contacts folder
value
- An event types for Contacts folderint getDeletedItemsFolderEventFilter()
Specifies event types for DeletedItems folder
void setDeletedItemsFolderEventFilter(int value)
Specifies event types for DeletedItems folder
value
- An event types for DeletedItems folderint getDraftsFolderEventFilter()
Specifies event types for Drafts folder
void setDraftsFolderEventFilter(int value)
Specifies event types for Drafts folder
value
- An event types for Drafts folderint getInboxFolderEventFilter()
Specifies event types for Inbox folder
void setInboxFolderEventFilter(int value)
Specifies event types for Inbox folder
value
- An event types for Inbox folderint getJournalFolderEventFilter()
Specifies event types for Journal folder
void setJournalFolderEventFilter(int value)
Specifies event types for Journal folder
value
- An event types for Journal folderint getNotesFolderEventFilter()
Specifies event types for Notes folder
void setNotesFolderEventFilter(int value)
Specifies event types for Notes folder
value
- An event types for Notes folderint getOutboxFolderEventFilter()
Specifies event types for Outbox folder
void setOutboxFolderEventFilter(int value)
Specifies event types for Outbox folder
value
- An event types for Outbox folderint getSentItemsFolderEventFilter()
Specifies event types for SentItems folder
void setSentItemsFolderEventFilter(int value)
Specifies event types for SentItems folder
value
- An event types for SentItems folderint getTasksFolderEventFilter()
Specifies event types for Tasks folder
void setTasksFolderEventFilter(int value)
Specifies event types for Tasks folder
value
- An event types for Tasks folderint getNotificationTimeout()
Defines timeout for server notifications
void setNotificationTimeout(int value)
Defines timeout for server notifications
value
- A timeout for server notificationsint getNotificationsCheckInterval()
Defines interval for notification check
void setNotificationsCheckInterval(int value)
Defines interval for notification check
value
- An interval for notification checkvoid updateSubscription()
Updates subscriptions
void resetSubscription()
Reset all subscriptions
Appointment[] listAppointments()
Retrieves list of appointments for default calendar folder
Appointment[] listAppointments(String folderUri)
Retrieves list of appointments for specified calendar folder
folderUri
- A folder to search appointments in.Appointment[] listAppointments(String folderUri, boolean recursive)
Retrieves list of appointments for specified calendar folder
folderUri
- A folder to search appointments in.recursive
- Indicates whether recursive listing or not.Appointment[] listAppointments(boolean recursive)
Retrieves list of appointments for default calendar folder
recursive
- Indicates whether recursive listing or not.Appointment[] listAppointments(MailQuery query)
Retrieves list of appointments for default calendar folder
query
- MailQuery
that represents appointments search criteria.Appointment[] listAppointments(String folderUri, MailQuery query)
Retrieves list of appointments for specified calendar folder
folderUri
- A folder to search appointments in.query
- MailQuery
that represents appointments search criteria.Appointment[] listAppointments(MailQuery query, boolean recursive)
Retrieves list of appointments for default calendar folder
query
- MailQuery
that represents appointments search criteria.recursive
- Indicates whether recursive listing or not.Appointment[] listAppointments(String folderUri, MailQuery query, boolean recursive)
Retrieves list of appointments for specified calendar folder
folderUri
- A folder to search appointments in.query
- MailQuery
that represents appointments search criteria.recursive
- Indicates whether recursive listing or not.String createAppointment(Appointment appointment)
Creates appointment.
appointment
- Calendar appointment.String createAppointment(Appointment appointment, String folderUri)
Creates appointment.
appointment
- Calendar appointment.folderUri
- An uri of appointments parent folder.void updateAppointment(Appointment appointment)
Updates appointment.
appointment
- Calendar appointment.void updateAppointment(Appointment appointment, String folderUri)
Updates appointment.
appointment
- Calendar appointment.folderUri
- An uri of appointments parent folder.void cancelAppointment(Appointment appointment)
Cancels appointment.
appointment
- Calendar appointment.void cancelAppointment(Appointment appointment, String folderUri)
Cancels appointment.
appointment
- Calendar appointment.folderUri
- An uri of appointments parent folder.void cancelAppointment(String uniqueId)
Cancels an exiting meeting on an organizers calendar
uniqueId
- Unique identifiervoid cancelAppointment(String uniqueId, String folderUri)
Cancels an exiting meeting on an organizers calendar
uniqueId
- Unique identifierfolderUri
- An uri of appointments parent folder.UnifiedMessagingConfiguration getUMConfiguration()
Retrieves unified messaging configuration
String playOnPhone(String messageId, String dialString)
The PlayOnPhone operation initiates an outbound call and plays a message over the telephone.
messageId
- Specifies message id.dialString
- Specifies telephone to play message.void disconnectPhoneCall(String callId)
Disconnects a phone call specified by id.
callId
- Phone call id.CallInformation getCallInfo(String callId)
Retrieves phone call information by call id
callId
- call idString[] getServerTimeZoneIds()
The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
String[] getServerTimeZoneIds(String... timeZoneIds)
The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
timeZoneIds
- Identifiers of time zones for checking existence on the server.String[] getServerTimeZoneIds(Iterable<String> timeZoneIds)
The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
timeZoneIds
- Identifiers of time zones for checking existence on the server.String[] markAsJunk(boolean isJunk, String... messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
isJunk
- Indicates, whether messages is marked as junk mail.
If value of true adds message sender to the block-list.
If value of false removes message sender from the block-list.messageUriEn
- Array of message uriString[] markAsJunk(boolean isJunk, boolean moveItem, String... messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
isJunk
- Indicates, whether messages is marked as junk mail.
If value of true adds message sender to the block-list.
If value of false removes message sender from the block-list.moveItem
- Indicates, whether messages is moved to the junk mail folder.messageUriEn
- Array of message uriString[] markAsJunk(boolean isJunk, Iterable<String> messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
isJunk
- Indicates, whether messages is marked as junk mail.
If value of true adds message sender to the block-list.
If value of false removes message sender from the block-list.messageUriEn
- Enumeration of message uriString[] markAsJunk(boolean isJunk, boolean moveItem, Iterable<String> messageUriEn)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
isJunk
- Indicates, whether messages is marked as junk mail.
If value of true adds message sender to the block-list.
If value of false removes message sender from the block-list.moveItem
- Indicates, whether messages is moved to the junk mail folder.messageUriEn
- Enumeration of message urivoid markAsJunk(boolean isJunk, boolean moveItem, Iterable<String> messageUriEn, String[][] movedMessageIds, String[][] failedMessageIds, String[][] errorMessages)
The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
isJunk
- Indicates, whether messages is marked as junk mail.
If value of true adds message sender to the block-list.
If value of false removes message sender from the block-list.moveItem
- Indicates, whether messages is moved to the junk mail folder.messageUriEn
- Enumeration of message urimovedMessageIds
- Returns the array of message ID which are moved to the junk mail folder.failedMessageIds
- Returns the array of message ID which haven't been moved to the junk mail folder.errorMessages
- Error messages for failed operationsvoid markAllItemsAsRead()
Marks all items in inbox folder as read without receipts.
void markAllItemsAsUnread()
Marks all items in inbox folder as unread.
void markAllItemsAsRead(String... folderIds)
Marks all items in specified folders as read without receipts.
folderIds
- List of folder uri for processing.void markAllItemsAsUnread(String... folderIds)
Marks all items in specified folders as unread.
folderIds
- List of folder uri for processing.void markAllItemsAsRead(Iterable<String> folderIds)
Marks all items in specified folders as read without receipts.
folderIds
- List of folder uri for processing.void markAllItemsAsUnread(Iterable<String> folderIds)
Marks all items in specified folders as unread.
folderIds
- List of folder uri for processing.void markAllItems(boolean read, String... folderIds)
Marks all items in specified folders.
read
- Sets the read/unread state to messages in specified folder.
True to mark messages in the folder as read. False to mark messages as unread.folderIds
- List of folder uri for processing.void markAllItems(boolean read, boolean suppressReadReceipts, String... folderIds)
Marks all items in specified folders.
read
- Sets the read/unread state to messages in specified folder.
True to mark messages in the folder as read. False to mark messages as unread.suppressReadReceipts
- True to suppress sending read receipts for messages; otherwise, false.folderIds
- List of folder uri for processing.void markAllItems(boolean read, boolean suppressReadReceipts, Iterable<String> folderIds)
Marks all items in specified folders.
read
- Sets the read/unread state to messages in specified folder.
True to mark messages in the folder as read. False to mark messages as unread.suppressReadReceipts
- True to suppress sending read receipts for messages; otherwise, false.folderIds
- List of folder uri for processing.void reply(MailMessage message, ExchangeMessageInfo referencedMessage)
Reply to the sender's message.
message
- The MailMessage
that represents the precomposed reply message.referencedMessage
- The ExchangeMessageInfo
that represents the original message.void replyAll(MailMessage message, ExchangeMessageInfo referencedMessage)
Reply to the sender and all recipients of a message.
message
- The MailMessage
that represents the precomposed reply message.referencedMessage
- The ExchangeMessageInfo
that represents the original message.void forward(MailMessage message, ExchangeMessageInfo referencedMessage)
Forward a message.
message
- The MailMessage
that represents the precomposed forward message.referencedMessage
- The ExchangeMessageInfo
that represents the original message.void deleteContacts(com.aspose.ms.System.Collections.Specialized.StringCollection contactIds)
Deletes the contacts.
contactIds
- The contact identifiers.void deleteContacts(com.aspose.ms.System.Collections.Specialized.StringCollection contactIds, boolean deletePermanently)
Deletes the contacts.
contactIds
- The contact identifiers.deletePermanently
- Indicates whether the specified contact should be deleted permanently or should be moved into DeletedItems foldervoid deleteContact(String id, boolean deletePermanently)
Deletes the contact.
id
- The contact identifier.deletePermanently
- Indicates whether the specified contact should be deleted permanently or should be moved into DeletedItems foldervoid updateContact(Contact contact)
Updates a contact item in the Exchange store.
contact
- Contact itemContact getContact(ObjectIdentifier contactId)
Retrieves contact information according to specified identifier.
contactId
- The contact identifier.Contact getContact(ObjectIdentifier contactId, int options)
Retrieves contact information according to specified identifier.
An
- contactId The contact identifier.An
- options Settings for retrieving contact.Contact getContact(String contactId)
Retrieves contact information according to specified identifier.
An
- contactId The contact identifier.An
- options Settings for retrieving contact.Contact getContact(String contactId, int options)
Retrieves contact information according to specified identifier.
An
- contactId The contact identifier.An
- options Settings for retrieving contact.Contact[] getContacts(String folder, int options)
Lists contacts located in the specified folder on server
folder
- A folder to search contacts inoptions
- Enumerates the list contacts optionsContact
that represents contact informationContact[] getMailboxes()
Lists mailboxes having smtp addresses. Note: the maximum count of returned contacts is 100. This is a restriction of used EWS operation.
Contact[] resolveContacts(String unresolvedEntry, int options)
Resolves ambiguous e-mail addresses and display names Note: the maximum count of returned contacts is 100. This is a restriction of used EWS operation.
unresolvedEntry
- A name of contact to resolveoptions
- Enumerates the list contacts optionsArgumentException
- unresolvedEntry
is null
or empty
void deleteContact(Contact contact, boolean deletePermanently)
Deletes the contact.
contact
- ContactdeletePermanently
- Indicates whether the specified contact should be deleted permanently or should be moved into DeletedItems foldervoid loadContactPhoto(ContactPhoto photo)
Loads contact photo binary data
photo
- contact photoSyncFolderResult syncFolder(String folderUri)
Retrieves changes of the items and subfolders in a specified folder.
folderUri
- The folder uriSyncFolderResult syncFolder(String folderUri, int syncType)
Retrieves changes of the items and subfolders in a specified folder.
folderUri
- The folder urisyncType
- Folder synchronization type.SyncFolderResult syncFolder(SyncState syncState)
Retrieves changes of the items in a specified folder.
syncState
- The synchronization state.SyncFolderResult syncFolder(String folder, String syncState)
Retrieves changes of the items in a specified folder.
folder
- The folder urisyncState
- The optional synchronization state. Must be null for first synchronization.SyncFolderResult syncFolder(String folder, String syncState, Iterable<String> ignoreList)
Retrieves changes of the items in a specified folder.
folder
- The folder urisyncState
- The optional synchronization state. Must be null for first synchronization.ignoreList
- The optional list of item uris that should be ignored.com.aspose.ms.System.Collections.Generic.List<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,String>> getHeaders()
Gets array of name value pairs wich are added to WebHeaderCollection in EWS request.
void addHeader(String name, String value)
Adds name and value to WebHeaderCollection in EWS request.
name
- Header namevalue
- Header valuevoid removeHeader(String name)
Remove WebHeader from WebHeaderCollection in EWS request.
name
- Header nameString appendMessage(MailMessage message)
Uploads the mail message to the Inbox folder
message
- A message to upload@Deprecated String 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.String[] appendMessages(MailMessage... messages)
Uploads the mail message to the specified folder
messages
- A messages to uploadString[] appendMessages(Iterable<MailMessage> messages)
Uploads the mail message to the specified folder
messages
- A messages to uploadString[] appendMessages(String folder, MailMessage... messages)
Uploads the mail message to the specified folder
folder
- A folder to which message is uploadedmessages
- A messages to uploadString[] appendMessages(String folder, Iterable<MailMessage> messages)
Uploads the mail message to the specified folder
folder
- A folder to which message is uploadedmessages
- A messages to uploadString 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 createDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)
Creates the private Distribution List
distributionList
- A ExchangeDistributionList
containing information about Distribution List to createmembers
- A MailAddressCollection
containing the Distribution List mail addresses to createString
containing the Distribution List Idvoid addToDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)
Appends the members to Distribution List
distributionList
- A ExchangeDistributionList
containing information about Distribution List to updatemembers
- A MailAddressCollection
containing the mail addresses to add.void deleteFromDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)
Deletes the members from Distribution List
distributionList
- A ExchangeDistributionList
containing information about Distribution List to updatemembers
- A MailAddressCollection
containing the mail addresses to delete. The MailAddress
must contain id.void deleteDistributionList(ExchangeDistributionList distributionList, boolean deletePermanently)
Deletes the Distribution List
distributionList
- A ExchangeDistributionList
containing information about Distribution List to deletedeletePermanently
- Indicates whether the specified List should be deleted permanently or should be moved into DeletedItems folderExchangeDistributionList[] listDistributionLists()
List the private Distribution Lists
ExchangeDistributionList
that represents Distribution List informationMailAddressCollection fetchDistributionList(ExchangeDistributionList distributionList)
Fetches the private Distribution List members
distributionList
- A ExchangeDistributionList
containing information about Distribution List to fetchMailAddressCollection
that contains members from the specified private Distribution List.MailAddressCollection expandDistributionList(MailAddress mailAddress)
Expands the public Distribution List members
mailAddress
- A public mail address to expandMailAddressCollection
that contains members from the specified public Distribution List.MapiMessage createCalendarSharingInvitationMessage(String recipient)
Create calendar sharing invitation message.
A
- recipient's address.MapiMessage
that represents sharing invitation message.ExchangeFolderPageInfo listSubFoldersByPage(String parentFolderUri, PageInfo page)
Searches the specified folder in the given parent folder with paging Method supports paging.
parentFolderUri
- A parent folder URIpage
- A page infoExchangeFolderPageInfo
containing the found folder if folder name is specified; otherwise, returns all subfoldersExchangeFolderPageInfo listSubFoldersByPage(String parentFolderUri, int itemsPerPage)
Searches the specified folder in the given parent folder with paging Method supports paging. Invokes for the first time in paging cycle.
parentFolderUri
- A parent folder URIitemsPerPage
- A number of folders in pageExchangeFolderPageInfo
containing the found folder if folder name is specified; otherwise, returns all subfoldersExchangeFolderPageInfo listSubFoldersByPage(String parentFolderUri, int itemsPerPage, int pageOffset)
Searches the specified folder in the given parent folder with paging Method supports paging.
parentFolderUri
- A parent folder URIitemsPerPage
- A number of folders in pagepageOffset
- An offset of next item in viewExchangeFolderPageInfo
containing the found folder if folder name is specified; otherwise, returns all subfoldersAppointmentPageInfo listAppointmentsByPage(int itemsPerPage)
Retrieves page with appointments for calendar folder
itemsPerPage
- A number of items in pageAppointmentPageInfo listAppointmentsByPage(String folderUri, int itemsPerPage)
Retrieves page with appointments for specified calendar folder
folderUri
- A folder to search appointments in.itemsPerPage
- A number of items in pageAppointmentPageInfo listAppointmentsByPage(MailQuery query, int itemsPerPage)
Retrieves page with appointments for calendar folder
query
- MailQuery
that represents appointments search criteria.itemsPerPage
- A number of items in pageAppointmentPageInfo listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage)
Retrieves page with appointments for specified calendar folder
folderUri
- A folder to search appointments in.query
- MailQuery
that represents appointments search criteria.itemsPerPage
- A number of items in pageAppointmentPageInfo listAppointmentsByPage(int itemsPerPage, int itemOffset)
Retrieves page with appointments for calendar folder
itemsPerPage
- A number of items in pageitemOffset
- An offset of next item in viewAppointmentPageInfo listAppointmentsByPage(String folderUri, int itemsPerPage, int itemOffset)
Retrieves page with appointments for specified calendar folder
folderUri
- A folder to search appointments in.itemsPerPage
- A number of items in pageitemOffset
- An offset of next item in viewAppointmentPageInfo listAppointmentsByPage(MailQuery query, int itemsPerPage, int itemOffset)
Retrieves page with appointments for calendar folder
query
- MailQuery
that represents appointments search criteria.itemsPerPage
- A number of items in pageitemOffset
- An offset of next item in viewAppointmentPageInfo listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage, int itemOffset)
Retrieves page with appointments for specified calendar folder
folderUri
- A folder to search appointments in.query
- MailQuery
that represents appointments search criteria.itemsPerPage
- A number of items in pageitemOffset
- An offset of next item in viewExchangeMessagePageInfo listMessagesByPage(String folder, int itemsPerPage)
List the messages in the specified folder.
folder
- A folder to search messages in.itemsPerPage
- A number of items in pageExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessagePageInfo listMessagesByPage(String folder, MailQuery query, int itemsPerPage)
List the messages in the specified folder.
folder
- A folder to search messages in.query
- MailQuery
that represents search criteria.itemsPerPage
- A number of items in pageExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessagePageInfo listMessagesByPage(String folder, int itemsPerPage, int offset)
List the messages in the specified folder.
folder
- A folder to search messages in.itemsPerPage
- A number of items in pageoffset
- An offset of next page in viewExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessagePageInfo listMessagesByPage(String folder, MailQuery query, int itemsPerPage, int offset)
List the messages in the specified folder.
folder
- A folder to search messages in.query
- MailQuery
that represents search criteria.itemsPerPage
- A number of items in pageoffset
- An offset of next page in viewExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessagePageInfo listMessagesByPage(String folder, int itemsPerPage, int pageOffset, int options)
List the messages in the specified folder.
folder
- A folder to search messages in.itemsPerPage
- A number of items in pagepageOffset
- An offset of next item in viewoptions
- Specifies the settings of listingExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessagePageInfo listMessagesByPage(String folder, PageInfo pageInfo)
List the messages in the specified folder.
folder
- A folder to search messages in.pageInfo
- A page infoExchangeMessageInfoCollection
that contains messages from the specified folder.ExchangeMessagePageInfo listMessagesByPage(String folder, PageInfo pageInfo, int options)
List the messages in the specified folder.
folder
- A folder to search messages in.pageInfo
- A page infooptions
- Specifies the settings of listingExchangeMessageInfoCollection
that contains messages from the specified folder.@Deprecated MailMessage fetchMessage(String messageUri, String[] extendedProperties)
Fetches the message from server
messageUri
- The URI of the messageextendedProperties
- An array of extended properties namesMailMessage
that represents e-mail message, if custom properties have been found and set you can access them using MailMessage.Headers
collection.ArgumentException
- messageUri
is null
or empty
ExchangeException
- Message can not be fetchedMailMessage fetchMessage(String messageUri, Iterable<PropertyDescriptor> extendedProperties)
Fetches the message from server
messageUri
- The URI of the messageextendedProperties
- An enumeration of extended propertiesMailMessage
that represents e-mail message, if custom properties have been found and set you can access them using MailMessage.Headers
collection.AsposeArgumentException
- messageUri
is null
or empty
ExchangeException
- Message can not be fetchedMailMessageCollection fetchMessages(Iterable<String> uris, Iterable<PropertyDescriptor> extendedProperties)
Fetches the speciifed messages
uris
- Containing message uris to be retrievedextendedProperties
- An enumeration of extended propertiesAsposeArgumentNullException
- uris
is null
or empty
MailMessageCollection fetchMessages(Iterable<String> uris)
Fetches the speciifed messages
messageUris
- An enumeration of message uris to be retrieved.MailMessageCollection
containing fetched messagesAsposeArgumentNullException
- messageUris
is null
MailMessageCollection fetchMessages(ExchangeMessageInfoCollection messageInfos)
Fetches the speciifed messages
messageInfos
- A ExchangeMessageInfoCollection
of messages to be retrievedMailMessageCollection
containing fetched messagesArgumentNullException
- messageInfos
is null
MailMessageCollection fetchMessages(com.aspose.ms.System.Collections.Specialized.StringCollection messageUris)
Fetches the speciifed messages
messageUris
- A StringCollection
containing message uris to be retrievedMailMessageCollection
containing fetched messagesArgumentNullException
- messageUris
is null
TaskCollection listTasks()
Retrieves lists of exchange tasks for default folder.
TaskCollection listTasks(String folder)
Retrieves lists of exchange tasks.
folder
- Tasks folderTaskCollection listTasks(String folder, MailQuery query)
Retrieves lists of exchange tasks.
folder
- Tasks folderquery
- Mail queryTaskCollection listTasks(String folder, int maxNumberOfItems)
Retrieves lists of exchange tasks.
folder
- Tasks foldermaxNumberOfItems
- Maximum number of itemsTaskCollection listTasks(String folder, int maxNumberOfItems, MailQuery query)
Retrieves lists of exchange tasks.
folder
- Tasks foldermaxNumberOfItems
- Maximum number of itemsquery
- Mail queryTaskCollection listTasks(String folder, int maxNumberOfItems, MailQuery query, boolean recursive)
Retrieves lists of exchange tasks.
folder
- Tasks foldermaxNumberOfItems
- Maximum number of itemsquery
- Mail queryrecursive
- Retrieve tasks recursivlyString[] listItems(String folder)
Retrieve list of item uries in specified folder
folder
- Folder to search itemsString[] listItems(String folder, MailQuery query)
Retrieve list of item uries in specified folder
folder
- Folder to search itemsquery
- Additional conditions to select itemsString[] listItems(String folder, MailQuery query, boolean recursive)
Retrieve list of item uries in specified folder
folder
- Folder to search itemsquery
- Additional conditions to select itemsrecursive
- Specifies whether request should be reqursive.com.aspose.ms.System.Collections.Generic.IGenericList<MapiCalendar> fetchMapiCalendar(Iterable<String> calendarUris)
Fetch array of MapiCalendar objects.
calendarUris
- List of calendar uris to be fetched.com.aspose.ms.System.Collections.Generic.IGenericList<MapiCalendar> fetchMapiCalendar(Iterable<String> calendarUris, Iterable<PropertyDescriptor> customProperties)
Fetch array of MapiCalendar objects.
calendarUris
- List of calendar uris to be fetched.customProperties
- Custom mapi properties to retrieve.String getMailboxUri()
Gets or sets the mailbox uri.
void setMailboxUri(String value)
Gets or sets the mailbox uri.
long getMailboxSize()
Gets the size of the mailbox. Please, note this operation is performed recursively for all subfolders and make take some time
long getMailboxSizeEx(String folderUri)
Gets the size of the mailbox. Please, note this operation is performed recursively for all subfolders and make take some time
folderUri
- Folder uri.@Deprecated long getMailboxSize(String mailbox)
Gets the size of the mailbox
mailbox
- A mailbox.ExchangeMailboxInfo getMailboxInfo()
Gets the mailbox info.
ExchangeMailboxInfo
that represents mailbox informationExchangeMailboxInfo 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 listMessages(String folder, int maxNumberOfMessages)
Lists the messages.
folder
- The folder.maxNumberOfMessages
- Maximum number of messagesExchangeMessageInfoCollection
ExchangeMessageInfoCollection listMessagesByMaxNumberOfMessages(String folder, int maxNumberOfMessages)
Lists the messages.
folder
- The folder.maxNumberOfMessages
- Maximum number of messagesExchangeMessageInfoCollection
ExchangeMessageInfoCollection listMessagesByOption(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 saveMessage(String messageUri, OutputStream stream)
Saves the message.
messageUri
- The message URI.stream
- The stream.void saveMessageInternal(String messageUri, com.aspose.ms.System.IO.Stream 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.ExchangeFolderInfoCollection 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 folderAttachment fetchAttachment(String attachmentUri)
Fetches the attachment
attachmentUri
- The attachment uriAttachment
that represents fetched attachmentvoid 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 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 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 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.String getVersionInfo()
Returns exchange server version info
@Deprecated String createContact(MapiContact contact)
Creates a contact item in the Exchange store.
contact
- Contact itemString createContact(Contact contact)
Creates a contact item in the Exchange store.
contact
- Contact item@Deprecated void deleteContact(MapiContact contact)
Deletes the contact.
contact
- Contact for deletingvoid deleteContact(String id)
Deletes the contact.
id
- The contact identifier.void deleteContact(Contact contact)
Deletes the contact.
contact
- Contact@Deprecated MapiContactCollection resolveContact(String unresolvedEntry)
Resolves ambiguous mailbox names.
unresolvedEntry
- A name of contact to resolve.MapiContactCollection
that represents contacts information.Contact[] resolveContacts(String unresolvedEntry)
Resolves ambiguous mailbox display names. Note: the maximum count of returned contacts is 100. This is a restriction of used exchange command.
unresolvedEntry
- A name of contact to resolve.Contact
objects.@Deprecated MapiContact[] listContacts(String folderUri)
Lists contacts located in the specified folder on server
folderUri
- The URI of folderMapiContact
that represents contact informationContact[] getContacts(String folder)
Lists contacts located in the specified folder on server
folder
- A folder to search contacts inContact
that represents contact information@Deprecated MapiContactCollection listMailboxes()
Lists mailboxes.
MapiContactCollection
that represents contact information.Copyright (c) 2008-2017 Aspose Pty Ltd. All Rights Reserved.