IEWSClient

All Implemented Interfaces: com.aspose.email.IExchangeClientBase

public interface IEWSClient extends IExchangeClientBase

Represents the interface for Exchange client.

Methods

Method Description
addHeader(String name, String value) Adds name and value to WebHeaderCollection in EWS request.
addToDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members) Appends the members to Distribution List.
appendMapiMessages(String folderUri, Iterable messages) Uploads the mapi messages to the specified folder
appendMessage(MailMessage message) Uploads the mail message to the Inbox folder
appendMessage(MapiMessage mapiMessage) Uploads the mail message to the specified folder
appendMessage(MapiMessage mapiMessage, boolean markAsSent) Uploads the mail message to the specified folder
appendMessage(String folderUri, MailMessage message) Uploads the mail message to the specified folder
appendMessage(String folderUri, MailMessage message, boolean markAsSent) Uploads the mail message to the specified folder
appendMessage(String folder, MapiMessage mapiMessage, boolean markAsSent) Uploads the mail message to the specified folder
appendMessages(MailMessage[] messages) Uploads the mail message to the specified folder
appendMessages(Iterable messages) Uploads the mail message to the specified folder
appendMessages(String folderUri, MailMessage[] messages) Uploads the mail message to the specified folder
appendMessages(String folderUri, Iterable messages) Uploads the mail message to the specified folder
archiveItem(String sourceFolderUri, Appointment appointment) The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.
archiveItem(String sourceFolderUri, ExchangeTask task) The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.
archiveItem(String sourceFolderUri, MapiMessageItemBase item) The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.
archiveItem(String sourceFolderUri, String uniqueId) The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.
backup(ExchangeFolderInfoCollection folders, OutputStream stream, int options) Backups the content of the specified folders
backup(ExchangeFolderInfoCollection folders, String fileName, int options) Backups the content of the specified folders
cancelAppointment(Appointment appointment) Cancels appointment.
cancelAppointment(Appointment appointment, String folderUri) Cancels appointment.
cancelAppointment(MapiCalendar appointment) Cancels appointment.
cancelAppointment(MapiCalendar appointment, String folderUri) Cancels appointment.
cancelAppointment(String uniqueId) Cancels an exiting meeting on an organizers calendar
cancelAppointment(String uniqueId, String folderUri) Cancels an exiting meeting on an organizers calendar
checkUserAvailability(System.Collections.Specialized.StringCollection users, DateRange timeWindow) Checks users availability within the specified time window.
checkUserAvailability(String user, DateRange timeWindow) Checks user availability within the specified time window.
closeAccess(ExchangeDelegateUser delegateUser, String mailbox) Closes access on the specified mailbox for the specified user.
closeAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox) Closes access on the specified mailbox for the specified user.
closeAccess(ExchangeFolderUserInfo userInfo, String mailbox) Closes access on the specified mailbox for the specified user.
closeAccess(String delegateSmtpAddress, String mailbox) Closes access on the specified mailbox for the specified user.
copyConversationItems(String conversationId, String destinationFolderId) Copies the conversation items into the specified target folder
copyConversationItems(String conversationId, String contextFolderId, String destinationFolderId) Copies the conversation items, which are located in the specified folder, into the specified target folder
copyItem(String itemUri, String destinationFolderUri) Copies the item to specified folder
createAppointment(Appointment appointment) Creates appointment.
createAppointment(Appointment appointment, String folderUri) Creates appointment.
createAppointment(MapiCalendar appointment) Creates appointment.
createAppointment(MapiCalendar appointment, String folderUri) Creates appointment.
createAppointment(MapiCalendar appointment, String folderUri, boolean suppressInvitations) Creates appointment.
createCalendarSharingInvitationMessage(String recipient) Create calendar sharing invitation message.
createContact(Contact contact) Creates a contact item in the Exchange store.
createContact(MapiContact contact) Creates a contact item in the Exchange store.
createContact(String folderUri, Contact contact) Creates a contact item in the specified folder.
createContact(String folderUri, MapiContact contact) Creates a contact item in the specified folder.
createDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members) Creates the private Distribution List.
createFolder(String name) Creates new folder in the root folder.
createFolder(String name, int folderType) Creates new folder in the root folder.
createFolder(String parentFolderUri, String name) Creates the new folder with the specified name in the specified parent folder.
createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions) Creates the new folder
createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions, String folderClass) Creates the new folder
createFolder(String parentFolderUri, String name, int folderType) Creates the new folder
createInboxRule(InboxRule rule) Creates the specified inbox rule
createInboxRule(InboxRule rule, String mailbox) Creates the specified inbox rule
createItem(MapiMessageItemBase item) Creates the given item in the default item folder.
createItem(String folderUri, MapiMessageItemBase item) Creates the given item in the specified folder.
createItems(ExchangeStreamedItem[] items, String parentFolderUri) Creates the specified items in the speciifed folder
createNote(MapiNote note) Creates the given note in the default note folder.
createNote(String folder, MapiNote note) Creates the given note in the specified folder.
createPublicFolder(String name, ExchangeFolderPermissionCollection permissions) Creates the specified public folder in the root public folder
createPublicFolder(String name, ExchangeFolderPermissionCollection permissions, int folderType) Creates the specified public folder in the root public folder
createPublicFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions) Creates the specified public folder in the root public folder
createTask(ExchangeTask task) Creates the given task in the default task folder.
createTask(MapiTask task) Creates the given task in the default task folder.
createTask(String folder, ExchangeTask task) Creates the given task in the specified folder.
createTask(String folder, MapiTask task) Creates the given task in the specified folder.
createUserConfiguration(UserConfiguration userConfiguration) Creates the specified user configuration
delegateAccess(ExchangeDelegateUser delegateUser, String mailbox) Delegates access on the specified mailbox to the specified user.
delegateAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox) Delegates access on the mailbox to the specified users.
delegateAccess(String delegateSmtpAddress, int permissionLevel, String mailbox) Delegates access on the principal mailbox to the specified user.
deleteConversationItems(String conversationId) Deletes all items of the specified conversation
deleteConversationItems(String conversationId, String contextFolderId) Deletes the conversation items, which are located in the specified folder
deleteDistributionList(ExchangeDistributionList distributionList, boolean deletePermanently) Deletes the Distribution List.
deleteFolder(String folderUri) Deletes the folder
deleteFolder(String folderUri, boolean deletePermanently) Deletes the folder
deleteFolders(ExchangeFolderInfoCollection folders) Deletes the specified folders
deleteFolders(ExchangeFolderInfoCollection folders, boolean deletePermanently) Deletes the specified folders
deleteFolders(System.Collections.Specialized.StringCollection folderUris) Deletes the specified folders
deleteFolders(System.Collections.Specialized.StringCollection folderUris, boolean deletePermanently) Deletes the folder
deleteFromDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members) Deletes the members from Distribution List.
deleteInboxRule(String ruleId) Deletes the specified inbox rule
deleteInboxRule(String ruleId, String mailbox) Deletes the specified inbox rule
deleteItem(String itemUri, DeletionOptions options) Deletes specified item
deleteItems(Iterable itemUris, DeletionOptions options) Deletes specified items
deleteUserConfiguration(UserConfigurationName userConfigurationName) Deletes the specified user configuration
disconnectPhoneCall(String callId) Disconnects a phone call specified by id.
emptyFolder(String folderUri) Empties the specified folder.
emptyFolder(String folderUri, int options) Empties the specified folder
expandDistributionList(MailAddress mailAddress) Expands the public Distribution List members.
exportItems(String[] itemIds) Exports the specified items from mailbox
fetchAppointment(String appointmentUri) Fetch the specified appointment from server.
fetchAppointment(String appointmentUri, String folderUri) Fetch the specified appointment from server.
fetchAttachment(String attachmentUri) Fetches the attachment
fetchContact(String contactUri) Fetches MapiContact object
fetchContact(String contactUri, Iterable customProperties) Fetches MapiContact object
fetchConversationMessages(String conversationId) Fetches the specified conversation messages
fetchDistributionList(ExchangeDistributionList distributionList) Fetches the private Distribution List members.
fetchItem(String uri) Retrieves the complete item with attachments.
fetchItem(String uri, Iterable extendedProperties) Retrieves the complete item with attachments.
fetchMapiCalendar(Iterable calendarUris) Fetch array of MapiCalendar objects.
fetchMapiCalendar(Iterable calendarUris, Iterable customProperties) Fetch array of MapiCalendar objects.
fetchMapiCalendar(String calendarUri) Fetch MapiCalendar object.
fetchMapiCalendar(String calendarUri, Iterable customProperties) Fetch MapiCalendar object.
fetchMapiMessage(String uri) Fetches the speciifed message
fetchMapiMessage(String uri, Iterable extendedProperties) Fetches the speciifed message
fetchMapiMessages(Iterable uris) Fetches the speciifed messages
fetchMapiMessages(Iterable uris, Iterable extendedProperties) Fetches the speciifed messages
fetchMapiNote(String noteUri) Fetches MapiNote object.
fetchMapiNote(String noteUri, Iterable customProperties) Fetches MapiNote object.
fetchMapiNotes(Iterable noteUris) Fetch array of MapiNote objects.
fetchMapiNotes(Iterable noteUris, Iterable customProperties) Fetch array of MapiNote objects.
fetchMapiTask(String taskUri) Fetches MapiTask object.
fetchMapiTask(String taskUri, Iterable customProperties) Fetches MapiTask object.
fetchMapiTasks(Iterable taskUris) Fetch array of MapiTask objects.
fetchMapiTasks(Iterable taskUris, Iterable customProperties) Fetch array of MapiTask objects.
fetchMessage(String messageUri) Fetches the message.
fetchMessage(String messageUri, Iterable extendedProperties) Fetches the message from server
fetchMessages(ExchangeMessageInfoCollection messageInfos) Fetches the speciifed messages
fetchMessages(System.Collections.Specialized.StringCollection messageUris) Fetches the speciifed messages
fetchMessages(Iterable uris) Fetches the speciifed messages
fetchMessages(Iterable uris, Iterable extendedProperties) Fetches the speciifed messages
fetchTask(String taskUri) Fetches the specified task.
findConversations(String folderId) Finds conversations in the specified folder
findMessageTrackingReport(FindMessageTrackingReportOptions options) Finds messages that meet the specified criteria.
findPeople(String folderUri, MailQuery query, int maxNumberOfItems) Find contacts located in the specified user’s personal mailbox on server.
findPeople(String queryString, int maxNumberOfItems) Find contacts located in the global address list (GAL) on server.
folderExists(String parentFolderUri, String folderName) Checks whether the specified folder exists.
folderExists(String parentFolderUri, String folderName, ExchangeFolderInfo[] folder) Checks whether the specified folder exists.
forward(MailMessage message, ExchangeMessageInfo referencedMessage) Forward a message.
forward(MailMessage message, String referencedUri) Forward a message.
getCalendarFolderEventFilter() Specifies event types for Calendar folder
getCallInfo(String callId) Retrieves phone call information by call id
getContact(ObjectIdentifier contactId) Retrieves contact information according to specified identifier.
getContact(ObjectIdentifier contactId, int options) Retrieves contact information according to specified identifier.
getContact(String contactId) Retrieves contact information according to specified identifier.
getContact(String contactId, int options) Retrieves contact information according to specified identifier.
getContacts(String folder) Lists contacts located in the specified folder on server
getContacts(String folder, int options) Lists contacts located in the specified folder on server
getContactsFolderEventFilter() Specifies event types for Contacts folder
getCurrentCalendarFolderUri() Gets or sets current calendar folder uri
getDeletedItemsFolderEventFilter() Specifies event types for DeletedItems folder
getDraftsFolderEventFilter() Specifies event types for Drafts folder
getEnableDecompression() Gets or sets a value that indicates whether decompression is enabled
getExchangeType() Gets the information about the current version of MS Exchange.
getFolderInfo(String folder) Gets the folder information
getFolderPermissions(String folderUrl) Gets the folder permissions.
getHeaders() Gets array of name value pairs wich are added to WebHeaderCollection in EWS request.
getInboxFolderEventFilter() Specifies event types for Inbox folder
getInboxRules() Gets inbox rules
getInboxRules(String mailbox) Gets inbox rules
getJournalFolderEventFilter() Specifies event types for Journal folder
getLogFileName() Gets or sets log file name
getMailTips(GetMailTipsOptions options) Gets mail tips
getMailboxInfo() Gets the mailbox info.
getMailboxInfo(String mailbox) Gets the mailbox information
getMailboxSize() Gets the size of the mailbox.
getMailboxSize(String mailbox) Gets the size of the mailbox
getMailboxSizeEx(String folderUri) Gets the size of the mailbox Please, note this operation is performed recursively for all subfolders and make take some time
getMailboxUri() Gets or sets the mailbox uri.
getMailboxes() Lists mailboxes having smtp addresses.
getMessageTrackingReport(GetMessageTrackingReportOptions options) Gets message tracking report
getNotesFolderEventFilter() Specifies event types for Notes folder
getNotificationTimeout() Defines timeout for server notifications
getNotificationsCheckInterval() Defines interval for notification check
getOutboxFolderEventFilter() Specifies event types for Outbox folder
getReconnectCount() Gets or sets the number of reconnect attempts at connection breaks.
getReturnClientRequestId() Gets or sets a flag to indicate whether the client requires the server side to return the request id.
getRootFolderEventFilter() Specifies event types for Root folder
getSentItemsFolderEventFilter() Specifies event types for SentItems folder
getServerTimeZoneIds() The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
getServerTimeZoneIds(Iterable timeZoneIds) The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
getServerTimeZoneIds(String[] timeZoneIds) The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.
getServerVersion() Gets the information about the current version of MS Exchange.
getTasksFolderEventFilter() Specifies event types for Tasks folder
getTimezoneId() Gets or sets timezone id
getUMConfiguration() Retrieves unified messaging configuration
getUseDateInLogFileName() Gets or sets value which indicates if date has to be used in log file name.
getUseSlashAsFolderSeparator() Gets or sets value that determines whether the slash ‘/’ is used as folder separator.
getUserConfiguration(UserConfigurationName userConfigurationName) Gets the specified user configuration
getVersionInfo() Returns exchange server version info
impersonateUser(int valueType, String value) Impersonates the user.
listAppointments() Retrieves list of appointments for default calendar folder
listAppointments(boolean recursive) Retrieves list of appointments for default calendar folder
listAppointments(MailQuery query) Retrieves list of appointments for default calendar folder
listAppointments(MailQuery query, boolean recursive) Retrieves list of appointments for default calendar folder
listAppointments(String folderUri) Retrieves list of appointments for specified calendar folder
listAppointments(String folderUri, boolean recursive) Retrieves list of appointments for specified calendar folder
listAppointments(String folderUri, MailQuery query) Retrieves list of appointments for specified calendar folder
listAppointments(String folderUri, MailQuery query, boolean recursive) Retrieves list of appointments for specified calendar folder
listAppointmentsByPage(MailQuery query, int itemsPerPage) Retrieves page with appointments for calendar folder
listAppointmentsByPage(MailQuery query, int itemsPerPage, int itemOffset) Retrieves page with appointments for calendar folder
listAppointmentsByPage(int itemsPerPage) Retrieves page with appointments for calendar folder
listAppointmentsByPage(int itemsPerPage, int itemOffset) Retrieves page with appointments for calendar folder
listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage) Retrieves page with appointments for specified calendar folder
listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage, int itemOffset) Retrieves page with appointments for specified calendar folder
listAppointmentsByPage(String folderUri, int itemsPerPage) Retrieves page with appointments for specified calendar folder
listAppointmentsByPage(String folderUri, int itemsPerPage, int itemOffset) Retrieves page with appointments for specified calendar folder
listContacts(String folderUri) Lists contacts located in the specified folder on server
listContacts(String folderUri, Iterable mapiProperties) Lists contacts located in the specified folder on server
listDelegates(String mailbox) Lists the users who are granted access on the specified mailbox.
listDistributionLists() List the private Distribution Lists.
listItems(String folder) Retrieve list of item uries in specified folder
listItems(String folder, MailQuery query) Retrieve list of item uries in specified folder
listItems(String folder, MailQuery query, boolean recursive) Retrieve list of item uries in specified folder
listItems(String mailbox, String folder) Retrieve list of item uries in specified folder
listItems(String mailbox, String folder, MailQuery query) Retrieve list of item uries in specified folder
listItems(String mailbox, String folder, MailQuery query, boolean recursive) Retrieve list of item uries in specified folder
listMailboxes() Lists mailboxes.
listMailboxes(String filter) Please pay your attention, this overridden method works with Exchange Server 2013 and higher.
listMessages() List the messages in the inbox folder.
listMessages(Iterable iDs) List the messages in the specified folder.
listMessages(String folder) Lists the messages.
listMessages(String folder, boolean recursive) List the messages in the specified folder
listMessages(String folder, MailQuery query) List the messages in the specified folder.
listMessages(String folder, MailQuery query, boolean recursive) List the messages in the specified folder.
listMessages(String folder, int maxNumberOfMessages) Lists the messages.
listMessages(String folder, int maxNumberOfMessages, MailQuery query) List the messages in the specified folder.
listMessages(String folder, int maxNumberOfMessages, MailQuery query, boolean recursive) List the messages in the specified folder.
listMessages(String mailbox, String folder, boolean recursive) List the messages in the specified folder
listMessages(String mailbox, String folder, MailQuery query) List the messages in the specified folder.
listMessagesByMaxNumberOfMessages(String folder, int maxNumberOfMessages) Lists the messages.
listMessagesByOption(String folder, int options) Lists the messages.
listMessagesByOption(String folder, int maxNumberOfMessages, int options) Lists the messages.
listMessagesByPage(String folder, MailQuery query, int itemsPerPage) List the messages in the specified folder.
listMessagesByPage(String folder, MailQuery query, int itemsPerPage, int offset) List the messages in the specified folder.
listMessagesByPage(String folder, PageInfo pageInfo) List the messages in the specified folder.
listMessagesByPage(String folder, PageInfo pageInfo, int options) List the messages in the specified folder.
listMessagesByPage(String folder, int itemsPerPage) List the messages in the specified folder.
listMessagesByPage(String folder, int itemsPerPage, int offset) List the messages in the specified folder.
listMessagesByPage(String folder, int itemsPerPage, int pageOffset, int options) List the messages in the specified folder.
listMessagesByPropertyDescriptor(String folder, int options, Iterable extendedProperties) List the messages in the specified folder
listMessagesFromPublicFolder(ExchangeFolderInfo folder) Get collection of messages from public folder
listMessagesFromPublicFolder(String folderUri) Get collection of messages from public folder
listPublicFolders() Gets collection of public folders from root public folder
listSubFolders(ExchangeFolderInfo parentFolder) Gets collection of child public folders from parent
listSubFolders(String parentFolderUri) Gets collection of child folders from parent
listSubFolders(String mailbox, String parentFolderUri) Gets collection of child folders from parent
listSubFoldersByPage(String parentFolderUri, PageInfo page) Searches the specified folder in the given parent folder with paging Method supports paging.
listSubFoldersByPage(String parentFolderUri, int itemsPerPage) Searches the specified folder in the given parent folder with paging Method supports paging.
listSubFoldersByPage(String parentFolderUri, int itemsPerPage, int pageOffset) Searches the specified folder in the given parent folder with paging Method supports paging.
listTasks() Retrieves lists of exchange tasks for default folder.
listTasks(String folder) Retrieves lists of exchange tasks.
listTasks(String folder, MailQuery query) Retrieves lists of exchange tasks.
listTasks(String folder, int maxNumberOfItems) Retrieves lists of exchange tasks.
listTasks(String folder, int maxNumberOfItems, MailQuery query) Retrieves lists of exchange tasks.
listTasks(String folder, int maxNumberOfItems, MailQuery query, boolean recursive) Retrieves lists of exchange tasks.
loadContactPhoto(ContactPhoto photo) Loads contact photo binary data
mailDisablePublicFolder(String folderUri) Mail-disable a public folder
mailEnablePublicFolder(String folderUri) Mail-enable a public folder
markAllItems(boolean read, boolean suppressReadReceipts, Iterable folderIds) Marks all items in specified folders.
markAllItems(boolean read, boolean suppressReadReceipts, String[] folderIds) Marks all items in specified folders.
markAllItems(boolean read, String[] folderIds) Marks all items in specified folders.
markAllItemsAsRead() Marks all items in inbox folder as read without receipts.
markAllItemsAsRead(Iterable folderIds) Marks all items in specified folders as read without receipts.
markAllItemsAsRead(String[] folderIds) Marks all items in specified folders as read without receipts.
markAllItemsAsUnread() Marks all items in inbox folder as unread.
markAllItemsAsUnread(Iterable folderIds) Marks all items in specified folders as unread.
markAllItemsAsUnread(String[] folderIds) Marks all items in specified folders as unread.
markAsJunk(boolean isJunk, boolean moveItem, Iterable messageUriEn) The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
markAsJunk(boolean isJunk, boolean moveItem, Iterable messageUriEn, String[][] movedMessageIds, String[][] failedMessageIds, String[][] errorMessages) The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
markAsJunk(boolean isJunk, boolean moveItem, String[] messageUriEn) The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
markAsJunk(boolean isJunk, Iterable messageUriEn) The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
markAsJunk(boolean isJunk, String[] messageUriEn) The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.
moveConversationItems(String conversationId, String destinationFolderId) Moves the conversation items into the specified target folder
moveConversationItems(String conversationId, String contextFolderId, String destinationFolderId) Moves the conversation items, which are located in the specified folder, into the specified target folder
moveItem(String itemUri, String destinationFolderUri) Moves the item to specified folder
playOnPhone(String messageId, String dialString) The PlayOnPhone operation initiates an outbound call and plays a message over the telephone.
removeHeader(String name) Remove WebHeader from WebHeaderCollection in EWS request.
reply(MailMessage message, ExchangeMessageInfo referencedMessage) Reply to the sender’s message.
reply(MailMessage message, String referencedUri) Reply to the sender’s message.
replyAll(MailMessage message, ExchangeMessageInfo referencedMessage) Reply to the sender and all recipients of a message.
resetImpersonation() Makes the impersonation reset.
resetSubscription() Reset all subscriptions
resolveContact(String unresolvedEntry) Resolves ambiguous mailbox names.
resolveContacts(String unresolvedEntry) Resolves ambiguous mailbox display names.
resolveContacts(String unresolvedEntry, int options) Resolves ambiguous e-mail addresses and display names Note: the maximum count of returned contacts is 100.
restore(PersonalStorage pst, RestoreSettings settings) Restores the specified exchange folders from the given personal storage.
saveMessage(String messageUri, OutputStream stream) Saves the message.
saveMessage(String messageUri, String path) Saves the message.
saveMessageInternal(String messageUri, System.IO.Stream stream)
send(MailMessage message) Sends the specified message.
send(MailMessage message, FollowUpOptions messageOptions) Sends the message.
send(String from, String to, String subject, String body) Sends the specified message
setCalendarFolderEventFilter(int value) Specifies event types for Calendar folder
setContactsFolderEventFilter(int value) Specifies event types for Contacts folder
setConversationReadState(String conversationId, boolean isRead) Set read state of the conversation items to the specified value
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
setCurrentCalendarFolderUri(String value) Gets or sets current calendar folder uri
setDeletedItemsFolderEventFilter(int value) Specifies event types for DeletedItems folder
setDraftsFolderEventFilter(int value) Specifies event types for Drafts folder
setEnableDecompression(boolean value) Gets or sets a value that indicates whether decompression is enabled
setInboxFolderEventFilter(int value) Specifies event types for Inbox folder
setJournalFolderEventFilter(int value) Specifies event types for Journal folder
setLogFileName(String value) Gets or sets log file name
setMailboxUri(String value) Gets or sets the mailbox uri.
setNotesFolderEventFilter(int value) Specifies event types for Notes folder
setNotificationTimeout(int value) Defines timeout for server notifications
setNotificationsCheckInterval(int value) Defines interval for notification check
setOutboxFolderEventFilter(int value) Specifies event types for Outbox folder
setReadFlag(String messageUri) Sets the read flag.
setReadFlag(String messageUri, boolean isRead) Marks the specifeid message as read.
setReconnectCount(int value) Gets or sets the number of reconnect attempts at connection breaks.
setReturnClientRequestId(boolean value) Gets or sets a flag to indicate whether the client requires the server side to return the request id.
setRootFolderEventFilter(int value) Specifies event types for Root folder
setSentItemsFolderEventFilter(int value) Specifies event types for SentItems folder
setTasksFolderEventFilter(int value) Specifies event types for Tasks folder
setTimezoneId(String value) Gets or sets timezone id
setUseDateInLogFileName(boolean value) Gets or sets value which indicates if date has to be used in log file name.
setUseSlashAsFolderSeparator(boolean value) Gets or sets value that determines whether the slash ‘/’ is used as folder separator.
syncFolder(SyncState syncState) Retrieves changes of the items in a specified folder.
syncFolder(String folderUri) Retrieves changes of the items and subfolders in a specified folder.
syncFolder(String folderUri, int syncType) Retrieves changes of the items and subfolders in a specified folder.
syncFolder(String folderUri, String syncState) Retrieves changes of the items in a specified folder.
syncFolder(String folderUri, String syncState, Iterable ignoreList) Retrieves changes of the items in a specified folder.
updateAppointment(Appointment appointment) Updates appointment.
updateAppointment(Appointment appointment, String folderUri) Updates appointment.
updateAppointment(MapiCalendar appointment) Updates appointment.
updateAppointment(MapiCalendar appointment, String folderUri) Updates appointment.
updateContact(Contact contact) Updates a contact item in the Exchange store.
updateContact(MapiContact contact) Updates a contact item in the Exchange store.
updateDelegate(ExchangeDelegateUser delegateUser, String mailbox) Updates the delegate user settings who is granted access on the specified mailbox.
updateDelegates(ExchangeDelegateUserCollection delegateUsers, String mailbox) Updates the delegate users settings who are granted access on the specified mailbox.
updateInboxRule(InboxRule rule) Updates the specified inbox rule
updateInboxRule(InboxRule rule, String mailbox) Updates the specified inbox rule
updateItems(ExchangeStreamedItem[] items, String parentFolderUri) Updates the specified items in to a mailbox
updateNote(MapiNote note) Updates the specified note.
updateNote(String uri, MapiNote note) Updates the specified note.
updateNote(String uri, MapiNote note, Iterable additionalProperties) Updates the specified note.
updateSubscription() Updates subscriptions
updateTask(ExchangeTask task) Updates the specified task.
updateTask(ExchangeTask task, int options) Updates the specified task.
updateTask(MapiTask task) Updates the specified task.
updateTask(String uri, MapiTask task) Updates the specified task.
updateTask(String uri, MapiTask task, Iterable additionalProperties) Updates the specified task.
updateUserConfiguration(UserConfiguration userConfiguration) Updates the specified user configuration

addHeader(String name, String value)

public abstract void addHeader(String name, String value)

Adds name and value to WebHeaderCollection in EWS request.

Parameters:

Parameter Type Description
name java.lang.String Header name
value java.lang.String Header value

addToDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)

public abstract void addToDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)

Appends the members to Distribution List.

Parameters:

Parameter Type Description
distributionList ExchangeDistributionList A ExchangeDistributionList containing information about Distribution List to update.
members MailAddressCollection A MailAddressCollection containing the mail addresses to add.

appendMapiMessages(String folderUri, Iterable messages)

public abstract String[] appendMapiMessages(String folderUri, Iterable<MapiMessage> messages)

Uploads the mapi messages to the specified folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder URI to which message is uploaded
messages java.lang.Iterable<com.aspose.email.MapiMessage> A messages to upload

Returns: java.lang.String[] - List of uri of created messages

appendMessage(MailMessage message)

public abstract String appendMessage(MailMessage message)

Uploads the mail message to the Inbox folder

Parameters:

Parameter Type Description
message MailMessage A message to upload

Returns: java.lang.String - An uri of created message

appendMessage(MapiMessage mapiMessage)

public abstract String appendMessage(MapiMessage mapiMessage)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
mapiMessage MapiMessage A message to upload

Returns: java.lang.String - An uri of created message

appendMessage(MapiMessage mapiMessage, boolean markAsSent)

public abstract String appendMessage(MapiMessage mapiMessage, boolean markAsSent)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
mapiMessage MapiMessage A message to upload
markAsSent boolean A value indicating whether the message should be appended as a sent message or a draft.

Returns: java.lang.String - An uri of created message

appendMessage(String folderUri, MailMessage message)

public abstract String appendMessage(String folderUri, MailMessage message)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder URI to which message is uploaded
message MailMessage A message to upload

Returns: java.lang.String - An uri of created message

appendMessage(String folderUri, MailMessage message, boolean markAsSent)

public abstract String appendMessage(String folderUri, MailMessage message, boolean markAsSent)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder URI to which message is uploaded
message MailMessage A message to upload
markAsSent boolean A value indicating whether the message should be appended as a sent message or a draft.

Returns: java.lang.String - An uri of created message

appendMessage(String folder, MapiMessage mapiMessage, boolean markAsSent)

public abstract String appendMessage(String folder, MapiMessage mapiMessage, boolean markAsSent)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
folder java.lang.String A folder to which message is uploaded
mapiMessage MapiMessage A message to upload
markAsSent boolean A value indicating whether the message should be appended as a sent message or a draft.

Returns: java.lang.String - An uri of created message

appendMessages(MailMessage[] messages)

public abstract String[] appendMessages(MailMessage[] messages)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
messages MailMessage[] A messages to upload

Returns: java.lang.String[] - List of uri of created messages

appendMessages(Iterable messages)

public abstract String[] appendMessages(Iterable<MailMessage> messages)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
messages java.lang.Iterable<com.aspose.email.MailMessage> A messages to upload

Returns: java.lang.String[] - List of uri of created messages

appendMessages(String folderUri, MailMessage[] messages)

public abstract String[] appendMessages(String folderUri, MailMessage[] messages)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder URI to which message is uploaded
messages MailMessage[] A messages to upload

Returns: java.lang.String[] - List of uri of created messages

appendMessages(String folderUri, Iterable messages)

public abstract String[] appendMessages(String folderUri, Iterable<MailMessage> messages)

Uploads the mail message to the specified folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder URI to which message is uploaded
messages java.lang.Iterable<com.aspose.email.MailMessage> A messages to upload

Returns: java.lang.String[] - List of uri of created messages

archiveItem(String sourceFolderUri, Appointment appointment)

public abstract void archiveItem(String sourceFolderUri, Appointment appointment)

The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.

Parameters:

Parameter Type Description
sourceFolderUri java.lang.String
appointment Appointment Item which will be archived

archiveItem(String sourceFolderUri, ExchangeTask task)

public abstract void archiveItem(String sourceFolderUri, ExchangeTask task)

The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.

Parameters:

Parameter Type Description
sourceFolderUri java.lang.String
task ExchangeTask Item which will be archived

archiveItem(String sourceFolderUri, MapiMessageItemBase item)

public abstract void archiveItem(String sourceFolderUri, MapiMessageItemBase item)

The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.

Parameters:

Parameter Type Description
sourceFolderUri java.lang.String
item MapiMessageItemBase Item which will be archived

archiveItem(String sourceFolderUri, String uniqueId)

public abstract void archiveItem(String sourceFolderUri, String uniqueId)

The ArchiveItem operation moves an item into the mailbox user’s archive mailbox.

Parameters:

Parameter Type Description
sourceFolderUri java.lang.String
uniqueId java.lang.String Item id

backup(ExchangeFolderInfoCollection folders, OutputStream stream, int options)

public abstract void backup(ExchangeFolderInfoCollection folders, OutputStream stream, int options)

Backups the content of the specified folders

Parameters:

Parameter Type Description
folders ExchangeFolderInfoCollection A folders to backup
stream java.io.OutputStream A stream to write into
options int A backup options

backup(ExchangeFolderInfoCollection folders, String fileName, int options)

public abstract void backup(ExchangeFolderInfoCollection folders, String fileName, int options)

Backups the content of the specified folders

Parameters:

Parameter Type Description
folders ExchangeFolderInfoCollection A folders to backup
fileName java.lang.String A path to the presonal storage file
options int A backup options

cancelAppointment(Appointment appointment)

public abstract void cancelAppointment(Appointment appointment)

Cancels appointment.

Parameters:

Parameter Type Description
appointment Appointment Calendar appointment.

cancelAppointment(Appointment appointment, String folderUri)

public abstract void cancelAppointment(Appointment appointment, String folderUri)

Cancels appointment.

Parameters:

Parameter Type Description
appointment Appointment Calendar appointment.
folderUri java.lang.String An uri of appointments parent folder.

cancelAppointment(MapiCalendar appointment)

public abstract void cancelAppointment(MapiCalendar appointment)

Cancels appointment.

Parameters:

Parameter Type Description
appointment MapiCalendar Calendar appointment.

cancelAppointment(MapiCalendar appointment, String folderUri)

public abstract void cancelAppointment(MapiCalendar appointment, String folderUri)

Cancels appointment.

Parameters:

Parameter Type Description
appointment MapiCalendar Calendar appointment.
folderUri java.lang.String An uri of appointments parent folder.

cancelAppointment(String uniqueId)

public abstract void cancelAppointment(String uniqueId)

Cancels an exiting meeting on an organizers calendar

Parameters:

Parameter Type Description
uniqueId java.lang.String Unique identifier

cancelAppointment(String uniqueId, String folderUri)

public abstract void cancelAppointment(String uniqueId, String folderUri)

Cancels an exiting meeting on an organizers calendar

Parameters:

Parameter Type Description
uniqueId java.lang.String Unique identifier
folderUri java.lang.String An uri of appointments parent folder.

checkUserAvailability(System.Collections.Specialized.StringCollection users, DateRange timeWindow)

public abstract ExchangeUserAvailabilityCollection checkUserAvailability(System.Collections.Specialized.StringCollection users, DateRange timeWindow)

Checks users availability within the specified time window.

Parameters:

Parameter Type Description
users com.aspose.ms.System.Collections.Specialized.StringCollection An users smtp addresses.
timeWindow DateRange A time span for the queried user’s availability.

Returns: ExchangeUserAvailabilityCollection - ExchangeUserAvailabilityCollection containing the users availability informaiton.

checkUserAvailability(String user, DateRange timeWindow)

public abstract ExchangeUserAvailability checkUserAvailability(String user, DateRange timeWindow)

Checks user availability within the specified time window.

Parameters:

Parameter Type Description
user java.lang.String An user smtp address.
timeWindow DateRange A time span for the queried user’s availability.

Returns: ExchangeUserAvailability - ExchangeUserAvailability containing user availability information.

closeAccess(ExchangeDelegateUser delegateUser, String mailbox)

public abstract void closeAccess(ExchangeDelegateUser delegateUser, String mailbox)

Closes access on the specified mailbox for the specified user.

Parameters:

Parameter Type Description
delegateUser ExchangeDelegateUser A delegate user.
mailbox java.lang.String A mailbox.

closeAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox)

public abstract void closeAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox)

Closes access on the specified mailbox for the specified user.

Parameters:

Parameter Type Description
delegateUsers ExchangeDelegateUserCollection A delegate users.
mailbox java.lang.String A mailbox.

closeAccess(ExchangeFolderUserInfo userInfo, String mailbox)

public abstract void closeAccess(ExchangeFolderUserInfo userInfo, String mailbox)

Closes access on the specified mailbox for the specified user.

Parameters:

Parameter Type Description
userInfo ExchangeFolderUserInfo A user information.
mailbox java.lang.String A mailbox.

closeAccess(String delegateSmtpAddress, String mailbox)

public abstract void closeAccess(String delegateSmtpAddress, String mailbox)

Closes access on the specified mailbox for the specified user.

Parameters:

Parameter Type Description
delegateSmtpAddress java.lang.String A primary smtp address of delegate user.
mailbox java.lang.String A mailbox.

copyConversationItems(String conversationId, String destinationFolderId)

public abstract void copyConversationItems(String conversationId, String destinationFolderId)

Copies the conversation items into the specified target folder

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to copy
destinationFolderId java.lang.String Id of folder into which copy items

copyConversationItems(String conversationId, String contextFolderId, String destinationFolderId)

public abstract void copyConversationItems(String conversationId, String contextFolderId, String destinationFolderId)

Copies the conversation items, which are located in the specified folder, into the specified target folder

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to copy
contextFolderId java.lang.String Id of folder in which conversation items are located. Note: If it’s set to null(or empty), all conversation items will be copied
destinationFolderId java.lang.String Id of folder into which copy items

copyItem(String itemUri, String destinationFolderUri)

public abstract String copyItem(String itemUri, String destinationFolderUri)

Copies the item to specified folder

Parameters:

Parameter Type Description
itemUri java.lang.String The item URI
destinationFolderUri java.lang.String The destination folder URI

Returns: java.lang.String - An uri of the copied message

createAppointment(Appointment appointment)

public abstract String createAppointment(Appointment appointment)

Creates appointment.

Parameters:

Parameter Type Description
appointment Appointment Calendar appointment.

Returns: java.lang.String - Returns appointment UID

createAppointment(Appointment appointment, String folderUri)

public abstract String createAppointment(Appointment appointment, String folderUri)

Creates appointment.

Parameters:

Parameter Type Description
appointment Appointment Calendar appointment.
folderUri java.lang.String An uri of appointments parent folder.

Returns: java.lang.String - Returns appointment UID

createAppointment(MapiCalendar appointment)

public abstract String createAppointment(MapiCalendar appointment)

Creates appointment.

Parameters:

Parameter Type Description
appointment MapiCalendar Calendar appointment.

Returns: java.lang.String - Returns appointment UID

createAppointment(MapiCalendar appointment, String folderUri)

public abstract String createAppointment(MapiCalendar appointment, String folderUri)

Creates appointment.

Parameters:

Parameter Type Description
appointment MapiCalendar Calendar appointment.
folderUri java.lang.String An uri of appointments parent folder.

Returns: java.lang.String - Returns PidLidGlobalObjectId as base64 string

createAppointment(MapiCalendar appointment, String folderUri, boolean suppressInvitations)

public abstract String createAppointment(MapiCalendar appointment, String folderUri, boolean suppressInvitations)

Creates appointment.

Parameters:

Parameter Type Description
appointment MapiCalendar Calendar appointment.
folderUri java.lang.String An uri of appointments parent folder.
suppressInvitations boolean If true, invitations won’t be sent to attendees.

Returns: java.lang.String - Returns PidLidGlobalObjectId as base64 string

createCalendarSharingInvitationMessage(String recipient)

public abstract MapiMessage createCalendarSharingInvitationMessage(String recipient)

Create calendar sharing invitation message.

Parameters:

Parameter Type Description
recipient java.lang.String A recipient’s address.

Returns: MapiMessage - A MapiMessage that represents sharing invitation message.

createContact(Contact contact)

public abstract String createContact(Contact contact)

Creates a contact item in the Exchange store.

Parameters:

Parameter Type Description
contact Contact Contact item

Returns: java.lang.String - The contact Uri

createContact(MapiContact contact)

public abstract String createContact(MapiContact contact)

Creates a contact item in the Exchange store.

Parameters:

Parameter Type Description
contact MapiContact Contact item

Returns: java.lang.String - The contact Uri

createContact(String folderUri, Contact contact)

public abstract String createContact(String folderUri, Contact contact)

Creates a contact item in the specified folder.

Parameters:

Parameter Type Description
folderUri java.lang.String Folder uri
contact Contact Contact item

Returns: java.lang.String - The contact Uri

createContact(String folderUri, MapiContact contact)

public abstract String createContact(String folderUri, MapiContact contact)

Creates a contact item in the specified folder.

Parameters:

Parameter Type Description
folderUri java.lang.String Folder uri
contact MapiContact Contact item

Returns: java.lang.String - The contact Uri

createDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)

public abstract String createDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)

Creates the private Distribution List.

Parameters:

Parameter Type Description
distributionList ExchangeDistributionList A ExchangeDistributionList containing information about Distribution List to create.
members MailAddressCollection A MailAddressCollection containing the Distribution List mail addresses to create.

Returns: java.lang.String - A string containing the Distribution List Id.

createFolder(String name)

public abstract ExchangeFolderInfo createFolder(String name)

Creates new folder in the root folder.

Parameters:

Parameter Type Description
name java.lang.String The name of new folder

Returns: ExchangeFolderInfo - Returns folder information

createFolder(String name, int folderType)

public abstract ExchangeFolderInfo createFolder(String name, int folderType)

Creates new folder in the root folder.

Parameters:

Parameter Type Description
name java.lang.String The name of new folder
folderType int Type of folder

Returns: ExchangeFolderInfo - Returns folder information

createFolder(String parentFolderUri, String name)

public abstract ExchangeFolderInfo createFolder(String parentFolderUri, String name)

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

Parameters:

Parameter Type Description
parentFolderUri java.lang.String An uri of parent folder.
name java.lang.String A name of folder to be created.

Returns: ExchangeFolderInfo

createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions)

public abstract ExchangeFolderInfo createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions)

Creates the new folder

Parameters:

Parameter Type Description
parentFolderUri java.lang.String The URI of parent folder
name java.lang.String The name of new folder
permissions ExchangeFolderPermissionCollection A permission on new folder

Returns: ExchangeFolderInfo - Returns folder information

createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions, String folderClass)

public abstract ExchangeFolderInfo createFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions, String folderClass)

Creates the new folder

Parameters:

Parameter Type Description
parentFolderUri java.lang.String The URI of parent folder
name java.lang.String The name of new folder
permissions ExchangeFolderPermissionCollection A permission on new folder
folderClass java.lang.String The class of new folder

Returns: ExchangeFolderInfo - Returns folder information

createFolder(String parentFolderUri, String name, int folderType)

public abstract ExchangeFolderInfo createFolder(String parentFolderUri, String name, int folderType)

Creates the new folder

Parameters:

Parameter Type Description
parentFolderUri java.lang.String The URI of parent folder
name java.lang.String The name of new folder
folderType int Type of folder

Returns: ExchangeFolderInfo - Returns folder information

createInboxRule(InboxRule rule)

public abstract void createInboxRule(InboxRule rule)

Creates the specified inbox rule

Parameters:

Parameter Type Description
rule InboxRule A inbox rule to create

createInboxRule(InboxRule rule, String mailbox)

public abstract void createInboxRule(InboxRule rule, String mailbox)

Creates the specified inbox rule

Parameters:

Parameter Type Description
rule InboxRule A inbox rule to create
mailbox java.lang.String A mailbox to create rule for. Note: if it is set to null or empty , the rule will be created in the default mailbox

createItem(MapiMessageItemBase item)

public abstract String createItem(MapiMessageItemBase item)

Creates the given item in the default item folder.

Parameters:

Parameter Type Description
item MapiMessageItemBase An item to create.

Returns: java.lang.String - The item Uri

createItem(String folderUri, MapiMessageItemBase item)

public abstract String createItem(String folderUri, MapiMessageItemBase item)

Creates the given item in the specified folder.

Parameters:

Parameter Type Description
folderUri java.lang.String A folder Uri where item should be created.
item MapiMessageItemBase An item to create.

Returns: java.lang.String - The item Uri

createItems(ExchangeStreamedItem[] items, String parentFolderUri)

public abstract ExchangeUploadItemResult[] createItems(ExchangeStreamedItem[] items, String parentFolderUri)

Creates the specified items in the speciifed folder

Parameters:

Parameter Type Description
items ExchangeStreamedItem[] An items to be uploaded
parentFolderUri java.lang.String Specifies the folder in which to place the items

Returns: com.aspose.email.ExchangeUploadItemResult[] - An array of ExchangeUploadItemResult

createNote(MapiNote note)

public abstract String createNote(MapiNote note)

Creates the given note in the default note folder.

Parameters:

Parameter Type Description
note MapiNote A note to create.

Returns: java.lang.String - Note uri.

createNote(String folder, MapiNote note)

public abstract String createNote(String folder, MapiNote note)

Creates the given note in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder where note should be created.
note MapiNote A note to create.

Returns: java.lang.String - Note uri.

createPublicFolder(String name, ExchangeFolderPermissionCollection permissions)

public abstract ExchangeFolderInfo createPublicFolder(String name, ExchangeFolderPermissionCollection permissions)

Creates the specified public folder in the root public folder

Parameters:

Parameter Type Description
name java.lang.String A name of new folder
permissions ExchangeFolderPermissionCollection A permission on new folder

Returns: ExchangeFolderInfo - Returns folder information

createPublicFolder(String name, ExchangeFolderPermissionCollection permissions, int folderType)

public abstract ExchangeFolderInfo createPublicFolder(String name, ExchangeFolderPermissionCollection permissions, int folderType)

Creates the specified public folder in the root public folder

Parameters:

Parameter Type Description
name java.lang.String A name of new folder
permissions ExchangeFolderPermissionCollection A permission on new folder
folderType int Type of folder

Returns: ExchangeFolderInfo - Returns folder information

createPublicFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions)

public abstract ExchangeFolderInfo createPublicFolder(String parentFolderUri, String name, ExchangeFolderPermissionCollection permissions)

Creates the specified public folder in the root public folder

Parameters:

Parameter Type Description
parentFolderUri java.lang.String The URI of parent folder
name java.lang.String A name of new folder
permissions ExchangeFolderPermissionCollection A permission on new folder

Returns: ExchangeFolderInfo - Returns folder information

createTask(ExchangeTask task)

public abstract String createTask(ExchangeTask task)

Creates the given task in the default task folder.

Parameters:

Parameter Type Description
task ExchangeTask A task to create.

Returns: java.lang.String - A task uri

createTask(MapiTask task)

public abstract String createTask(MapiTask task)

Creates the given task in the default task folder.

Parameters:

Parameter Type Description
task MapiTask A task to create.

Returns: java.lang.String

createTask(String folder, ExchangeTask task)

public abstract String createTask(String folder, ExchangeTask task)

Creates the given task in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder where task should be created.
task ExchangeTask A task to create.

Returns: java.lang.String - A task uri

createTask(String folder, MapiTask task)

public abstract String createTask(String folder, MapiTask task)

Creates the given task in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder where task should be created.
task MapiTask A task to create.

Returns: java.lang.String

createUserConfiguration(UserConfiguration userConfiguration)

public abstract void createUserConfiguration(UserConfiguration userConfiguration)

Creates the specified user configuration

Parameters:

Parameter Type Description
userConfiguration UserConfiguration UserConfiguration to be created

delegateAccess(ExchangeDelegateUser delegateUser, String mailbox)

public abstract void delegateAccess(ExchangeDelegateUser delegateUser, String mailbox)

Delegates access on the specified mailbox to the specified user.

Parameters:

Parameter Type Description
delegateUser ExchangeDelegateUser A ExchangeDelegateUser containing user information and delegation settings.
mailbox java.lang.String A mailbox to grant access on.

delegateAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox)

public abstract void delegateAccess(ExchangeDelegateUserCollection delegateUsers, String mailbox)

Delegates access on the mailbox to the specified users.

Parameters:

Parameter Type Description
delegateUsers ExchangeDelegateUserCollection A ExchangeDelegateUserCollection containing the users information and delegation settings.
mailbox java.lang.String A mailbox to grant access on.

delegateAccess(String delegateSmtpAddress, int permissionLevel, String mailbox)

public abstract void delegateAccess(String delegateSmtpAddress, int permissionLevel, String mailbox)

Delegates access on the principal mailbox to the specified user.

Parameters:

Parameter Type Description
delegateSmtpAddress java.lang.String A primary smtp address of user.
permissionLevel int A permission level that is granted to the user on all folders.
mailbox java.lang.String A mailbox to grant access on.

deleteConversationItems(String conversationId)

public abstract void deleteConversationItems(String conversationId)

Deletes all items of the specified conversation

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to delete

deleteConversationItems(String conversationId, String contextFolderId)

public abstract void deleteConversationItems(String conversationId, String contextFolderId)

Deletes the conversation items, which are located in the specified folder

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to delete
contextFolderId java.lang.String Id of folder in which delete conversation items. Note: If it’s set to null(or empty), all conversation items will be deleted

deleteDistributionList(ExchangeDistributionList distributionList, boolean deletePermanently)

public abstract void deleteDistributionList(ExchangeDistributionList distributionList, boolean deletePermanently)

Deletes the Distribution List.

Parameters:

Parameter Type Description
distributionList ExchangeDistributionList A ExchangeDistributionList containing information about Distribution List to delete.
deletePermanently boolean Indicates whether the specified List should be deleted permanently or should be moved into DeletedItems folder.

deleteFolder(String folderUri)

public abstract void deleteFolder(String folderUri)

Deletes the folder

Parameters:

Parameter Type Description
folderUri java.lang.String The folder Uri

deleteFolder(String folderUri, boolean deletePermanently)

public abstract void deleteFolder(String folderUri, boolean deletePermanently)

Deletes the folder

Parameters:

Parameter Type Description
folderUri java.lang.String The folder Uri
deletePermanently boolean Indicates whether the folder should be deleted permanently or should be moved into DeletedItems folder

deleteFolders(ExchangeFolderInfoCollection folders)

public abstract void deleteFolders(ExchangeFolderInfoCollection folders)

Deletes the specified folders

Parameters:

Parameter Type Description
folders ExchangeFolderInfoCollection A ExchangeFolderInfoCollection containing information about folders to delete

deleteFolders(ExchangeFolderInfoCollection folders, boolean deletePermanently)

public abstract void deleteFolders(ExchangeFolderInfoCollection folders, boolean deletePermanently)

Deletes the specified folders

Parameters:

Parameter Type Description
folders ExchangeFolderInfoCollection A ExchangeFolderInfoCollection containing information about folders to delete
deletePermanently boolean Indicates whether the folder should be deleted permanently or should be moved into DeletedItems folder

deleteFolders(System.Collections.Specialized.StringCollection folderUris)

public abstract void deleteFolders(System.Collections.Specialized.StringCollection folderUris)

Deletes the specified folders

Parameters:

Parameter Type Description
folderUris com.aspose.ms.System.Collections.Specialized.StringCollection The folder uris

deleteFolders(System.Collections.Specialized.StringCollection folderUris, boolean deletePermanently)

public abstract void deleteFolders(System.Collections.Specialized.StringCollection folderUris, boolean deletePermanently)

Deletes the folder

Parameters:

Parameter Type Description
folderUris com.aspose.ms.System.Collections.Specialized.StringCollection The folder Uri
deletePermanently boolean Indicates whether the folder should be deleted permanently or should be moved into DeletedItems folder

deleteFromDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)

public abstract void deleteFromDistributionList(ExchangeDistributionList distributionList, MailAddressCollection members)

Deletes the members from Distribution List.

Parameters:

Parameter Type Description
distributionList ExchangeDistributionList A ExchangeDistributionList containing information about Distribution List to update.
members MailAddressCollection A MailAddressCollection containing the mail addresses to delete. The MailAddress must contain id.

deleteInboxRule(String ruleId)

public abstract void deleteInboxRule(String ruleId)

Deletes the specified inbox rule

Parameters:

Parameter Type Description
ruleId java.lang.String An id of inbox rule to delete

deleteInboxRule(String ruleId, String mailbox)

public abstract void deleteInboxRule(String ruleId, String mailbox)

Deletes the specified inbox rule

Parameters:

Parameter Type Description
ruleId java.lang.String An id of inbox rule to delete
mailbox java.lang.String A mailbox where rule is located. Note: if it is set to null or empty , the rule will be searched in the default mailbox

deleteItem(String itemUri, DeletionOptions options)

public abstract void deleteItem(String itemUri, DeletionOptions options)

Deletes specified item

Parameters:

Parameter Type Description
itemUri java.lang.String The item uri
options DeletionOptions Defines parameters for item deletion

deleteItems(Iterable itemUris, DeletionOptions options)

public abstract void deleteItems(Iterable<String> itemUris, DeletionOptions options)

Deletes specified items

Parameters:

Parameter Type Description
itemUris java.lang.Iterable<java.lang.String> An items uris
options DeletionOptions Defines parameters for items deletion

deleteUserConfiguration(UserConfigurationName userConfigurationName)

public abstract void deleteUserConfiguration(UserConfigurationName userConfigurationName)

Deletes the specified user configuration

Parameters:

Parameter Type Description
userConfigurationName UserConfigurationName Specifies a user configuration to delete

disconnectPhoneCall(String callId)

public abstract void disconnectPhoneCall(String callId)

Disconnects a phone call specified by id.

Parameters:

Parameter Type Description
callId java.lang.String Phone call id.

emptyFolder(String folderUri)

public abstract void emptyFolder(String folderUri)

Empties the specified folder. Subfolders will not be deleted; deleted items will be moved into DeletedItems folder

Parameters:

Parameter Type Description
folderUri java.lang.String Specifies the folder to be empty

emptyFolder(String folderUri, int options)

public abstract void emptyFolder(String folderUri, int options)

Empties the specified folder

Parameters:

Parameter Type Description
folderUri java.lang.String Specifies the folder to be empty
options int Specifies the options of clearing folder

expandDistributionList(MailAddress mailAddress)

public abstract MailAddressCollection expandDistributionList(MailAddress mailAddress)

Expands the public Distribution List members.

Parameters:

Parameter Type Description
mailAddress MailAddress A public MailAddress to expand.

Returns: MailAddressCollection - A MailAddressCollection that contains members from the specified public Distribution List.

exportItems(String[] itemIds)

public abstract ExchangeStreamedItem[] exportItems(String[] itemIds)

Exports the specified items from mailbox

Parameters:

Parameter Type Description
itemIds java.lang.String[] Ids of itmes to be exported

Returns: com.aspose.email.ExchangeStreamedItem[] - An array of ExchangeStreamedItem

fetchAppointment(String appointmentUri)

public abstract Appointment fetchAppointment(String appointmentUri)

Fetch the specified appointment from server.

Parameters:

Parameter Type Description
appointmentUri java.lang.String An uri of appointment to be fetched.

Returns: Appointment - A fetched Appointment.

fetchAppointment(String appointmentUri, String folderUri)

public abstract Appointment fetchAppointment(String appointmentUri, String folderUri)

Fetch the specified appointment from server.

Parameters:

Parameter Type Description
appointmentUri java.lang.String An uri of appointment to be fetched.
folderUri java.lang.String An uri of appointments parent folder.

Returns: Appointment - A fetched Appointment.

fetchAttachment(String attachmentUri)

public abstract Attachment fetchAttachment(String attachmentUri)

Fetches the attachment

Parameters:

Parameter Type Description
attachmentUri java.lang.String The attachment uri

Returns: Attachment - Attachment that represents fetched attachment

fetchContact(String contactUri)

public abstract MapiContact fetchContact(String contactUri)

Fetches MapiContact object

Parameters:

Parameter Type Description
contactUri java.lang.String Contact object uri

Returns: MapiContact - MapiContact object

fetchContact(String contactUri, Iterable customProperties)

public abstract MapiContact fetchContact(String contactUri, Iterable<PropertyDescriptor> customProperties)

Fetches MapiContact object

Parameters:

Parameter Type Description
contactUri java.lang.String Contact object uri
customProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Custom mapi properties to retrieve.

Returns: MapiContact - MapiContact object

fetchConversationMessages(String conversationId)

public abstract MailMessageCollection fetchConversationMessages(String conversationId)

Fetches the specified conversation messages

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation

Returns: MailMessageCollection

fetchDistributionList(ExchangeDistributionList distributionList)

public abstract MailAddressCollection fetchDistributionList(ExchangeDistributionList distributionList)

Fetches the private Distribution List members.

Parameters:

Parameter Type Description
distributionList ExchangeDistributionList A ExchangeDistributionList containing information about Distribution List to fetch.

Returns: MailAddressCollection - A MailAddressCollection that contains members from the specified private Distribution List.

fetchItem(String uri)

public abstract MapiMessage fetchItem(String uri)

Retrieves the complete item with attachments.

Parameters:

Parameter Type Description
uri java.lang.String The item URI.

Returns: MapiMessage - MapiMessage object.

fetchItem(String uri, Iterable extendedProperties)

public abstract MapiMessage fetchItem(String uri, Iterable<PropertyDescriptor> extendedProperties)

Retrieves the complete item with attachments.

Parameters:

Parameter Type Description
uri java.lang.String The item URI.
extendedProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Specified properties to retrieve.

Returns: MapiMessage - MapiMessage object.

fetchMapiCalendar(Iterable calendarUris)

public abstract System.Collections.Generic.IGenericList<MapiCalendar> fetchMapiCalendar(Iterable<String> calendarUris)

Fetch array of MapiCalendar objects.

Parameters:

Parameter Type Description
calendarUris java.lang.Iterable<java.lang.String> List of calendar uris to be fetched.

Returns: com.aspose.ms.System.Collections.Generic.IGenericList<com.aspose.email.MapiCalendar> - Fetch array of MapiCalendar objects.

fetchMapiCalendar(Iterable calendarUris, Iterable customProperties)

public abstract System.Collections.Generic.IGenericList<MapiCalendar> fetchMapiCalendar(Iterable<String> calendarUris, Iterable<PropertyDescriptor> customProperties)

Fetch array of MapiCalendar objects.

Parameters:

Parameter Type Description
calendarUris java.lang.Iterable<java.lang.String> List of calendar uris to be fetched.
customProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Custom mapi properties to retrieve.

Returns: com.aspose.ms.System.Collections.Generic.IGenericList<com.aspose.email.MapiCalendar> - Fetch array of MapiCalendar objects.

fetchMapiCalendar(String calendarUri)

public abstract MapiCalendar fetchMapiCalendar(String calendarUri)

Fetch MapiCalendar object.

Parameters:

Parameter Type Description
calendarUri java.lang.String calendar uri to be fetched.

Returns: MapiCalendar - Fetch MapiCalendar object.

fetchMapiCalendar(String calendarUri, Iterable customProperties)

public abstract MapiCalendar fetchMapiCalendar(String calendarUri, Iterable<PropertyDescriptor> customProperties)

Fetch MapiCalendar object.

Parameters:

Parameter Type Description
calendarUri java.lang.String calendar uri to be fetched.
customProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Custom mapi properties to retrieve.

Returns: MapiCalendar - Fetch MapiCalendar object.

fetchMapiMessage(String uri)

public abstract MapiMessage fetchMapiMessage(String uri)

Fetches the speciifed message

Parameters:

Parameter Type Description
uri java.lang.String A String containing message uri to be retrieved

Returns: MapiMessage - Fetched MapiMessage.

fetchMapiMessage(String uri, Iterable extendedProperties)

public abstract MapiMessage fetchMapiMessage(String uri, Iterable<PropertyDescriptor> extendedProperties)

Fetches the speciifed message

Parameters:

Parameter Type Description
uri java.lang.String A String containing message uri to be retrieved
extendedProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> An enumeration of extended properties

Returns: MapiMessage - Fetched MapiMessage.

fetchMapiMessages(Iterable uris)

public abstract MapiMessage[] fetchMapiMessages(Iterable<String> uris)

Fetches the speciifed messages

Parameters:

Parameter Type Description
uris java.lang.Iterable<java.lang.String> A IEnumerable{String}IEnumerable “/> containing message uris to be retrieved

Returns: com.aspose.email.MapiMessage[] - An array of MapiMessage containing fetched messages

fetchMapiMessages(Iterable uris, Iterable extendedProperties)

public abstract MapiMessage[] fetchMapiMessages(Iterable<String> uris, Iterable<PropertyDescriptor> extendedProperties)

Fetches the speciifed messages

Parameters:

Parameter Type Description
uris java.lang.Iterable<java.lang.String> A StringCollection containing message uris to be retrieved
extendedProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> An enumeration of extended properties

Returns: com.aspose.email.MapiMessage[] - An array of MapiMessage containing fetched messages

fetchMapiNote(String noteUri)

public abstract MapiNote fetchMapiNote(String noteUri)

Fetches MapiNote object.

Parameters:

Parameter Type Description
noteUri java.lang.String note uri to be fetched.

Returns: MapiNote - MapiNote object.

fetchMapiNote(String noteUri, Iterable customProperties)

public abstract MapiNote fetchMapiNote(String noteUri, Iterable<PropertyDescriptor> customProperties)

Fetches MapiNote object.

Parameters:

Parameter Type Description
noteUri java.lang.String note uri to be fetched.
customProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Custom mapi properties to retrieve.

Returns: MapiNote - MapiNote object.

fetchMapiNotes(Iterable noteUris)

public abstract System.Collections.Generic.IGenericList<MapiNote> fetchMapiNotes(Iterable<String> noteUris)

Fetch array of MapiNote objects.

Parameters:

Parameter Type Description
noteUris java.lang.Iterable<java.lang.String> List of note uris to be fetched.

Returns: com.aspose.ms.System.Collections.Generic.IGenericList<com.aspose.email.MapiNote> - Fetch array of MapiNote objects.

fetchMapiNotes(Iterable noteUris, Iterable customProperties)

public abstract System.Collections.Generic.IGenericList<MapiNote> fetchMapiNotes(Iterable<String> noteUris, Iterable<PropertyDescriptor> customProperties)

Fetch array of MapiNote objects.

Parameters:

Parameter Type Description
noteUris java.lang.Iterable<java.lang.String> List of note uris to be fetched.
customProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Custom mapi properties to retrieve.

Returns: com.aspose.ms.System.Collections.Generic.IGenericList<com.aspose.email.MapiNote> - Fetch array of MapiNote objects.

fetchMapiTask(String taskUri)

public abstract MapiTask fetchMapiTask(String taskUri)

Fetches MapiTask object.

Parameters:

Parameter Type Description
taskUri java.lang.String task uri to be fetched.

Returns: MapiTask - MapiTask object.

fetchMapiTask(String taskUri, Iterable customProperties)

public abstract MapiTask fetchMapiTask(String taskUri, Iterable<PropertyDescriptor> customProperties)

Fetches MapiTask object.

Parameters:

Parameter Type Description
taskUri java.lang.String task uri to be fetched.
customProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Custom mapi properties to retrieve.

Returns: MapiTask - MapiTask object.

fetchMapiTasks(Iterable taskUris)

public abstract System.Collections.Generic.IGenericList<MapiTask> fetchMapiTasks(Iterable<String> taskUris)

Fetch array of MapiTask objects.

Parameters:

Parameter Type Description
taskUris java.lang.Iterable<java.lang.String> List of task uris to be fetched.

Returns: com.aspose.ms.System.Collections.Generic.IGenericList<com.aspose.email.MapiTask> - Fetch array of MapiTask objects.

fetchMapiTasks(Iterable taskUris, Iterable customProperties)

public abstract System.Collections.Generic.IGenericList<MapiTask> fetchMapiTasks(Iterable<String> taskUris, Iterable<PropertyDescriptor> customProperties)

Fetch array of MapiTask objects.

Parameters:

Parameter Type Description
taskUris java.lang.Iterable<java.lang.String> List of task uris to be fetched.
customProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Custom mapi properties to retrieve.

Returns: com.aspose.ms.System.Collections.Generic.IGenericList<com.aspose.email.MapiTask> - Fetch array of MapiTask objects.

fetchMessage(String messageUri)

public abstract MailMessage fetchMessage(String messageUri)

Fetches the message.

Parameters:

Parameter Type Description
messageUri java.lang.String The message URI.

Returns: MailMessage - Returns a message

fetchMessage(String messageUri, Iterable extendedProperties)

public abstract MailMessage fetchMessage(String messageUri, Iterable<PropertyDescriptor> extendedProperties)

Fetches the message from server

Parameters:

Parameter Type Description
messageUri java.lang.String The URI of the message
extendedProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> An enumeration of extended properties

Returns: MailMessage - MailMessage that represents e-mail message, if custom properties have been found and set you can access them using MailMessage.Headers (MailMessage.getHeaders) collection.

fetchMessages(ExchangeMessageInfoCollection messageInfos)

public abstract MailMessageCollection fetchMessages(ExchangeMessageInfoCollection messageInfos)

Fetches the speciifed messages

Parameters:

Parameter Type Description
messageInfos ExchangeMessageInfoCollection A IEnumerable{ExchangeMessageInfo}IEnumerable “/> of messages to be retrieved

Returns: MailMessageCollection - A MailMessageCollection containing fetched messages

fetchMessages(System.Collections.Specialized.StringCollection messageUris)

public abstract MailMessageCollection fetchMessages(System.Collections.Specialized.StringCollection messageUris)

Fetches the speciifed messages

Parameters:

Parameter Type Description
messageUris com.aspose.ms.System.Collections.Specialized.StringCollection A StringCollection containing message uris to be retrieved

Returns: MailMessageCollection - A MailMessageCollection containing fetched messages

fetchMessages(Iterable uris)

public abstract MailMessageCollection fetchMessages(Iterable<String> uris)

Fetches the speciifed messages

Parameters:

Parameter Type Description
uris java.lang.Iterable<java.lang.String> A StringCollection containing message uris to be retrieved

Returns: MailMessageCollection - A MailMessageCollection containing fetched messages

fetchMessages(Iterable uris, Iterable extendedProperties)

public abstract MailMessageCollection fetchMessages(Iterable<String> uris, Iterable<PropertyDescriptor> extendedProperties)

Fetches the speciifed messages

Parameters:

Parameter Type Description
uris java.lang.Iterable<java.lang.String> A StringCollection containing message uris to be retrieved
extendedProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> An enumeration of extended properties

Returns: MailMessageCollection - A MailMessageCollection containing fetched messages

fetchTask(String taskUri)

public abstract ExchangeTask fetchTask(String taskUri)

Fetches the specified task.

Parameters:

Parameter Type Description
taskUri java.lang.String A task uri.

Returns: ExchangeTask - A fetched ExchangeTask

findConversations(String folderId)

public abstract ExchangeConversation[] findConversations(String folderId)

Finds conversations in the specified folder

Parameters:

Parameter Type Description
folderId java.lang.String An id of folder in which search

Returns: com.aspose.email.ExchangeConversation[] - An array of found ExchangeConversation

findMessageTrackingReport(FindMessageTrackingReportOptions options)

public abstract MessageTrackingReportInfo[] findMessageTrackingReport(FindMessageTrackingReportOptions options)

Finds messages that meet the specified criteria.

Parameters:

Parameter Type Description
options FindMessageTrackingReportOptions Options specifying a search criteria

Returns: com.aspose.email.MessageTrackingReportInfo[] - An array of MessageTrackingReportInfo that represents message tracking report information

findPeople(String folderUri, MailQuery query, int maxNumberOfItems)

public abstract Contact[] findPeople(String folderUri, MailQuery query, int maxNumberOfItems)

Find contacts located in the specified user’s personal mailbox on server.

Parameters:

Parameter Type Description
folderUri java.lang.String The URI of folder.
query MailQuery MailQuery that represents contact search criteria.
maxNumberOfItems int Maximum number of items.

Returns: com.aspose.email.Contact[] - An array of Contact that represents contact information

findPeople(String queryString, int maxNumberOfItems)

public abstract Contact[] findPeople(String queryString, int maxNumberOfItems)

Find contacts located in the global address list (GAL) on server.

Parameters:

Parameter Type Description
queryString java.lang.String Represents contact search criteria.
maxNumberOfItems int Maximum number of items.

Returns: com.aspose.email.Contact[] - An array of Contact that represents contact information

folderExists(String parentFolderUri, String folderName)

public abstract boolean folderExists(String parentFolderUri, String folderName)

Checks whether the specified folder exists.

Parameters:

Parameter Type Description
parentFolderUri java.lang.String An uri of parent folder.
folderName java.lang.String A folder name.

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

folderExists(String parentFolderUri, String folderName, ExchangeFolderInfo[] folder)

public abstract boolean folderExists(String parentFolderUri, String folderName, ExchangeFolderInfo[] folder)

Checks whether the specified folder exists.

Parameters:

Parameter Type Description
parentFolderUri java.lang.String An uri of parent folder.
folderName java.lang.String A folder name.
folder ExchangeFolderInfo[] A ExchangeFolderInfo that represents the found folder information, if folder exists.

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

forward(MailMessage message, ExchangeMessageInfo referencedMessage)

public abstract void forward(MailMessage message, ExchangeMessageInfo referencedMessage)

Forward a message.

Parameters:

Parameter Type Description
message MailMessage The MailMessage that represents the precomposed forward message.
referencedMessage ExchangeMessageInfo The ExchangeMessageInfo that represents the original message.

forward(MailMessage message, String referencedUri)

public abstract void forward(MailMessage message, String referencedUri)

Forward a message.

Parameters:

Parameter Type Description
message MailMessage The MailMessage that represents the precomposed forward message.
referencedUri java.lang.String The URI that represents the original message.

getCalendarFolderEventFilter()

public abstract int getCalendarFolderEventFilter()

Specifies event types for Calendar folder

Returns: int

getCallInfo(String callId)

public abstract CallInformation getCallInfo(String callId)

Retrieves phone call information by call id

Parameters:

Parameter Type Description
callId java.lang.String call id

Returns: CallInformation - Returns phone call information object

getContact(ObjectIdentifier contactId)

public abstract Contact getContact(ObjectIdentifier contactId)

Retrieves contact information according to specified identifier.

Parameters:

Parameter Type Description
contactId ObjectIdentifier Contact identifier

Returns: Contact - Contact information

getContact(ObjectIdentifier contactId, int options)

public abstract Contact getContact(ObjectIdentifier contactId, int options)

Retrieves contact information according to specified identifier.

Parameters:

Parameter Type Description
contactId ObjectIdentifier Contact identifier
options int Settings for retrieving contact.

Returns: Contact - Contact information

getContact(String contactId)

public abstract Contact getContact(String contactId)

Retrieves contact information according to specified identifier.

Parameters:

Parameter Type Description
contactId java.lang.String Contact identifier

Returns: Contact - Contact information

getContact(String contactId, int options)

public abstract Contact getContact(String contactId, int options)

Retrieves contact information according to specified identifier.

Parameters:

Parameter Type Description
contactId java.lang.String Contact identifier
options int Settings for retrieving contact.

Returns: Contact - Contact information

getContacts(String folder)

public abstract Contact[] getContacts(String folder)

Lists contacts located in the specified folder on server

Parameters:

Parameter Type Description
folder java.lang.String A folder to search contacts in

Returns: com.aspose.email.Contact[] - An array of read Contact that represents contact information

getContacts(String folder, int options)

public abstract Contact[] getContacts(String folder, int options)

Lists contacts located in the specified folder on server

Parameters:

Parameter Type Description
folder java.lang.String A folder to search contacts in
options int Enumerates the list contacts options

Returns: com.aspose.email.Contact[] - An array of read Contact that represents contact information

getContactsFolderEventFilter()

public abstract int getContactsFolderEventFilter()

Specifies event types for Contacts folder

Returns: int

getCurrentCalendarFolderUri()

public abstract String getCurrentCalendarFolderUri()

Gets or sets current calendar folder uri

Returns: java.lang.String

getDeletedItemsFolderEventFilter()

public abstract int getDeletedItemsFolderEventFilter()

Specifies event types for DeletedItems folder

Returns: int

getDraftsFolderEventFilter()

public abstract int getDraftsFolderEventFilter()

Specifies event types for Drafts folder

Returns: int

getEnableDecompression()

public abstract boolean getEnableDecompression()

Gets or sets a value that indicates whether decompression is enabled

Returns: boolean

getExchangeType()

public abstract int getExchangeType()

Gets the information about the current version of MS Exchange.

Returns: int - Returns Exchange server version

getFolderInfo(String folder)

public abstract ExchangeFolderInfo getFolderInfo(String folder)

Gets the folder information

Parameters:

Parameter Type Description
folder java.lang.String A folder uri or distinguished folder name

Returns: ExchangeFolderInfo - A ExchangeFolderInfo that represents the folder information

getFolderPermissions(String folderUrl)

public abstract ExchangePermissionCollection getFolderPermissions(String folderUrl)

Gets the folder permissions.

Parameters:

Parameter Type Description
folderUrl java.lang.String The folder URL.

Returns: ExchangePermissionCollection - The ExchangePermissionCollection

getHeaders()

public abstract System.Collections.Generic.List<System.Collections.Generic.KeyValuePair<String,String>> getHeaders()

Gets array of name value pairs wich are added to WebHeaderCollection in EWS request.

Returns: com.aspose.ms.System.Collections.Generic.List<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String»

getInboxFolderEventFilter()

public abstract int getInboxFolderEventFilter()

Specifies event types for Inbox folder

Returns: int

getInboxRules()

public abstract InboxRule[] getInboxRules()

Gets inbox rules

Returns: com.aspose.email.InboxRule[] - An array of InboxRule

getInboxRules(String mailbox)

public abstract InboxRule[] getInboxRules(String mailbox)

Gets inbox rules

Parameters:

Parameter Type Description
mailbox java.lang.String A mailbox to read inbox rule from. Note: if it is set to null or empty , the rules will be read from the default mailbox

Returns: com.aspose.email.InboxRule[] - An array of InboxRule

getJournalFolderEventFilter()

public abstract int getJournalFolderEventFilter()

Specifies event types for Journal folder

Returns: int

getLogFileName()

public abstract String getLogFileName()

Gets or sets log file name

Returns: java.lang.String

getMailTips(GetMailTipsOptions options)

public abstract MailTips[] getMailTips(GetMailTipsOptions options)

Gets mail tips

Parameters:

Parameter Type Description
options GetMailTipsOptions Options specifying a search criteria

Returns: com.aspose.email.MailTips[] - An array of MailTips

getMailboxInfo()

public abstract ExchangeMailboxInfo getMailboxInfo()

Gets the mailbox info.

Returns: ExchangeMailboxInfo - ExchangeMailboxInfo that represents mailbox information

getMailboxInfo(String mailbox)

public abstract ExchangeMailboxInfo getMailboxInfo(String mailbox)

Gets the mailbox information

Parameters:

Parameter Type Description
mailbox java.lang.String A mailbox to read from.

Returns: ExchangeMailboxInfo - ExchangeMailboxInfo that represents mailbox information

getMailboxSize()

public abstract long getMailboxSize()

Gets the size of the mailbox. Please, note this operation is performed recursively for all subfolders and make take some time

Returns: long - size of the mailbox in bytes

getMailboxSize(String mailbox)

public abstract long getMailboxSize(String mailbox)

Gets the size of the mailbox

Parameters:

Parameter Type Description
mailbox java.lang.String A mailbox.

Returns: long - size of the mailbox in bytes

getMailboxSizeEx(String folderUri)

public abstract 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

Parameters:

Parameter Type Description
folderUri java.lang.String Folder uri

Returns: long - size of the mailbox in bytes

getMailboxUri()

public abstract String getMailboxUri()

Gets or sets the mailbox uri.

Returns: java.lang.String

getMailboxes()

public abstract Contact[] getMailboxes()

Lists mailboxes having smtp addresses. Note: the maximum count of returned contacts is 100. This is a restriction of used EWS operation.

Returns: com.aspose.email.Contact[] - Contacts that represents contact information

getMessageTrackingReport(GetMessageTrackingReportOptions options)

public abstract MessageTrackingReport getMessageTrackingReport(GetMessageTrackingReportOptions options)

Gets message tracking report

Parameters:

Parameter Type Description
options GetMessageTrackingReportOptions Options specifying a search criteria

Returns: MessageTrackingReport - A found MessageTrackingReport or null if no message tracking report was found

getNotesFolderEventFilter()

public abstract int getNotesFolderEventFilter()

Specifies event types for Notes folder

Returns: int

getNotificationTimeout()

public abstract int getNotificationTimeout()

Defines timeout for server notifications

Returns: int

getNotificationsCheckInterval()

public abstract int getNotificationsCheckInterval()

Defines interval for notification check

Returns: int

getOutboxFolderEventFilter()

public abstract int getOutboxFolderEventFilter()

Specifies event types for Outbox folder

Returns: int

getReconnectCount()

public abstract int getReconnectCount()

Gets or sets the number of reconnect attempts at connection breaks.

Returns: int

getReturnClientRequestId()

public abstract boolean getReturnClientRequestId()

Gets or sets a flag to indicate whether the client requires the server side to return the request id.

Returns: boolean

getRootFolderEventFilter()

public abstract int getRootFolderEventFilter()

Specifies event types for Root folder

Returns: int

getSentItemsFolderEventFilter()

public abstract int getSentItemsFolderEventFilter()

Specifies event types for SentItems folder

Returns: int

getServerTimeZoneIds()

public abstract String[] getServerTimeZoneIds()

The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.

Returns: java.lang.String[] - Returns an array of time zone id that are available on an Exchange server.

getServerTimeZoneIds(Iterable timeZoneIds)

public abstract String[] getServerTimeZoneIds(Iterable<String> timeZoneIds)

The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.

Parameters:

Parameter Type Description
timeZoneIds java.lang.Iterable<java.lang.String> Identifiers of time zones for checking existence on the server.

Returns: java.lang.String[] - Returns an array of time zone id that are available on an Exchange server.

getServerTimeZoneIds(String[] timeZoneIds)

public abstract String[] getServerTimeZoneIds(String[] timeZoneIds)

The GetServerTimeZoneIds returns information from time zone id that are available on an Exchange server.

Parameters:

Parameter Type Description
timeZoneIds java.lang.String[] Identifiers of time zones for checking existence on the server.

Returns: java.lang.String[] - Returns an array of time zone id that are available on an Exchange server.

getServerVersion()

public abstract int getServerVersion()

Gets the information about the current version of MS Exchange.

Returns: int

getTasksFolderEventFilter()

public abstract int getTasksFolderEventFilter()

Specifies event types for Tasks folder

Returns: int

getTimezoneId()

public abstract String getTimezoneId()

Gets or sets timezone id

Returns: java.lang.String

getUMConfiguration()

public abstract UnifiedMessagingConfiguration getUMConfiguration()

Retrieves unified messaging configuration

Returns: UnifiedMessagingConfiguration - Returns unified messaging configuration

getUseDateInLogFileName()

public abstract boolean getUseDateInLogFileName()

Gets or sets value which indicates if date has to be used in log file name.

Returns: boolean

getUseSlashAsFolderSeparator()

public abstract boolean getUseSlashAsFolderSeparator()

Gets or sets value that determines whether the slash ‘/’ is used as folder separator.

Returns: boolean

getUserConfiguration(UserConfigurationName userConfigurationName)

public abstract UserConfiguration getUserConfiguration(UserConfigurationName userConfigurationName)

Gets the specified user configuration

Parameters:

Parameter Type Description
userConfigurationName UserConfigurationName Specifies a user configuration to search

Returns: UserConfiguration - A received UserConfiguration

getVersionInfo()

public abstract String getVersionInfo()

Returns exchange server version info

Returns: java.lang.String - Returns exchange server version info

impersonateUser(int valueType, String value)

public abstract void impersonateUser(int valueType, String value)

Impersonates the user.

Parameters:

Parameter Type Description
valueType int The ItemChoiceType enumeration value to use for impersonation.
value java.lang.String The item name.

listAppointments()

public abstract Appointment[] listAppointments()

Retrieves list of appointments for default calendar folder

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointments(boolean recursive)

public abstract Appointment[] listAppointments(boolean recursive)

Retrieves list of appointments for default calendar folder

Parameters:

Parameter Type Description
recursive boolean Indicates whether recursive listing or not.

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointments(MailQuery query)

public abstract Appointment[] listAppointments(MailQuery query)

Retrieves list of appointments for default calendar folder

Parameters:

Parameter Type Description
query MailQuery MailQuery that represents appointments search criteria.

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointments(MailQuery query, boolean recursive)

public abstract Appointment[] listAppointments(MailQuery query, boolean recursive)

Retrieves list of appointments for default calendar folder

Parameters:

Parameter Type Description
query MailQuery MailQuery that represents appointments search criteria.
recursive boolean Indicates whether recursive listing or not.

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointments(String folderUri)

public abstract Appointment[] listAppointments(String folderUri)

Retrieves list of appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointments(String folderUri, boolean recursive)

public abstract Appointment[] listAppointments(String folderUri, boolean recursive)

Retrieves list of appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.
recursive boolean Indicates whether recursive listing or not.

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointments(String folderUri, MailQuery query)

public abstract Appointment[] listAppointments(String folderUri, MailQuery query)

Retrieves list of appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.
query MailQuery MailQuery that represents appointments search criteria.

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointments(String folderUri, MailQuery query, boolean recursive)

public abstract Appointment[] listAppointments(String folderUri, MailQuery query, boolean recursive)

Retrieves list of appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.
query MailQuery MailQuery that represents appointments search criteria.
recursive boolean Indicates whether recursive listing or not.

Returns: com.aspose.email.Appointment[] - Returns array of appointments

listAppointmentsByPage(MailQuery query, int itemsPerPage)

public abstract AppointmentPageInfo listAppointmentsByPage(MailQuery query, int itemsPerPage)

Retrieves page with appointments for calendar folder

Parameters:

Parameter Type Description
query MailQuery MailQuery that represents appointments search criteria.
itemsPerPage int A number of items in page

Returns: AppointmentPageInfo - Returns page with appointments

listAppointmentsByPage(MailQuery query, int itemsPerPage, int itemOffset)

public abstract AppointmentPageInfo listAppointmentsByPage(MailQuery query, int itemsPerPage, int itemOffset)

Retrieves page with appointments for calendar folder

Parameters:

Parameter Type Description
query MailQuery MailQuery that represents appointments search criteria.
itemsPerPage int A number of items in page
itemOffset int An offset of next item in view

Returns: AppointmentPageInfo - Returns page with appointments

listAppointmentsByPage(int itemsPerPage)

public abstract AppointmentPageInfo listAppointmentsByPage(int itemsPerPage)

Retrieves page with appointments for calendar folder

Parameters:

Parameter Type Description
itemsPerPage int A number of items in page

Returns: AppointmentPageInfo - Returns page with appointments

listAppointmentsByPage(int itemsPerPage, int itemOffset)

public abstract AppointmentPageInfo listAppointmentsByPage(int itemsPerPage, int itemOffset)

Retrieves page with appointments for calendar folder

Parameters:

Parameter Type Description
itemsPerPage int A number of items in page
itemOffset int An offset of next item in view

Returns: AppointmentPageInfo - Returns page with appointments

listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage)

public abstract AppointmentPageInfo listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage)

Retrieves page with appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.
query MailQuery MailQuery that represents appointments search criteria.
itemsPerPage int A number of items in page

Returns: AppointmentPageInfo - Returns page with appointments

listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage, int itemOffset)

public abstract AppointmentPageInfo listAppointmentsByPage(String folderUri, MailQuery query, int itemsPerPage, int itemOffset)

Retrieves page with appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.
query MailQuery MailQuery that represents appointments search criteria.
itemsPerPage int A number of items in page
itemOffset int An offset of next item in view

Returns: AppointmentPageInfo - Returns page with appointments

listAppointmentsByPage(String folderUri, int itemsPerPage)

public abstract AppointmentPageInfo listAppointmentsByPage(String folderUri, int itemsPerPage)

Retrieves page with appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.
itemsPerPage int A number of items in page

Returns: AppointmentPageInfo - Returns collection of appointments

listAppointmentsByPage(String folderUri, int itemsPerPage, int itemOffset)

public abstract AppointmentPageInfo listAppointmentsByPage(String folderUri, int itemsPerPage, int itemOffset)

Retrieves page with appointments for specified calendar folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search appointments in.
itemsPerPage int A number of items in page
itemOffset int An offset of next item in view

Returns: AppointmentPageInfo - Returns page with appointments

listContacts(String folderUri)

public abstract MapiContact[] listContacts(String folderUri)

Lists contacts located in the specified folder on server

Parameters:

Parameter Type Description
folderUri java.lang.String The URI of folder

Returns: com.aspose.email.MapiContact[] - An array of read MapiContact that represents contact information

listContacts(String folderUri, Iterable mapiProperties)

public abstract MapiContact[] listContacts(String folderUri, Iterable<PropertyDescriptor> mapiProperties)

Lists contacts located in the specified folder on server

Parameters:

Parameter Type Description
folderUri java.lang.String A folder to search contacts in
mapiProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Required additional mapi properties

Returns: com.aspose.email.MapiContact[] - An array of read MapiContact that represents contact information

listDelegates(String mailbox)

public abstract ExchangeDelegateUserCollection listDelegates(String mailbox)

Lists the users who are granted access on the specified mailbox.

Parameters:

Parameter Type Description
mailbox java.lang.String A mailbox.

Returns: ExchangeDelegateUserCollection - A ExchangeDelegateUserCollection representing the delegate users.

listDistributionLists()

public abstract ExchangeDistributionList[] listDistributionLists()

List the private Distribution Lists.

Returns: com.aspose.email.ExchangeDistributionList[] - An array of ExchangeDistributionList that represents Distribution List information.

listItems(String folder)

public abstract String[] listItems(String folder)

Retrieve list of item uries in specified folder

Parameters:

Parameter Type Description
folder java.lang.String folder to search items

Returns: java.lang.String[] - Returns list of item uries

listItems(String folder, MailQuery query)

public abstract String[] listItems(String folder, MailQuery query)

Retrieve list of item uries in specified folder

Parameters:

Parameter Type Description
folder java.lang.String folder to search items
query MailQuery Additional conditions to select items

Returns: java.lang.String[] - Returns list of item uries

listItems(String folder, MailQuery query, boolean recursive)

public abstract String[] listItems(String folder, MailQuery query, boolean recursive)

Retrieve list of item uries in specified folder

Parameters:

Parameter Type Description
folder java.lang.String folder to search items
query MailQuery Additional conditions to select items
recursive boolean Specifies whether request should be reqursive.

Returns: java.lang.String[] - Returns list of item uries

listItems(String mailbox, String folder)

public abstract String[] listItems(String mailbox, String folder)

Retrieve list of item uries in specified folder

Parameters:

Parameter Type Description
mailbox java.lang.String The mailbox that is used to initialize the folder id class.
folder java.lang.String folder to search items

Returns: java.lang.String[] - Returns list of item uries

listItems(String mailbox, String folder, MailQuery query)

public abstract String[] listItems(String mailbox, String folder, MailQuery query)

Retrieve list of item uries in specified folder

Parameters:

Parameter Type Description
mailbox java.lang.String The mailbox that is used to initialize the folder id class.
folder java.lang.String folder to search items
query MailQuery Additional conditions to select items

Returns: java.lang.String[] - Returns list of item uries

listItems(String mailbox, String folder, MailQuery query, boolean recursive)

public abstract String[] listItems(String mailbox, String folder, MailQuery query, boolean recursive)

Retrieve list of item uries in specified folder

Parameters:

Parameter Type Description
mailbox java.lang.String The mailbox that is used to initialize the folder id class.
folder java.lang.String folder to search items
query MailQuery Additional conditions to select items
recursive boolean Specifies whether request should be reqursive.

Returns: java.lang.String[] - Returns list of item uries

listMailboxes()

public abstract MapiContactCollection listMailboxes()

Lists mailboxes.

Returns: MapiContactCollection - A MapiContactCollection that represents contact information.

listMailboxes(String filter)

public abstract MapiContactCollection listMailboxes(String filter)

Please pay your attention, this overridden method works with Exchange Server 2013 and higher. Lists mailboxes.

Parameters:

Parameter Type Description
filter java.lang.String filter string

Returns: MapiContactCollection - A MapiContactCollection that represents contact information.

listMessages()

public abstract ExchangeMessageInfoCollection listMessages()

List the messages in the inbox folder.

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection from inbox folder.

listMessages(Iterable iDs)

public abstract ExchangeMessageInfoCollection listMessages(Iterable<String> iDs)

List the messages in the specified folder.

Parameters:

Parameter Type Description
iDs java.lang.Iterable<java.lang.String> Enumeration of message ids

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages with.

listMessages(String folder)

public abstract ExchangeMessageInfoCollection listMessages(String folder)

Lists the messages.

Parameters:

Parameter Type Description
folder java.lang.String The folder.

Returns: ExchangeMessageInfoCollection - A ExchangeMessageInfoCollection

listMessages(String folder, boolean recursive)

public abstract ExchangeMessageInfoCollection listMessages(String folder, boolean recursive)

List the messages in the specified folder

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in
recursive boolean Indicates whether recursive listing or not

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder

listMessages(String folder, MailQuery query)

public abstract ExchangeMessageInfoCollection listMessages(String folder, MailQuery query)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
query MailQuery MailQuery that represents message search criteria.

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessages(String folder, MailQuery query, boolean recursive)

public abstract ExchangeMessageInfoCollection listMessages(String folder, MailQuery query, boolean recursive)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
query MailQuery MailQuery that represents message search criteria.
recursive boolean Indicates whether recursive listing or not.

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessages(String folder, int maxNumberOfMessages)

public abstract ExchangeMessageInfoCollection listMessages(String folder, int maxNumberOfMessages)

Lists the messages.

Parameters:

Parameter Type Description
folder java.lang.String The folder.
maxNumberOfMessages int Maximum number of messages

Returns: ExchangeMessageInfoCollection - A ExchangeMessageInfoCollection

listMessages(String folder, int maxNumberOfMessages, MailQuery query)

public abstract ExchangeMessageInfoCollection listMessages(String folder, int maxNumberOfMessages, MailQuery query)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
maxNumberOfMessages int Maximum number of messages.
query MailQuery MailQuery that represents message search criteria.

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessages(String folder, int maxNumberOfMessages, MailQuery query, boolean recursive)

public abstract ExchangeMessageInfoCollection listMessages(String folder, int maxNumberOfMessages, MailQuery query, boolean recursive)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
maxNumberOfMessages int Maximum number of messages.
query MailQuery MailQuery that represents message search criteria.
recursive boolean Indicates whether recursive listing or not.

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessages(String mailbox, String folder, boolean recursive)

public abstract ExchangeMessageInfoCollection listMessages(String mailbox, String folder, boolean recursive)

List the messages in the specified folder

Parameters:

Parameter Type Description
mailbox java.lang.String The mailbox that is used to initialize the folder id class.
folder java.lang.String A folder to search messages in
recursive boolean Indicates whether recursive listing or not

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder

listMessages(String mailbox, String folder, MailQuery query)

public abstract ExchangeMessageInfoCollection listMessages(String mailbox, String folder, MailQuery query)

List the messages in the specified folder.

Parameters:

Parameter Type Description
mailbox java.lang.String The mailbox that is used to initialize the folder id class.
folder java.lang.String A folder to search messages in.
query MailQuery MailQuery that represents message search criteria.

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByMaxNumberOfMessages(String folder, int maxNumberOfMessages)

public abstract ExchangeMessageInfoCollection listMessagesByMaxNumberOfMessages(String folder, int maxNumberOfMessages)

Lists the messages.

Parameters:

Parameter Type Description
folder java.lang.String The folder.
maxNumberOfMessages int Maximum number of messages

Returns: ExchangeMessageInfoCollection - A ExchangeMessageInfoCollection

listMessagesByOption(String folder, int options)

public abstract ExchangeMessageInfoCollection listMessagesByOption(String folder, int options)

Lists the messages.

Parameters:

Parameter Type Description
folder java.lang.String The folder.
options int Specifies the settings of listing

Returns: ExchangeMessageInfoCollection - A ExchangeMessageInfoCollection

listMessagesByOption(String folder, int maxNumberOfMessages, int options)

public abstract ExchangeMessageInfoCollection listMessagesByOption(String folder, int maxNumberOfMessages, int options)

Lists the messages.

Parameters:

Parameter Type Description
folder java.lang.String The folder.
maxNumberOfMessages int Maximum number of messages
options int Specifies the settings of listing

Returns: ExchangeMessageInfoCollection - A ExchangeMessageInfoCollection

listMessagesByPage(String folder, MailQuery query, int itemsPerPage)

public abstract ExchangeMessagePageInfo listMessagesByPage(String folder, MailQuery query, int itemsPerPage)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
query MailQuery MailQuery that represents search criteria.
itemsPerPage int A number of items in page

Returns: ExchangeMessagePageInfo - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByPage(String folder, MailQuery query, int itemsPerPage, int offset)

public abstract ExchangeMessagePageInfo listMessagesByPage(String folder, MailQuery query, int itemsPerPage, int offset)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
query MailQuery MailQuery that represents search criteria.
itemsPerPage int A number of items in page
offset int An offset of next page in view

Returns: ExchangeMessagePageInfo - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByPage(String folder, PageInfo pageInfo)

public abstract ExchangeMessagePageInfo listMessagesByPage(String folder, PageInfo pageInfo)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
pageInfo PageInfo A page info

Returns: ExchangeMessagePageInfo - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByPage(String folder, PageInfo pageInfo, int options)

public abstract ExchangeMessagePageInfo listMessagesByPage(String folder, PageInfo pageInfo, int options)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
pageInfo PageInfo A page info
options int Specifies the settings of listing

Returns: ExchangeMessagePageInfo - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByPage(String folder, int itemsPerPage)

public abstract ExchangeMessagePageInfo listMessagesByPage(String folder, int itemsPerPage)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
itemsPerPage int A number of items in page

Returns: ExchangeMessagePageInfo - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByPage(String folder, int itemsPerPage, int offset)

public abstract ExchangeMessagePageInfo listMessagesByPage(String folder, int itemsPerPage, int offset)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
itemsPerPage int A number of items in page
offset int An offset of next page in view

Returns: ExchangeMessagePageInfo - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByPage(String folder, int itemsPerPage, int pageOffset, int options)

public abstract ExchangeMessagePageInfo listMessagesByPage(String folder, int itemsPerPage, int pageOffset, int options)

List the messages in the specified folder.

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in.
itemsPerPage int A number of items in page
pageOffset int An offset of next item in view
options int Specifies the settings of listing

Returns: ExchangeMessagePageInfo - ExchangeMessageInfoCollection that contains messages from the specified folder.

listMessagesByPropertyDescriptor(String folder, int options, Iterable extendedProperties)

public abstract ExchangeMessageInfoCollection listMessagesByPropertyDescriptor(String folder, int options, Iterable<PropertyDescriptor> extendedProperties)

List the messages in the specified folder

Parameters:

Parameter Type Description
folder java.lang.String A folder to search messages in
options int Specifies the settings of listing
extendedProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> Extended properties of retrieved messages

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder

listMessagesFromPublicFolder(ExchangeFolderInfo folder)

public abstract ExchangeMessageInfoCollection listMessagesFromPublicFolder(ExchangeFolderInfo folder)

Get collection of messages from public folder

Parameters:

Parameter Type Description
folder ExchangeFolderInfo ExchangeFolderInfo that represents information about folder

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder

listMessagesFromPublicFolder(String folderUri)

public abstract ExchangeMessageInfoCollection listMessagesFromPublicFolder(String folderUri)

Get collection of messages from public folder

Parameters:

Parameter Type Description
folderUri java.lang.String The uri of folder

Returns: ExchangeMessageInfoCollection - ExchangeMessageInfoCollection that contains messages from the specified folder

listPublicFolders()

public abstract ExchangeFolderInfoCollection listPublicFolders()

Gets collection of public folders from root public folder

Returns: ExchangeFolderInfoCollection - ExchangeFolderInfoCollection that contains subfolders from the root public folder

listSubFolders(ExchangeFolderInfo parentFolder)

public abstract ExchangeFolderInfoCollection listSubFolders(ExchangeFolderInfo parentFolder)

Gets collection of child public folders from parent

Parameters:

Parameter Type Description
parentFolder ExchangeFolderInfo The parent ExchangeFolderInfo

Returns: ExchangeFolderInfoCollection - ExchangeFolderInfoCollection that contains subfolders from the parent folder

listSubFolders(String parentFolderUri)

public abstract ExchangeFolderInfoCollection listSubFolders(String parentFolderUri)

Gets collection of child folders from parent

Parameters:

Parameter Type Description
parentFolderUri java.lang.String The uri of the parent folder

Returns: ExchangeFolderInfoCollection - ExchangeFolderInfoCollection that contains subfolders from the parent folder

listSubFolders(String mailbox, String parentFolderUri)

public abstract ExchangeFolderInfoCollection listSubFolders(String mailbox, String parentFolderUri)

Gets collection of child folders from parent

Parameters:

Parameter Type Description
mailbox java.lang.String The mailbox that is used to initialize the folder id class.
parentFolderUri java.lang.String A parent folder

Returns: ExchangeFolderInfoCollection - ExchangeFolderInfoCollection that contains subfolders from the parent folder

listSubFoldersByPage(String parentFolderUri, PageInfo page)

public abstract ExchangeFolderPageInfo listSubFoldersByPage(String parentFolderUri, PageInfo page)

Searches the specified folder in the given parent folder with paging Method supports paging.

Parameters:

Parameter Type Description
parentFolderUri java.lang.String A parent folder URI
page PageInfo A page info

Returns: ExchangeFolderPageInfo - A ExchangeFolderPageInfo containing the found folder if folder name is specified; otherwise, returns all subfolders

listSubFoldersByPage(String parentFolderUri, int itemsPerPage)

public abstract ExchangeFolderPageInfo 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.

Parameters:

Parameter Type Description
parentFolderUri java.lang.String A parent folder URI
itemsPerPage int A number of folders in page

Returns: ExchangeFolderPageInfo - A ExchangeFolderPageInfo containing the found folder if folder name is specified; otherwise, returns all subfolders

listSubFoldersByPage(String parentFolderUri, int itemsPerPage, int pageOffset)

public abstract ExchangeFolderPageInfo listSubFoldersByPage(String parentFolderUri, int itemsPerPage, int pageOffset)

Searches the specified folder in the given parent folder with paging Method supports paging.

Parameters:

Parameter Type Description
parentFolderUri java.lang.String A parent folder URI
itemsPerPage int A number of folders in page
pageOffset int An offset of next item in view

Returns: ExchangeFolderPageInfo - A ExchangeFolderPageInfo containing the found folder if folder name is specified; otherwise, returns all subfolders

listTasks()

public abstract TaskCollection listTasks()

Retrieves lists of exchange tasks for default folder.

Returns: TaskCollection - Tasks collection

listTasks(String folder)

public abstract TaskCollection listTasks(String folder)

Retrieves lists of exchange tasks.

Parameters:

Parameter Type Description
folder java.lang.String Tasks folder

Returns: TaskCollection - Tasks collection

listTasks(String folder, MailQuery query)

public abstract TaskCollection listTasks(String folder, MailQuery query)

Retrieves lists of exchange tasks.

Parameters:

Parameter Type Description
folder java.lang.String Tasks folder
query MailQuery Mail query

Returns: TaskCollection - Tasks collection

listTasks(String folder, int maxNumberOfItems)

public abstract TaskCollection listTasks(String folder, int maxNumberOfItems)

Retrieves lists of exchange tasks.

Parameters:

Parameter Type Description
folder java.lang.String Tasks folder
maxNumberOfItems int Maximum number of items

Returns: TaskCollection - Tasks collection

listTasks(String folder, int maxNumberOfItems, MailQuery query)

public abstract TaskCollection listTasks(String folder, int maxNumberOfItems, MailQuery query)

Retrieves lists of exchange tasks.

Parameters:

Parameter Type Description
folder java.lang.String Tasks folder
maxNumberOfItems int Maximum number of items
query MailQuery Mail query

Returns: TaskCollection - Tasks collection

listTasks(String folder, int maxNumberOfItems, MailQuery query, boolean recursive)

public abstract TaskCollection listTasks(String folder, int maxNumberOfItems, MailQuery query, boolean recursive)

Retrieves lists of exchange tasks.

Parameters:

Parameter Type Description
folder java.lang.String Tasks folder
maxNumberOfItems int Maximum number of items
query MailQuery Mail query
recursive boolean Retrieve tasks recursivly

Returns: TaskCollection - Tasks collection

loadContactPhoto(ContactPhoto photo)

public abstract void loadContactPhoto(ContactPhoto photo)

Loads contact photo binary data

Parameters:

Parameter Type Description
photo ContactPhoto contact photo

mailDisablePublicFolder(String folderUri)

public abstract void mailDisablePublicFolder(String folderUri)

Mail-disable a public folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder uri

mailEnablePublicFolder(String folderUri)

public abstract void mailEnablePublicFolder(String folderUri)

Mail-enable a public folder

Parameters:

Parameter Type Description
folderUri java.lang.String A folder uri

markAllItems(boolean read, boolean suppressReadReceipts, Iterable folderIds)

public abstract void markAllItems(boolean read, boolean suppressReadReceipts, Iterable<String> folderIds)

Marks all items in specified folders.

Parameters:

Parameter Type Description
read boolean 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 boolean True to suppress sending read receipts for messages; otherwise, false.
folderIds java.lang.Iterable<java.lang.String> List of folder uri for processing.

markAllItems(boolean read, boolean suppressReadReceipts, String[] folderIds)

public abstract void markAllItems(boolean read, boolean suppressReadReceipts, String[] folderIds)

Marks all items in specified folders.

Parameters:

Parameter Type Description
read boolean 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 boolean True to suppress sending read receipts for messages; otherwise, false.
folderIds java.lang.String[] List of folder uri for processing.

markAllItems(boolean read, String[] folderIds)

public abstract void markAllItems(boolean read, String[] folderIds)

Marks all items in specified folders.

Parameters:

Parameter Type Description
read boolean 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 java.lang.String[] List of folder uri for processing.

markAllItemsAsRead()

public abstract void markAllItemsAsRead()

Marks all items in inbox folder as read without receipts.

markAllItemsAsRead(Iterable folderIds)

public abstract void markAllItemsAsRead(Iterable<String> folderIds)

Marks all items in specified folders as read without receipts.

Parameters:

Parameter Type Description
folderIds java.lang.Iterable<java.lang.String> List of folder uri for processing.

markAllItemsAsRead(String[] folderIds)

public abstract void markAllItemsAsRead(String[] folderIds)

Marks all items in specified folders as read without receipts.

Parameters:

Parameter Type Description
folderIds java.lang.String[] List of folder uri for processing.

markAllItemsAsUnread()

public abstract void markAllItemsAsUnread()

Marks all items in inbox folder as unread.

markAllItemsAsUnread(Iterable folderIds)

public abstract void markAllItemsAsUnread(Iterable<String> folderIds)

Marks all items in specified folders as unread.

Parameters:

Parameter Type Description
folderIds java.lang.Iterable<java.lang.String> List of folder uri for processing.

markAllItemsAsUnread(String[] folderIds)

public abstract void markAllItemsAsUnread(String[] folderIds)

Marks all items in specified folders as unread.

Parameters:

Parameter Type Description
folderIds java.lang.String[] List of folder uri for processing.

markAsJunk(boolean isJunk, boolean moveItem, Iterable messageUriEn)

public abstract String[] markAsJunk(boolean isJunk, boolean moveItem, Iterable<String> messageUriEn)

The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.

Parameters:

Parameter Type Description
isJunk boolean 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 boolean Indicates, whether messages is moved to the junk mail folder.
messageUriEn java.lang.Iterable<java.lang.String> Enumeration of message uri

Returns: java.lang.String[] - Returns the array of message ID which are moved to the junk mail folder.

markAsJunk(boolean isJunk, boolean moveItem, Iterable messageUriEn, String[][] movedMessageIds, String[][] failedMessageIds, String[][] errorMessages)

public abstract 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.

Parameters:

Parameter Type Description
isJunk boolean 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 boolean Indicates, whether messages is moved to the junk mail folder.
messageUriEn java.lang.Iterable<java.lang.String> Enumeration of message uri
movedMessageIds java.lang.String[][] Returns the array of message ID which are moved to the junk mail folder.
failedMessageIds java.lang.String[][] Returns the array of message ID which haven’t been moved to the junk mail folder.
errorMessages java.lang.String[][] Error messages for failed operations

markAsJunk(boolean isJunk, boolean moveItem, String[] messageUriEn)

public abstract String[] markAsJunk(boolean isJunk, boolean moveItem, String[] messageUriEn)

The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.

Parameters:

Parameter Type Description
isJunk boolean 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 boolean Indicates, whether messages is moved to the junk mail folder.
messageUriEn java.lang.String[] Array of message uri

Returns: java.lang.String[] - Returns the array of message ID which are moved to the junk mail folder.

markAsJunk(boolean isJunk, Iterable messageUriEn)

public abstract String[] markAsJunk(boolean isJunk, Iterable<String> messageUriEn)

The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.

Parameters:

Parameter Type Description
isJunk boolean 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 java.lang.Iterable<java.lang.String> Enumeration of message uri

Returns: java.lang.String[] - Returns the item ID of the message marked as junk mail.

markAsJunk(boolean isJunk, String[] messageUriEn)

public abstract String[] markAsJunk(boolean isJunk, String[] messageUriEn)

The MarkAsJunk method moves mail messages to the junk mail folder and blocks message sender.

Parameters:

Parameter Type Description
isJunk boolean 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 java.lang.String[] Array of message uri

Returns: java.lang.String[] - Returns the array of message ID which are moved to the junk mail folder.

moveConversationItems(String conversationId, String destinationFolderId)

public abstract void moveConversationItems(String conversationId, String destinationFolderId)

Moves the conversation items into the specified target folder

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to delete
destinationFolderId java.lang.String Id of folder into which move items

moveConversationItems(String conversationId, String contextFolderId, String destinationFolderId)

public abstract void moveConversationItems(String conversationId, String contextFolderId, String destinationFolderId)

Moves the conversation items, which are located in the specified folder, into the specified target folder

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to move
contextFolderId java.lang.String Id of folder from which move conversation items. Note: If it’s set to null(or empty), all conversation items will be moved
destinationFolderId java.lang.String Id of folder into which move items

moveItem(String itemUri, String destinationFolderUri)

public abstract String moveItem(String itemUri, String destinationFolderUri)

Moves the item to specified folder

Parameters:

Parameter Type Description
itemUri java.lang.String The item URI
destinationFolderUri java.lang.String The destination folder URI

Returns: java.lang.String - An uri of the moved message

playOnPhone(String messageId, String dialString)

public abstract String playOnPhone(String messageId, String dialString)

The PlayOnPhone operation initiates an outbound call and plays a message over the telephone.

Parameters:

Parameter Type Description
messageId java.lang.String Specifies message id.
dialString java.lang.String Specifies telephone to play message.

Returns: java.lang.String - Returns phone call id

removeHeader(String name)

public abstract void removeHeader(String name)

Remove WebHeader from WebHeaderCollection in EWS request.

Parameters:

Parameter Type Description
name java.lang.String Header name

reply(MailMessage message, ExchangeMessageInfo referencedMessage)

public abstract void reply(MailMessage message, ExchangeMessageInfo referencedMessage)

Reply to the sender’s message.

Parameters:

Parameter Type Description
message MailMessage The MailMessage that represents the precomposed reply message.
referencedMessage ExchangeMessageInfo The ExchangeMessageInfo that represents the original message.

reply(MailMessage message, String referencedUri)

public abstract void reply(MailMessage message, String referencedUri)

Reply to the sender’s message.

Parameters:

Parameter Type Description
message MailMessage The MailMessage that represents the precomposed reply message.
referencedUri java.lang.String The URI that represents the original message.

replyAll(MailMessage message, ExchangeMessageInfo referencedMessage)

public abstract void replyAll(MailMessage message, ExchangeMessageInfo referencedMessage)

Reply to the sender and all recipients of a message.

Parameters:

Parameter Type Description
message MailMessage The MailMessage that represents the precomposed reply message.
referencedMessage ExchangeMessageInfo The ExchangeMessageInfo that represents the original message.

resetImpersonation()

public abstract void resetImpersonation()

Makes the impersonation reset.

resetSubscription()

public abstract void resetSubscription()

Reset all subscriptions

resolveContact(String unresolvedEntry)

public abstract MapiContactCollection resolveContact(String unresolvedEntry)

Resolves ambiguous mailbox names.

Parameters:

Parameter Type Description
unresolvedEntry java.lang.String A name of contact to resolve.

Returns: MapiContactCollection - A MapiContactCollection that represents contacts information.

resolveContacts(String unresolvedEntry)

public abstract 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.

Parameters:

Parameter Type Description
unresolvedEntry java.lang.String A name of contact to resolve.

Returns: com.aspose.email.Contact[] - An array of Contact objects.

resolveContacts(String unresolvedEntry, int options)

public abstract 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.

Parameters:

Parameter Type Description
unresolvedEntry java.lang.String A name of contact to resolve
options int Enumerates the list contacts options

Returns: com.aspose.email.Contact[] - Contacts that represents contacts information

restore(PersonalStorage pst, RestoreSettings settings)

public abstract void restore(PersonalStorage pst, RestoreSettings settings)

Restores the specified exchange folders from the given personal storage.

Parameters:

Parameter Type Description
pst PersonalStorage A personal storage containing the backuped exchange folders.
settings RestoreSettings The restore settings.

saveMessage(String messageUri, OutputStream stream)

public abstract void saveMessage(String messageUri, OutputStream stream)

Saves the message.

Parameters:

Parameter Type Description
messageUri java.lang.String The message URI.
stream java.io.OutputStream The stream.

saveMessage(String messageUri, String path)

public abstract void saveMessage(String messageUri, String path)

Saves the message.

Parameters:

Parameter Type Description
messageUri java.lang.String The message URI.
path java.lang.String The path to save message.

saveMessageInternal(String messageUri, System.IO.Stream stream)

public abstract void saveMessageInternal(String messageUri, System.IO.Stream stream)

Parameters:

Parameter Type Description
messageUri java.lang.String
stream com.aspose.ms.System.IO.Stream

send(MailMessage message)

public abstract void send(MailMessage message)

Sends the specified message.

Parameters:

Parameter Type Description
message MailMessage The message.

send(MailMessage message, FollowUpOptions messageOptions)

public abstract void send(MailMessage message, FollowUpOptions messageOptions)

Sends the message.

Parameters:

Parameter Type Description
message MailMessage The MailMessage to be sent.
messageOptions FollowUpOptions The FollowUpOptions that represents additional options for using follow-up flags and voting buttons.

send(String from, String to, String subject, String body)

public abstract void send(String from, String to, String subject, String body)

Sends the specified message

Parameters:

Parameter Type Description
from java.lang.String From address
to java.lang.String To address
subject java.lang.String The subject of message
body java.lang.String The body of message

setCalendarFolderEventFilter(int value)

public abstract void setCalendarFolderEventFilter(int value)

Specifies event types for Calendar folder

Parameters:

Parameter Type Description
value int

setContactsFolderEventFilter(int value)

public abstract void setContactsFolderEventFilter(int value)

Specifies event types for Contacts folder

Parameters:

Parameter Type Description
value int

setConversationReadState(String conversationId, boolean isRead)

public abstract void setConversationReadState(String conversationId, boolean isRead)

Set read state of the conversation items to the specified value

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to be changed
isRead boolean A flag that enables setting the read state of items in a conversation.

setConversationReadState(String conversationId, String contextFolderId, boolean isRead)

public abstract 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

Parameters:

Parameter Type Description
conversationId java.lang.String Id of conversation to be changed
contextFolderId java.lang.String Id of folder in which conversation items are located. Note: If it’s set to null(or empty), all conversation items will be copied
isRead boolean A flag that enables setting the read state of items in a conversation.

setCurrentCalendarFolderUri(String value)

public abstract void setCurrentCalendarFolderUri(String value)

Gets or sets current calendar folder uri

Parameters:

Parameter Type Description
value java.lang.String

setDeletedItemsFolderEventFilter(int value)

public abstract void setDeletedItemsFolderEventFilter(int value)

Specifies event types for DeletedItems folder

Parameters:

Parameter Type Description
value int

setDraftsFolderEventFilter(int value)

public abstract void setDraftsFolderEventFilter(int value)

Specifies event types for Drafts folder

Parameters:

Parameter Type Description
value int

setEnableDecompression(boolean value)

public abstract void setEnableDecompression(boolean value)

Gets or sets a value that indicates whether decompression is enabled

Parameters:

Parameter Type Description
value boolean

setInboxFolderEventFilter(int value)

public abstract void setInboxFolderEventFilter(int value)

Specifies event types for Inbox folder

Parameters:

Parameter Type Description
value int

setJournalFolderEventFilter(int value)

public abstract void setJournalFolderEventFilter(int value)

Specifies event types for Journal folder

Parameters:

Parameter Type Description
value int

setLogFileName(String value)

public abstract void setLogFileName(String value)

Gets or sets log file name

Parameters:

Parameter Type Description
value java.lang.String

setMailboxUri(String value)

public abstract void setMailboxUri(String value)

Gets or sets the mailbox uri.

Parameters:

Parameter Type Description
value java.lang.String

setNotesFolderEventFilter(int value)

public abstract void setNotesFolderEventFilter(int value)

Specifies event types for Notes folder

Parameters:

Parameter Type Description
value int

setNotificationTimeout(int value)

public abstract void setNotificationTimeout(int value)

Defines timeout for server notifications

Parameters:

Parameter Type Description
value int

setNotificationsCheckInterval(int value)

public abstract void setNotificationsCheckInterval(int value)

Defines interval for notification check

Parameters:

Parameter Type Description
value int

setOutboxFolderEventFilter(int value)

public abstract void setOutboxFolderEventFilter(int value)

Specifies event types for Outbox folder

Parameters:

Parameter Type Description
value int

setReadFlag(String messageUri)

public abstract void setReadFlag(String messageUri)

Sets the read flag.

Parameters:

Parameter Type Description
messageUri java.lang.String The message URI.

setReadFlag(String messageUri, boolean isRead)

public abstract void setReadFlag(String messageUri, boolean isRead)

Marks the specifeid message as read.

Parameters:

Parameter Type Description
messageUri java.lang.String A message uri.
isRead boolean A value indicating whether the message was read

setReconnectCount(int value)

public abstract void setReconnectCount(int value)

Gets or sets the number of reconnect attempts at connection breaks.

Parameters:

Parameter Type Description
value int

setReturnClientRequestId(boolean value)

public abstract void setReturnClientRequestId(boolean value)

Gets or sets a flag to indicate whether the client requires the server side to return the request id.

Parameters:

Parameter Type Description
value boolean

setRootFolderEventFilter(int value)

public abstract void setRootFolderEventFilter(int value)

Specifies event types for Root folder

Parameters:

Parameter Type Description
value int

setSentItemsFolderEventFilter(int value)

public abstract void setSentItemsFolderEventFilter(int value)

Specifies event types for SentItems folder

Parameters:

Parameter Type Description
value int

setTasksFolderEventFilter(int value)

public abstract void setTasksFolderEventFilter(int value)

Specifies event types for Tasks folder

Parameters:

Parameter Type Description
value int

setTimezoneId(String value)

public abstract void setTimezoneId(String value)

Gets or sets timezone id

Parameters:

Parameter Type Description
value java.lang.String

setUseDateInLogFileName(boolean value)

public abstract void setUseDateInLogFileName(boolean value)

Gets or sets value which indicates if date has to be used in log file name.

Parameters:

Parameter Type Description
value boolean

setUseSlashAsFolderSeparator(boolean value)

public abstract void setUseSlashAsFolderSeparator(boolean value)

Gets or sets value that determines whether the slash ‘/’ is used as folder separator.

Parameters:

Parameter Type Description
value boolean

syncFolder(SyncState syncState)

public abstract SyncFolderResult syncFolder(SyncState syncState)

Retrieves changes of the items in a specified folder.

Parameters:

Parameter Type Description
syncState SyncState The synchronization state.

Returns: SyncFolderResult - Returns result of SyncFolder operation.

syncFolder(String folderUri)

public abstract SyncFolderResult syncFolder(String folderUri)

Retrieves changes of the items and subfolders in a specified folder.

Parameters:

Parameter Type Description
folderUri java.lang.String The folder uri

Returns: SyncFolderResult - Returns result of SyncFolder operation.

syncFolder(String folderUri, int syncType)

public abstract SyncFolderResult syncFolder(String folderUri, int syncType)

Retrieves changes of the items and subfolders in a specified folder.

Parameters:

Parameter Type Description
folderUri java.lang.String The folder uri
syncType int Folder synchronization type

Returns: SyncFolderResult - Returns result of SyncFolder operation.

syncFolder(String folderUri, String syncState)

public abstract SyncFolderResult syncFolder(String folderUri, String syncState)

Retrieves changes of the items in a specified folder.

Parameters:

Parameter Type Description
folderUri java.lang.String The folder uri
syncState java.lang.String The optional synchronization state. Must be null for first synchronization.

Returns: SyncFolderResult - Returns result of SyncFolder operation.

syncFolder(String folderUri, String syncState, Iterable ignoreList)

public abstract SyncFolderResult syncFolder(String folderUri, String syncState, Iterable<String> ignoreList)

Retrieves changes of the items in a specified folder.

Parameters:

Parameter Type Description
folderUri java.lang.String The folder uri
syncState java.lang.String The optional synchronization state. Must be null for first synchronization.
ignoreList java.lang.Iterable<java.lang.String> The optional list of item uris that should be ignored.

Returns: SyncFolderResult - Returns result of SyncFolder operation.

updateAppointment(Appointment appointment)

public abstract void updateAppointment(Appointment appointment)

Updates appointment.

Parameters:

Parameter Type Description
appointment Appointment Calendar appointment.

updateAppointment(Appointment appointment, String folderUri)

public abstract void updateAppointment(Appointment appointment, String folderUri)

Updates appointment.

Parameters:

Parameter Type Description
appointment Appointment Calendar appointment.
folderUri java.lang.String An uri of appointments parent folder.

updateAppointment(MapiCalendar appointment)

public abstract void updateAppointment(MapiCalendar appointment)

Updates appointment.

Parameters:

Parameter Type Description
appointment MapiCalendar Calendar appointment.

updateAppointment(MapiCalendar appointment, String folderUri)

public abstract void updateAppointment(MapiCalendar appointment, String folderUri)

Updates appointment.

Parameters:

Parameter Type Description
appointment MapiCalendar Calendar appointment.
folderUri java.lang.String An uri of appointments parent folder.

updateContact(Contact contact)

public abstract void updateContact(Contact contact)

Updates a contact item in the Exchange store.

Parameters:

Parameter Type Description
contact Contact Contact item

updateContact(MapiContact contact)

public abstract void updateContact(MapiContact contact)

Updates a contact item in the Exchange store.

Parameters:

Parameter Type Description
contact MapiContact Contact item

updateDelegate(ExchangeDelegateUser delegateUser, String mailbox)

public abstract void updateDelegate(ExchangeDelegateUser delegateUser, String mailbox)

Updates the delegate user settings who is granted access on the specified mailbox.

Parameters:

Parameter Type Description
delegateUser ExchangeDelegateUser A new settings of delegate user.
mailbox java.lang.String A mailbox on which the delegate user is granted access.

updateDelegates(ExchangeDelegateUserCollection delegateUsers, String mailbox)

public abstract void updateDelegates(ExchangeDelegateUserCollection delegateUsers, String mailbox)

Updates the delegate users settings who are granted access on the specified mailbox.

Parameters:

Parameter Type Description
delegateUsers ExchangeDelegateUserCollection A ExchangeDelegateUserCollection containing the new settings of delegates.
mailbox java.lang.String A mailbox on which the delegate users are granted access.

updateInboxRule(InboxRule rule)

public abstract void updateInboxRule(InboxRule rule)

Updates the specified inbox rule

Parameters:

Parameter Type Description
rule InboxRule A inbox rule to update

updateInboxRule(InboxRule rule, String mailbox)

public abstract void updateInboxRule(InboxRule rule, String mailbox)

Updates the specified inbox rule

Parameters:

Parameter Type Description
rule InboxRule A inbox rule to update
mailbox java.lang.String A mailbox where rule is located. Note: if it is set to null or empty , the rule will be searched in the default mailbox

updateItems(ExchangeStreamedItem[] items, String parentFolderUri)

public abstract ExchangeUploadItemResult[] updateItems(ExchangeStreamedItem[] items, String parentFolderUri)

Updates the specified items in to a mailbox

Parameters:

Parameter Type Description
items ExchangeStreamedItem[] An items to be updated
parentFolderUri java.lang.String Specifies the folder that contains the items to update

Returns: com.aspose.email.ExchangeUploadItemResult[] - An array of ExchangeUploadItemResult

updateNote(MapiNote note)

public abstract String updateNote(MapiNote note)

Updates the specified note.

Parameters:

Parameter Type Description
note MapiNote An MapiNote containing the note information.

Returns: java.lang.String - Note uri.

updateNote(String uri, MapiNote note)

public abstract String updateNote(String uri, MapiNote note)

Updates the specified note.

Parameters:

Parameter Type Description
uri java.lang.String Note identifier
note MapiNote An MapiNote containing the note information.

Returns: java.lang.String - Note uri.

updateNote(String uri, MapiNote note, Iterable additionalProperties)

public abstract String updateNote(String uri, MapiNote note, Iterable<PropertyDescriptor> additionalProperties)

Updates the specified note.

Parameters:

Parameter Type Description
uri java.lang.String Note identifier
note MapiNote An MapiNote containing the note information.
additionalProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> An additional MAPI properties which can be used in MAPI object.

Returns: java.lang.String - Note uri.

updateSubscription()

public abstract void updateSubscription()

Updates subscriptions

updateTask(ExchangeTask task)

public abstract void updateTask(ExchangeTask task)

Updates the specified task.

Parameters:

Parameter Type Description
task ExchangeTask An ExchangeTask containing the task information.

updateTask(ExchangeTask task, int options)

public abstract void updateTask(ExchangeTask task, int options)

Updates the specified task.

Parameters:

Parameter Type Description
task ExchangeTask An ExchangeTask containing the task information.
options int An updation options.

updateTask(MapiTask task)

public abstract String updateTask(MapiTask task)

Updates the specified task.

Parameters:

Parameter Type Description
task MapiTask An MapiTask containing the task information.

Returns: java.lang.String - Task uri.

updateTask(String uri, MapiTask task)

public abstract String updateTask(String uri, MapiTask task)

Updates the specified task.

Parameters:

Parameter Type Description
uri java.lang.String Task identifier
task MapiTask An ExchangeTask containing the task information.

Returns: java.lang.String - Task uri.

updateTask(String uri, MapiTask task, Iterable additionalProperties)

public abstract String updateTask(String uri, MapiTask task, Iterable<PropertyDescriptor> additionalProperties)

Updates the specified task.

Parameters:

Parameter Type Description
uri java.lang.String Task identifier
task MapiTask An ExchangeTask containing the task information.
additionalProperties java.lang.Iterable<com.aspose.email.PropertyDescriptor> An additional MAPI properties which can be used in MAPI object.

Returns: java.lang.String - Task uri.

updateUserConfiguration(UserConfiguration userConfiguration)

public abstract void updateUserConfiguration(UserConfiguration userConfiguration)

Updates the specified user configuration

Parameters:

Parameter Type Description
userConfiguration UserConfiguration UserConfiguration to update