ExchangeService (Exchange Web Services Java API 2.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

microsoft.exchange.webservices.data.core
Class ExchangeService

java.lang.Object
  microsoft.exchange.webservices.data.core.ExchangeServiceBase
      microsoft.exchange.webservices.data.core.ExchangeService

All Implemented Interfaces:: Closeable, IAutodiscoverRedirectionUrl

public class ExchangeService
extends ExchangeServiceBase
implements IAutodiscoverRedirectionUrl
extends ExchangeServiceBase
implements IAutodiscoverRedirectionUrl

Represents a binding to the Exchange Web Services.

Field Summary

Fields inherited from class microsoft.exchange.webservices.data.core.ExchangeServiceBase
`httpClient, httpContext, httpPoolingClient`

Constructor Summary
`ExchangeService()` Initializes a new instance of the class, targeting the specified version of EWS and scoped to the to the system's current time zone.
`ExchangeService(ExchangeVersion requestedServerVersion)` Initializes a new instance of the class, targeting the specified version of EWS and scoped to the system's current time zone.

Method Summary

Collection<DelegateUserResponse> addDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, DelegateUser... delegateUsers)
Adds delegates to a specific mailbox.

Collection<DelegateUserResponse> addDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, Iterable<DelegateUser> delegateUsers)
Adds delegates to a specific mailbox.

boolean autodiscoverRedirectionUrlValidationCallback(String redirectionUrl)
Autodiscover redirection url validation callback.

void autodiscoverUrl(String emailAddress)
Initializes the Url property to the Exchange Web Services URL for the specified e-mail address by calling the Autodiscover service.

void autodiscoverUrl(String emailAddress, IAutodiscoverRedirectionUrl validateRedirectionUrlCallback)
Initializes the Url property to the Exchange Web Services URL for the specified e-mail address by calling the Autodiscover service.

IAsyncResult beginGetEvents(AsyncCallback callback, Object state, String subscriptionId, String watermark)
Begins an asynchronous request to retrieve the latest events associated with a pull subscription.

AsyncRequestResult beginSubscribeToPullNotifications(AsyncCallback callback, Object state, Iterable<FolderId> folderIds, int timeout, String watermark, EventType... eventTypes)
Begins an asynchronous request to subscribes to pull notification.

IAsyncResult beginSubscribeToPullNotificationsOnAllFolders(AsyncCallback callback, Object state, int timeout, String watermark, EventType... eventTypes)
Begins an asynchronous request to subscribe to pull notification on all folder in the authenticated user's mailbox.

IAsyncResult beginSubscribeToPushNotifications(AsyncCallback callback, Object state, Iterable<FolderId> folderIds, URI url, int frequency, String watermark, EventType... eventTypes)
Begins an asynchronous request to subscribe to push notification.

IAsyncResult beginSubscribeToPushNotificationsOnAllFolders(AsyncCallback callback, Object state, URI url, int frequency, String watermark, EventType... eventTypes)
Begins an asynchronous request to subscribe to push notification on all folder in the authenticated user's mailbox.

IAsyncResult beginSubscribeToStreamingNotifications(AsyncCallback callback, Object state, Iterable<FolderId> folderIds, EventType... eventTypes)
Begins an asynchronous request to subscribe to streaming notification.

IAsyncResult beginSubscribeToStreamingNotificationsOnAllFolders(AsyncCallback callback, Object state, EventType... eventTypes)
Begins an asynchronous request to subscribe to streaming notification on all folder in the authenticated user's mailbox.

IAsyncResult beginSyncFolderHierarchy(AsyncCallback callback, Object state, FolderId syncFolderId, PropertySet propertySet, String syncState)
Begins an asynchronous request to synchronize the sub-folder of a specific folder.

IAsyncResult beginSyncFolderItems(AsyncCallback callback, Object state, FolderId syncFolderId, PropertySet propertySet, Iterable<ItemId> ignoredItemIds, int maxChangesReturned, SyncFolderItemsScope syncScope, String syncState)
Begins an asynchronous request to synchronize the item of a specific folder.

IAsyncResult beginUnsubscribe(AsyncCallback callback, Object state, String subscriptionId)
Begins an asynchronous request to unsubscribe from a subscription.





<TFolder extends Folder> 


TFolder

bindToFolder(Class<TFolder> cls,
                         FolderId folderId,
                         PropertySet propertySet)

Binds to folder.

Folder bindToFolder(FolderId folderId, PropertySet propertySet)
Binds to a folder.





<TItem extends Item> 


TItem

bindToItem(Class<TItem> c,
                     ItemId itemId,
                     PropertySet propertySet)

Bind to item.

Item bindToItem(ItemId itemId, PropertySet propertySet)
Binds to multiple item in a single call to EWS.

ServiceResponseCollection<GetItemResponse> bindToItems(Iterable<ItemId> itemIds, PropertySet propertySet)
Binds to multiple item in a single call to EWS.

AlternateIdBase convertId(AlternateIdBase id, IdFormat destinationFormat)
Converts Id from one format to another in a single call to EWS.

ServiceResponseCollection<ConvertIdResponse> convertIds(Iterable<AlternateIdBase> ids, IdFormat destinationFormat)
Converts multiple Ids from one format to another in a single call to EWS.

Folder copyFolder(FolderId folderId, FolderId destinationFolderId)
Copies a folder.

Item copyItem(ItemId itemId, FolderId destinationFolderId)
Copies an item.

ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds, FolderId destinationFolderId)
Copies multiple item in a single call to EWS.

ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds, FolderId destinationFolderId, boolean returnNewItemIds)
Copies multiple item in a single call to EWS.

ServiceResponseCollection<ServiceResponse> copyItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, FolderId destinationFolderId)
Copies the item in the specified conversation to the specified destination folder.

ServiceResponseCollection<CreateAttachmentResponse> createAttachments(String parentItemId, Iterable<Attachment> attachments)
Creates attachments.

void createFolder(Folder folder, FolderId parentFolderId)
Creates a folder.

void createItem(Item item, FolderId parentFolderId, MessageDisposition messageDisposition, SendInvitationsMode sendInvitationsMode)
Creates an item.

ServiceResponseCollection<ServiceResponse> createItems(Collection<Item> items, FolderId parentFolderId, MessageDisposition messageDisposition, SendInvitationsMode sendInvitationsMode)
Creates multiple item in a single EWS call.

void createUserConfiguration(UserConfiguration userConfiguration)
Creates the user configuration.

ServiceResponseCollection<DeleteAttachmentResponse> deleteAttachments(Iterable<Attachment> attachments)
Deletes attachments.

void deleteFolder(FolderId folderId, DeleteMode deleteMode)
Deletes a folder.

void deleteItem(ItemId itemId, DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences)
Deletes an item.

ServiceResponseCollection<ServiceResponse> deleteItems(Iterable<ItemId> itemIds, DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences)
Deletes multiple item in a single call to EWS.

ServiceResponseCollection<ServiceResponse> deleteItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, DeleteMode deleteMode)
Deletes the item in the specified conversation.

void deleteUserConfiguration(String name, FolderId parentFolderId)
Creates a UserConfiguration.

ServiceResponseCollection<ServiceResponse> disableAlwaysCategorizeItemsInConversations(Iterable<ConversationId> conversationId, boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is no longer categorized.

ServiceResponseCollection<ServiceResponse> disableAlwaysDeleteItemsInConversations(Iterable<ConversationId> conversationId, boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is no longer moved to Deleted Items folder.

ServiceResponseCollection<ServiceResponse> disableAlwaysMoveItemsInConversations(Iterable<ConversationId> conversationIds, boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is no longer moved to a specific folder.

void emptyFolder(FolderId folderId, DeleteMode deleteMode, boolean deleteSubFolders)
Empties a folder.

ServiceResponseCollection<ServiceResponse> enableAlwaysCategorizeItemsInConversations(Iterable<ConversationId> conversationId, Iterable<String> categories, boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is always categorized.

ServiceResponseCollection<ServiceResponse> enableAlwaysDeleteItemsInConversations(Iterable<ConversationId> conversationId, boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is always moved to Deleted Items folder.

ServiceResponseCollection<ServiceResponse> enableAlwaysMoveItemsInConversations(Iterable<ConversationId> conversationId, FolderId destinationFolderId, boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is always moved to a specific folder.

GetEventsResults endGetEvents(IAsyncResult asyncResult)
Ends an asynchronous request to retrieve the latest events associated with a pull subscription.

PullSubscription endSubscribeToPullNotifications(IAsyncResult asyncResult)
Ends an asynchronous request to subscribe to pull notification in the authenticated user's mailbox.

PushSubscription endSubscribeToPushNotifications(IAsyncResult asyncResult)
Ends an asynchronous request to subscribe to push notification in the authenticated user's mailbox.

StreamingSubscription endSubscribeToStreamingNotifications(IAsyncResult asyncResult)
Ends an asynchronous request to subscribe to push notification in the authenticated user's mailbox.

ChangeCollection<FolderChange> endSyncFolderHierarchy(IAsyncResult asyncResult)
Ends an asynchronous request to synchronize the specified folder hierarchy of the mailbox this Service is connected to.

ChangeCollection<ItemChange> endSyncFolderItems(IAsyncResult asyncResult)
Ends an asynchronous request to synchronize the item of a specific folder.

void endUnsubscribe(IAsyncResult asyncResult)
Ends an asynchronous request to unsubscribe from a subscription.

protected Document executeDiagnosticMethod(String verb, Node parameter)
Executes the diagnostic method.

ExpandGroupResults expandGroup(EmailAddress emailAddress)
Expands a group by retrieving a list of its members.

ExpandGroupResults expandGroup(ItemId groupId)
Expands a group by retrieving a list of its members.

ExpandGroupResults expandGroup(String smtpAddress)
Expands a group by retrieving a list of its members.

ExpandGroupResults expandGroup(String address, String routingType)
Expands a group by retrieving a list of its members.

FindItemsResults<Appointment> findAppointments(FolderId parentFolderId, CalendarView calendarView)
Obtains a list of appointments by searching the contents of a specific folder.

FindItemsResults<Appointment> findAppointments(WellKnownFolderName parentFolderName, CalendarView calendarView)
Obtains a list of appointments by searching the contents of a specific folder.

Collection<Conversation> findConversation(ConversationIndexedItemView view, FolderId folderId)
Retrieves a collection of all Conversations in the specified Folder.

FindFoldersResults findFolders(FolderId parentFolderId, FolderView view)
Obtains a list of folder by searching the sub-folder of the specified folder.

FindFoldersResults findFolders(FolderId parentFolderId, SearchFilter searchFilter, FolderView view)
Obtains a list of folder by searching the sub-folder of the specified folder.

FindFoldersResults findFolders(WellKnownFolderName parentFolderName, FolderView view)
Obtains a list of folder by searching the sub-folder of the specified folder.

FindFoldersResults findFolders(WellKnownFolderName parentFolderName, SearchFilter searchFilter, FolderView view)
Obtains a list of folder by searching the sub-folder of the specified folder.

protected 



<TItem extends Item> 


ServiceResponseCollection<FindItemResponse<TItem>>

findItems(Class<TItem> cls,
                   FolderId parentFolderId,
                   SearchFilter searchFilter,
                   ViewBase view,
                   Grouping groupBy)

Obtains a grouped list of item by searching the contents of a specific folder.

FindItemsResults<Item> findItems(FolderId parentFolderId, ItemView view)
Obtains a list of item by searching the contents of a specific folder.

GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, ItemView view, Grouping groupBy)
Obtains a grouped list of item by searching the contents of a specific folder.

FindItemsResults<Item> findItems(FolderId parentFolderId, SearchFilter searchFilter, ItemView view)
Obtains a list of item by searching the contents of a specific folder.

GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, SearchFilter searchFilter, ItemView view, Grouping groupBy)
Obtains a grouped list of item by searching the contents of a specific folder.

FindItemsResults<Item> findItems(FolderId parentFolderId, String queryString, ItemView view)
Obtains a list of item by searching the contents of a specific folder.

GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, String queryString, ItemView view, Grouping groupBy)
Obtains a grouped list of item by searching the contents of a specific folder.





<TItem extends Item> 


ServiceResponseCollection<FindItemResponse<TItem>>

findItems(Iterable<FolderId> parentFolderIds,
                   SearchFilter searchFilter,
                   String queryString,
                   ViewBase view,
                   Grouping groupBy,
                   ServiceErrorHandling errorHandlingMode)

Finds item.

FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, ItemView view)
Obtains a list of item by searching the contents of a specific folder.

FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, SearchFilter searchFilter, ItemView view)
Obtains a list of item by searching the contents of a specific folder.

GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, SearchFilter searchFilter, ItemView view, Grouping groupBy)
Obtains a grouped list of item by searching the contents of a specific folder.

FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, String queryString, ItemView view)
Obtains a list of item by searching the contents of a specific folder.

GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, String queryString, ItemView view, Grouping groupBy)
Obtains a grouped list of item by searching the contents of a specific folder.

void getAttachment(Attachment attachment, BodyType bodyType, Iterable<PropertyDefinitionBase> additionalProperties)
Gets the attachment.

protected ServiceResponseCollection<GetAttachmentResponse> getAttachments(Attachment[] attachments, BodyType bodyType, Iterable<PropertyDefinitionBase> additionalProperties)
Gets attachments.

DateTimePrecision getDateTimePrecision()
Gets the DateTime precision for DateTime values returned from Exchange Web Services.

DelegateInformation getDelegates(Mailbox mailbox, boolean includePermissions, Iterable<UserId> userIds)
Retrieves the delegates of a specific mailbox.

DelegateInformation getDelegates(Mailbox mailbox, boolean includePermissions, UserId... userIds)
Retrieves the delegates of a specific mailbox.

boolean getEnableScpLookup()
Gets or sets a value indicating whether the AutodiscoverUrl method should perform SCP (Service Connection Point) record lookup when determining the Autodiscover service URL.

GetEventsResults getEvents(String subscriptionId, String waterMark)
Retrieves the latests events associated with a pull subscription.

boolean getExchange2007CompatibilityMode()
Returns true whether Exchange2007 compatibility mode is enabled, false otherwise.

IFileAttachmentContentHandler getFileAttachmentContentHandler()
Gets the file attachment content handler.

ImpersonatedUserId getImpersonatedUserId()
Gets the impersonated user id.

RuleCollection getInboxRules()
Retrieves inbox rules of the authenticated user.

RuleCollection getInboxRules(String mailboxSmtpAddress)
Retrieves the inbox rules of the specified user.

Date getPasswordExpirationDate(String mailboxSmtpAddress)
Get the password expiration date

Locale getPreferredCulture()
Gets the preferred culture.

EmailAddressCollection getRoomLists()
Retrieves a collection of all room lists in the organization.

Collection<EmailAddress> getRooms(EmailAddress emailAddress)
Retrieves a collection of all room lists in the specified room list in the organization.

Collection<TimeZoneDefinition> getServerTimeZones()
Retrieves the definitions of all server-side time zones.

Collection<TimeZoneDefinition> getServerTimeZones(Iterable<String> timeZoneIds)
Retrieves the definitions of the specified server-side time zones.

UnifiedMessaging getUnifiedMessaging()
Provides access to the Unified Messaging functionalities.

URI getUrl()
Gets the URL of the Exchange Web Services.

GetUserAvailabilityResults getUserAvailability(Iterable<AttendeeInfo> attendees, TimeWindow timeWindow, AvailabilityData requestedData)
Gets detailed information about the availability of a set of users, rooms, and resources within a specified time window.

GetUserAvailabilityResults getUserAvailability(Iterable<AttendeeInfo> attendees, TimeWindow timeWindow, AvailabilityData requestedData, AvailabilityOptions options)
Gets detailed information about the availability of a set of users, rooms, and resources within a specified time window.

UserConfiguration getUserConfiguration(String name, FolderId parentFolderId, UserConfigurationProperties properties)
Creates a UserConfiguration.

OofSettings getUserOofSettings(String smtpAddress)
Gets Out of Office (OOF) settings for a specific user.

List<Item> internalCreateResponseObject(ServiceObject responseObject, FolderId parentFolderId, MessageDisposition messageDisposition)
Create response object.

ServiceResponseCollection<ServiceResponse> internalLoadPropertiesForItems(Iterable<Item> items, PropertySet propertySet, ServiceErrorHandling errorHandling)
Loads the property of multiple item in a single call to EWS.

void loadPropertiesForFolder(Folder folder, PropertySet propertySet)
Load specified property for a folder.

ServiceResponseCollection<ServiceResponse> loadPropertiesForItems(Iterable<Item> items, PropertySet propertySet)
Loads the property of multiple item in a single call to EWS.

void loadPropertiesForUserConfiguration(UserConfiguration userConfiguration, UserConfigurationProperties properties)
Loads the property of the specified userConfiguration.

Folder moveFolder(FolderId folderId, FolderId destinationFolderId)
Move a folder.

Item moveItem(ItemId itemId, FolderId destinationFolderId)
Copies multiple item in a single call to EWS.

ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds, FolderId destinationFolderId)
Moves multiple item in a single call to EWS.

ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds, FolderId destinationFolderId, boolean returnNewItemIds)
Moves multiple item in a single call to EWS.

ServiceResponseCollection<ServiceResponse> moveItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, FolderId destinationFolderId)
Moves the item in the specified conversation to the specified destination folder.

HttpWebRequest prepareHttpPoolingWebRequest()
Prepares a http web request from a pooling connection manager, used for subscriptions.

HttpWebRequest prepareHttpWebRequest()
Prepare http web request.

void processHttpErrorResponse(HttpWebRequest httpWebResponse, Exception webException)
Processes an HTTP error response.

Collection<DelegateUserResponse> removeDelegates(Mailbox mailbox, Iterable<UserId> userIds)
Removes delegates on a specific mailbox.

Collection<DelegateUserResponse> removeDelegates(Mailbox mailbox, UserId... userIds)
Removes delegates on a specific mailbox.

NameResolutionCollection resolveName(String nameToResolve)
Finds contacts in the user's Contacts folder and the Global Address List (in that order) that have names that match the one passed as a parameter.

NameResolutionCollection resolveName(String nameToResolve, Iterable<FolderId> parentFolderIds, ResolveNameSearchLocation searchScope, boolean returnContactDetails)
Finds contacts in the user's Contacts folder and the Global Address List (in that order) that have names that match the one passed as a parameter.

NameResolutionCollection resolveName(String nameToResolve, Iterable<FolderId> parentFolderIds, ResolveNameSearchLocation searchScope, boolean returnContactDetails, PropertySet contactDataPropertySet)
Finds contacts in the Global Address List and/or in specific contact folder that have names that match the one passed as a parameter.

NameResolutionCollection resolveName(String nameToResolve, ResolveNameSearchLocation searchScope, boolean returnContactDetails)
Finds contacts in the user's Contacts folder and the Global Address List (in that order) that have names that match the one passed as a parameter.

NameResolutionCollection resolveName(String nameToResolve, ResolveNameSearchLocation searchScope, boolean returnContactDetails, PropertySet contactDataPropertySet)
Finds contacts in the Global Address List that have names that match the one passed as a parameter.

void sendItem(Item item, FolderId savedCopyDestinationFolderId)
Send item.

void setDateTimePrecision(DateTimePrecision d)
Sets the DateTime precision for DateTime values Web Services.

void setEnableScpLookup(boolean value)

void setExchange2007CompatibilityMode(boolean value)
Set the flag indicating if the Exchange2007 compatibility mode is enabled.

void setFileAttachmentContentHandler(IFileAttachmentContentHandler fileAttachmentContentHandler)
Sets the file attachment content handler.

void setImpersonatedUserId(ImpersonatedUserId impersonatedUserId)
Sets the impersonated user id.

void setPreferredCulture(DateTimePrecision dateTimePrecision)
Sets the DateTime precision for DateTime values returned from Exchange Web Services.

void setPreferredCulture(Locale preferredCulture)
Sets the preferred culture.

ServiceResponseCollection<ServiceResponse> setReadStateForItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, boolean isRead)
Sets the read state for item in conversation.

void setUrl(URI url)
Sets the URL of the Exchange Web Services.

void setUserOofSettings(String smtpAddress, OofSettings oofSettings)
Sets Out of Office (OOF) settings for a specific user.

PullSubscription subscribeToPullNotifications(Iterable<FolderId> folderIds, int timeout, String watermark, EventType... eventTypes)
Subscribes to pull notification.

PullSubscription subscribeToPullNotificationsOnAllFolders(int timeout, String watermark, EventType... eventTypes)
Subscribes to pull notification on all folder in the authenticated user's mailbox.

PushSubscription subscribeToPushNotifications(Iterable<FolderId> folderIds, URI url, int frequency, String watermark, EventType... eventTypes)
Subscribes to push notification.

PushSubscription subscribeToPushNotificationsOnAllFolders(URI url, int frequency, String watermark, EventType... eventTypes)
Subscribes to push notification on all folder in the authenticated user's mailbox.

StreamingSubscription subscribeToStreamingNotifications(Iterable<FolderId> folderIds, EventType... eventTypes)
Subscribes to streaming notification.

StreamingSubscription subscribeToStreamingNotificationsOnAllFolders(EventType... eventTypes)
Subscribes to streaming notification on all folder in the authenticated user's mailbox.

ChangeCollection<FolderChange> syncFolderHierarchy(FolderId syncFolderId, PropertySet propertySet, String syncState)
Synchronizes the sub-folder of a specific folder.

ChangeCollection<FolderChange> syncFolderHierarchy(PropertySet propertySet, String syncState)
Synchronizes the entire folder hierarchy of the mailbox this Service is connected to.

ChangeCollection<ItemChange> syncFolderItems(FolderId syncFolderId, PropertySet propertySet, Iterable<ItemId> ignoredItemIds, int maxChangesReturned, SyncFolderItemsScope syncScope, String syncState)
Synchronizes the item of a specific folder.

void unsubscribe(String subscriptionId)
Unsubscribes from a pull subscription.

Collection<DelegateUserResponse> updateDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, DelegateUser... delegateUsers)
Updates delegates on a specific mailbox.

Collection<DelegateUserResponse> updateDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, Iterable<DelegateUser> delegateUsers)
Updates delegates on a specific mailbox.

void updateFolder(Folder folder)
Updates a folder.

void updateInboxRules(Iterable<RuleOperation> operations, boolean removeOutlookRuleBlob)
Updates the authenticated user's inbox rules by applying the specified operations.

void updateInboxRules(Iterable<RuleOperation> operations, boolean removeOutlookRuleBlob, String mailboxSmtpAddress)
Updates the authenticated user's inbox rules by applying the specified operations.

Item updateItem(Item item, FolderId savedItemsDestinationFolderId, ConflictResolutionMode conflictResolution, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
Updates an item.

ServiceResponseCollection<UpdateItemResponse> updateItems(Iterable<Item> items, FolderId savedItemsDestinationFolderId, ConflictResolutionMode conflictResolution, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
Updates multiple item in a single EWS call.

void updateUserConfiguration(UserConfiguration userConfiguration)
Updates a UserConfiguration.

void validate()
Validates this instance.

Methods inherited from class microsoft.exchange.webservices.data.core.ExchangeServiceBase
checkURIPath, close, convertDateTimeToUniversalDateTimeString, createConnectionSocketFactoryRegistry, doOnSerializeCustomSoapHeaders, getAcceptGzipEncoding, getCredentials, getHttpHeaders, getHttpResponseHeaders, getOnSerializeCustomSoapHeaders, getRequestedServerVersion, getServerInfo, getSessionKey, getTimeout, getTraceFlags, getTraceListener, getUseDefaultCredentials, getUserAgent, getWebProxy, internalProcessHttpErrorResponse, isPreAuthenticate, isTraceEnabled, isTraceEnabledFor, prepareCredentials, prepareHttpPoolingWebRequestForUrl, prepareHttpWebRequestForUrl, processHttpResponseHeaders, setAcceptGzipEncoding, setCredentials, setCustomUserAgent, setMaximumPoolingConnections, setOnSerializeCustomSoapHeaders, setPreAuthenticate, setServerInfo, setTimeout, setTraceEnabled, setTraceFlags, setTraceListener, setUseDefaultCredentials, setUserAgent, setWebProxy, traceHttpRequestHeaders, traceMessage, traceXml

Methods inherited from class microsoft.exchange.webservices.data.core.ExchangeServiceBase

checkURIPath, close, convertDateTimeToUniversalDateTimeString, createConnectionSocketFactoryRegistry, doOnSerializeCustomSoapHeaders, getAcceptGzipEncoding, getCredentials, getHttpHeaders, getHttpResponseHeaders, getOnSerializeCustomSoapHeaders, getRequestedServerVersion, getServerInfo, getSessionKey, getTimeout, getTraceFlags, getTraceListener, getUseDefaultCredentials, getUserAgent, getWebProxy, internalProcessHttpErrorResponse, isPreAuthenticate, isTraceEnabled, isTraceEnabledFor, prepareCredentials, prepareHttpPoolingWebRequestForUrl, prepareHttpWebRequestForUrl, processHttpResponseHeaders, setAcceptGzipEncoding, setCredentials, setCustomUserAgent, setMaximumPoolingConnections, setOnSerializeCustomSoapHeaders, setPreAuthenticate, setServerInfo, setTimeout, setTraceEnabled, setTraceFlags, setTraceListener, setUseDefaultCredentials, setUserAgent, setWebProxy, traceHttpRequestHeaders, traceMessage, traceXml

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ExchangeService

public ExchangeService()

Initializes a new instance of the class, targeting the specified version of EWS and scoped to the to the system's current time zone.

ExchangeService

public ExchangeService(ExchangeVersion requestedServerVersion)

Initializes a new instance of the class, targeting the specified version of EWS and scoped to the system's current time zone.

Parameters:: requestedServerVersion - the requested server version

Method Detail

internalCreateResponseObject

public List<Item> internalCreateResponseObject(ServiceObject responseObject,
                                               FolderId parentFolderId,
                                               MessageDisposition messageDisposition)
                                        throws Exception

Create response object.

Parameters:: responseObject - the response object; parentFolderId - the parent folder id; messageDisposition - the message disposition
Returns:: The list of item created or modified as a result of the "creation" of the response object.
Throws:: Exception - the exception

createFolder

public void createFolder(Folder folder,
                         FolderId parentFolderId)
                  throws Exception

Creates a folder. Calling this method results in a call to EWS.

Parameters:: folder - The folder.; parentFolderId - The parent folder Id
Throws:: Exception - the exception

updateFolder

public void updateFolder(Folder folder)
                  throws Exception

Updates a folder.

Parameters:: folder - The folder.
Throws:: Exception - the exception

copyFolder

public Folder copyFolder(FolderId folderId,
                         FolderId destinationFolderId)
                  throws Exception

Copies a folder. Calling this method results in a call to EWS.

Parameters:: folderId - The folderId.; destinationFolderId - The destination folder id.
Returns:: the folder
Throws:: Exception - the exception

moveFolder

public Folder moveFolder(FolderId folderId,
                         FolderId destinationFolderId)
                  throws Exception

Move a folder.

Parameters:: folderId - The folderId.; destinationFolderId - The destination folder id.
Returns:: the folder
Throws:: Exception - the exception

findFolders

public FindFoldersResults findFolders(FolderId parentFolderId,
                                      SearchFilter searchFilter,
                                      FolderView view)
                               throws Exception

Obtains a list of folder by searching the sub-folder of the specified folder.

Parameters:: parentFolderId - The Id of the folder in which to search for folder.; searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection; view - The view controlling the number of folder returned.
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findFolders

public FindFoldersResults findFolders(FolderId parentFolderId,
                                      FolderView view)
                               throws Exception

Obtains a list of folder by searching the sub-folder of the specified folder.

Parameters:: parentFolderId - The Id of the folder in which to search for folder.; view - The view controlling the number of folder returned.
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findFolders

public FindFoldersResults findFolders(WellKnownFolderName parentFolderName,
                                      SearchFilter searchFilter,
                                      FolderView view)
                               throws Exception

Obtains a list of folder by searching the sub-folder of the specified folder.

Parameters:: parentFolderName - The name of the folder in which to search for folder.; searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection; view - The view controlling the number of folder returned.
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findFolders

public FindFoldersResults findFolders(WellKnownFolderName parentFolderName,
                                      FolderView view)
                               throws Exception

Obtains a list of folder by searching the sub-folder of the specified folder.

Parameters:: parentFolderName - the parent folder name; view - the view
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

loadPropertiesForFolder

public void loadPropertiesForFolder(Folder folder,
                                    PropertySet propertySet)
                             throws Exception

Load specified property for a folder.

Parameters:: folder - The folder; propertySet - The property set
Throws:: Exception - the exception

bindToFolder

public Folder bindToFolder(FolderId folderId,
                           PropertySet propertySet)
                    throws Exception

Binds to a folder.

Parameters:: folderId - the folder id; propertySet - the property set
Returns:: Folder
Throws:: Exception - the exception

bindToFolder

public <TFolder extends Folder> TFolder bindToFolder(Class<TFolder> cls,
                                                     FolderId folderId,
                                                     PropertySet propertySet)
                                    throws Exception

Binds to folder.

Type Parameters:: TFolder - The type of the folder.
Parameters:: cls - Folder class; folderId - The folder id.; propertySet - The property set.
Returns:: Folder
Throws:: Exception - the exception

deleteFolder

public void deleteFolder(FolderId folderId,
                         DeleteMode deleteMode)
                  throws Exception

Deletes a folder. Calling this method results in a call to EWS.

Parameters:: folderId - The folder id; deleteMode - The delete mode
Throws:: Exception - the exception

emptyFolder

public void emptyFolder(FolderId folderId,
                        DeleteMode deleteMode,
                        boolean deleteSubFolders)
                 throws Exception

Empties a folder. Calling this method results in a call to EWS.

Parameters:: folderId - The folder id; deleteMode - The delete mode; deleteSubFolders - if set to "true" empty folder should also delete sub folder.
Throws:: Exception - the exception

createItems

public ServiceResponseCollection<ServiceResponse> createItems(Collection<Item> items,
                                                              FolderId parentFolderId,
                                                              MessageDisposition messageDisposition,
                                                              SendInvitationsMode sendInvitationsMode)
                                                       throws Exception

Creates multiple item in a single EWS call. Supported item classes are EmailMessage, Appointment, Contact, PostItem, Task and Item. CreateItems does not support item that have unsaved attachments.

Parameters:: items - the item; parentFolderId - the parent folder id; messageDisposition - the message disposition; sendInvitationsMode - the send invitations mode
Returns:: A ServiceResponseCollection providing creation results for each of the specified item.
Throws:: Exception - the exception

createItem

public void createItem(Item item,
                       FolderId parentFolderId,
                       MessageDisposition messageDisposition,
                       SendInvitationsMode sendInvitationsMode)
                throws Exception

Creates an item. Calling this method results in a call to EWS.

Parameters:: item - the item; parentFolderId - the parent folder id; messageDisposition - the message disposition; sendInvitationsMode - the send invitations mode
Throws:: Exception - the exception

updateItems

public ServiceResponseCollection<UpdateItemResponse> updateItems(Iterable<Item> items,
                                                                 FolderId savedItemsDestinationFolderId,
                                                                 ConflictResolutionMode conflictResolution,
                                                                 MessageDisposition messageDisposition,
                                                                 SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
                                                          throws Exception

Updates multiple item in a single EWS call. UpdateItems does not support item that have unsaved attachments.

Parameters:: items - the item; savedItemsDestinationFolderId - the saved item destination folder id; conflictResolution - the conflict resolution; messageDisposition - the message disposition; sendInvitationsOrCancellationsMode - the send invitations or cancellations mode
Returns:: A ServiceResponseCollection providing update results for each of the specified item.
Throws:: Exception - the exception

updateItem

public Item updateItem(Item item,
                       FolderId savedItemsDestinationFolderId,
                       ConflictResolutionMode conflictResolution,
                       MessageDisposition messageDisposition,
                       SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
                throws Exception

Updates an item.

Parameters:: item - the item; savedItemsDestinationFolderId - the saved item destination folder id; conflictResolution - the conflict resolution; messageDisposition - the message disposition; sendInvitationsOrCancellationsMode - the send invitations or cancellations mode
Returns:: A ServiceResponseCollection providing deletion results for each of the specified item Ids.
Throws:: Exception - the exception

sendItem

public void sendItem(Item item,
                     FolderId savedCopyDestinationFolderId)
              throws Exception

Send item.

Parameters:: item - the item; savedCopyDestinationFolderId - the saved copy destination folder id
Throws:: Exception - the exception

copyItems

public ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds,
                                                                 FolderId destinationFolderId)
                                                          throws Exception

Copies multiple item in a single call to EWS.

Parameters:: itemIds - the item ids; destinationFolderId - the destination folder id
Returns:: A ServiceResponseCollection providing copy results for each of the specified item Ids.
Throws:: Exception - the exception

copyItems

public ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds,
                                                                 FolderId destinationFolderId,
                                                                 boolean returnNewItemIds)
                                                          throws Exception

Copies multiple item in a single call to EWS.

Parameters:: itemIds - The Ids of the item to copy.; destinationFolderId - The Id of the folder to copy the item to.; returnNewItemIds - Flag indicating whether service should return new ItemIds or not.
Returns:: A ServiceResponseCollection providing copy results for each of the specified item Ids.
Throws:: Exception - on error

copyItem

public Item copyItem(ItemId itemId,
                     FolderId destinationFolderId)
              throws Exception

Copies an item. Calling this method results in a call to EWS.

Parameters:: itemId - The Id of the item to copy.; destinationFolderId - The folder in which to save sent messages, meeting invitations or cancellations. If null, the message, meeting invitation or cancellation is saved in the Sent Items folder
Returns:: The copy of the item.
Throws:: Exception - the exception

moveItems

public ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds,
                                                                 FolderId destinationFolderId)
                                                          throws Exception

Moves multiple item in a single call to EWS.

Parameters:: itemIds - the item ids; destinationFolderId - the destination folder id
Returns:: A ServiceResponseCollection providing copy results for each of the specified item Ids.
Throws:: Exception - the exception

moveItems

public ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds,
                                                                 FolderId destinationFolderId,
                                                                 boolean returnNewItemIds)
                                                          throws Exception

Moves multiple item in a single call to EWS.

Parameters:: itemIds - The Ids of the item to move.; destinationFolderId - The Id of the folder to move the item to.; returnNewItemIds - Flag indicating whether service should return new ItemIds or not.
Returns:: A ServiceResponseCollection providing copy results for each of the specified item Ids.
Throws:: Exception - on error

moveItem

public Item moveItem(ItemId itemId,
                     FolderId destinationFolderId)
              throws Exception

Copies multiple item in a single call to EWS.

Parameters:: itemId - the item id; destinationFolderId - the destination folder id
Returns:: A ServiceResponseCollection providing copy results for each of the specified item Ids.
Throws:: Exception - the exception

findItems

public <TItem extends Item> ServiceResponseCollection<FindItemResponse<TItem>> findItems(Iterable<FolderId> parentFolderIds,
                                                                                         SearchFilter searchFilter,
                                                                                         String queryString,
                                                                                         ViewBase view,
                                                                                         Grouping groupBy,
                                                                                         ServiceErrorHandling errorHandlingMode)
                                                                          throws Exception

Finds item.

Type Parameters:: TItem - The type of item
Parameters:: parentFolderIds - The parent folder ids.; searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection; queryString - the query string; view - The view controlling the number of folder returned.; groupBy - The group by.; errorHandlingMode - Indicates the type of error handling should be done.
Returns:: Service response collection.
Throws:: Exception - the exception

findItems

public FindItemsResults<Item> findItems(FolderId parentFolderId,
                                        String queryString,
                                        ItemView view)
                                 throws Exception

Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:: parentFolderId - the parent folder id; queryString - the query string; view - the view
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findItems

public FindItemsResults<Item> findItems(FolderId parentFolderId,
                                        SearchFilter searchFilter,
                                        ItemView view)
                                 throws Exception

Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:: parentFolderId - the parent folder id; searchFilter - the search filter; view - the view
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findItems

public FindItemsResults<Item> findItems(FolderId parentFolderId,
                                        ItemView view)
                                 throws Exception

Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:: parentFolderId - the parent folder id; view - the view
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findItems

public FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName,
                                        String queryString,
                                        ItemView view)
                                 throws Exception

Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:: parentFolderName - the parent folder name; queryString - the query string; view - the view
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findItems

public FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName,
                                        SearchFilter searchFilter,
                                        ItemView view)
                                 throws Exception

Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:: parentFolderName - the parent folder name; searchFilter - the search filter; view - the view
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception

findItems

public FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName,
                                        ItemView view)
                                 throws Exception

Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:: parentFolderName - the parent folder name; view - the view
Returns:: An object representing the results of the search operation.
Throws:: Exception - the exception