public class ExchangeService extends ExchangeServiceBase implements IAutodiscoverRedirectionUrl
httpClient, httpContext, httpPoolingClient
Constructor and Description |
---|
ExchangeService()
Initializes a new instance of the
|
ExchangeService(ExchangeVersion requestedServerVersion)
Initializes a new instance of the
|
Modifier and Type | Method and Description |
---|---|
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> |
bindToFolder(Class<TFolder> cls,
FolderId folderId,
PropertySet propertySet)
Binds to folder.
|
Folder |
bindToFolder(FolderId folderId,
PropertySet propertySet)
Binds to a folder.
|
<TItem extends Item> |
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> |
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> |
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.
|
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
public ExchangeService()
public ExchangeService(ExchangeVersion requestedServerVersion)
requestedServerVersion
- the requested server versionpublic List<Item> internalCreateResponseObject(ServiceObject responseObject, FolderId parentFolderId, MessageDisposition messageDisposition) throws Exception
responseObject
- the response objectparentFolderId
- the parent folder idmessageDisposition
- the message dispositionException
- the exceptionpublic void createFolder(Folder folder, FolderId parentFolderId) throws Exception
folder
- The folder.parentFolderId
- The parent folder IdException
- the exceptionpublic void updateFolder(Folder folder) throws Exception
folder
- The folder.Exception
- the exceptionpublic Folder copyFolder(FolderId folderId, FolderId destinationFolderId) throws Exception
folderId
- The folderId.destinationFolderId
- The destination folder id.Exception
- the exceptionpublic Folder moveFolder(FolderId folderId, FolderId destinationFolderId) throws Exception
folderId
- The folderId.destinationFolderId
- The destination folder id.Exception
- the exceptionpublic FindFoldersResults findFolders(FolderId parentFolderId, SearchFilter searchFilter, FolderView view) throws Exception
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.SearchFilterCollectionview
- The view controlling the number of folder returned.Exception
- the exceptionpublic FindFoldersResults findFolders(FolderId parentFolderId, FolderView view) throws Exception
parentFolderId
- The Id of the folder in which to search for folder.view
- The view controlling the number of folder returned.Exception
- the exceptionpublic FindFoldersResults findFolders(WellKnownFolderName parentFolderName, SearchFilter searchFilter, FolderView view) throws Exception
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.SearchFilterCollectionview
- The view controlling the number of folder returned.Exception
- the exceptionpublic FindFoldersResults findFolders(WellKnownFolderName parentFolderName, FolderView view) throws Exception
parentFolderName
- the parent folder nameview
- the viewException
- the exceptionpublic void loadPropertiesForFolder(Folder folder, PropertySet propertySet) throws Exception
folder
- The folderpropertySet
- The property setException
- the exceptionpublic Folder bindToFolder(FolderId folderId, PropertySet propertySet) throws Exception
folderId
- the folder idpropertySet
- the property setException
- the exceptionpublic <TFolder extends Folder> TFolder bindToFolder(Class<TFolder> cls, FolderId folderId, PropertySet propertySet) throws Exception
TFolder
- The type of the folder.cls
- Folder classfolderId
- The folder id.propertySet
- The property set.Exception
- the exceptionpublic void deleteFolder(FolderId folderId, DeleteMode deleteMode) throws Exception
folderId
- The folder iddeleteMode
- The delete modeException
- the exceptionpublic void emptyFolder(FolderId folderId, DeleteMode deleteMode, boolean deleteSubFolders) throws Exception
folderId
- The folder iddeleteMode
- The delete modedeleteSubFolders
- if set to "true" empty folder should also delete sub folder.Exception
- the exceptionpublic ServiceResponseCollection<ServiceResponse> createItems(Collection<Item> items, FolderId parentFolderId, MessageDisposition messageDisposition, SendInvitationsMode sendInvitationsMode) throws Exception
items
- the itemparentFolderId
- the parent folder idmessageDisposition
- the message dispositionsendInvitationsMode
- the send invitations modeException
- the exceptionpublic void createItem(Item item, FolderId parentFolderId, MessageDisposition messageDisposition, SendInvitationsMode sendInvitationsMode) throws Exception
item
- the itemparentFolderId
- the parent folder idmessageDisposition
- the message dispositionsendInvitationsMode
- the send invitations modeException
- the exceptionpublic ServiceResponseCollection<UpdateItemResponse> updateItems(Iterable<Item> items, FolderId savedItemsDestinationFolderId, ConflictResolutionMode conflictResolution, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode) throws Exception
items
- the itemsavedItemsDestinationFolderId
- the saved item destination folder idconflictResolution
- the conflict resolutionmessageDisposition
- the message dispositionsendInvitationsOrCancellationsMode
- the send invitations or cancellations modeException
- the exceptionpublic Item updateItem(Item item, FolderId savedItemsDestinationFolderId, ConflictResolutionMode conflictResolution, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode) throws Exception
item
- the itemsavedItemsDestinationFolderId
- the saved item destination folder idconflictResolution
- the conflict resolutionmessageDisposition
- the message dispositionsendInvitationsOrCancellationsMode
- the send invitations or cancellations modeException
- the exceptionpublic void sendItem(Item item, FolderId savedCopyDestinationFolderId) throws Exception
item
- the itemsavedCopyDestinationFolderId
- the saved copy destination folder idException
- the exceptionpublic ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds, FolderId destinationFolderId) throws Exception
itemIds
- the item idsdestinationFolderId
- the destination folder idException
- the exceptionpublic ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds, FolderId destinationFolderId, boolean returnNewItemIds) throws Exception
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.Exception
- on errorpublic Item copyItem(ItemId itemId, FolderId destinationFolderId) throws Exception
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 folderException
- the exceptionpublic ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds, FolderId destinationFolderId) throws Exception
itemIds
- the item idsdestinationFolderId
- the destination folder idException
- the exceptionpublic ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds, FolderId destinationFolderId, boolean returnNewItemIds) throws Exception
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.Exception
- on errorpublic Item moveItem(ItemId itemId, FolderId destinationFolderId) throws Exception
itemId
- the item iddestinationFolderId
- the destination folder idException
- the exceptionpublic <TItem extends Item> ServiceResponseCollection<FindItemResponse<TItem>> findItems(Iterable<FolderId> parentFolderIds, SearchFilter searchFilter, String queryString, ViewBase view, Grouping groupBy, ServiceErrorHandling errorHandlingMode) throws Exception
TItem
- The type of itemparentFolderIds
- The parent folder ids.searchFilter
- The search filter. Available search filter classes include
SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and
SearchFilter.SearchFilterCollectionqueryString
- the query stringview
- The view controlling the number of folder returned.groupBy
- The group by.errorHandlingMode
- Indicates the type of error handling should be done.Exception
- the exceptionpublic FindItemsResults<Item> findItems(FolderId parentFolderId, String queryString, ItemView view) throws Exception
parentFolderId
- the parent folder idqueryString
- the query stringview
- the viewException
- the exceptionpublic FindItemsResults<Item> findItems(FolderId parentFolderId, SearchFilter searchFilter, ItemView view) throws Exception
parentFolderId
- the parent folder idsearchFilter
- the search filterview
- the viewException
- the exceptionpublic FindItemsResults<Item> findItems(FolderId parentFolderId, ItemView view) throws Exception
parentFolderId
- the parent folder idview
- the viewException
- the exceptionpublic FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, String queryString, ItemView view) throws Exception
parentFolderName
- the parent folder namequeryString
- the query stringview
- the viewException
- the exceptionpublic FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, SearchFilter searchFilter, ItemView view) throws Exception
parentFolderName
- the parent folder namesearchFilter
- the search filterview
- the viewException
- the exceptionpublic FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, ItemView view) throws Exception
parentFolderName
- the parent folder nameview
- the viewException
- the exceptionpublic GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, String queryString, ItemView view, Grouping groupBy) throws Exception
parentFolderId
- the parent folder idqueryString
- the query stringview
- the viewgroupBy
- the group byException
- the exceptionpublic GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, SearchFilter searchFilter, ItemView view, Grouping groupBy) throws Exception
parentFolderId
- the parent folder idsearchFilter
- the search filterview
- the viewgroupBy
- the group byException
- the exceptionpublic GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, ItemView view, Grouping groupBy) throws Exception
parentFolderId
- the parent folder idview
- the viewgroupBy
- the group byException
- the exceptionprotected <TItem extends Item> ServiceResponseCollection<FindItemResponse<TItem>> findItems(Class<TItem> cls, FolderId parentFolderId, SearchFilter searchFilter, ViewBase view, Grouping groupBy) throws Exception
TItem
- the generic typecls
- the clsparentFolderId
- the parent folder idsearchFilter
- the search filterview
- the viewgroupBy
- the group byException
- the exceptionpublic GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, String queryString, ItemView view, Grouping groupBy) throws Exception
parentFolderName
- the parent folder namequeryString
- the query stringview
- the viewgroupBy
- the group byException
- the exceptionpublic GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, SearchFilter searchFilter, ItemView view, Grouping groupBy) throws Exception
parentFolderName
- the parent folder namesearchFilter
- the search filterview
- the viewgroupBy
- the group byException
- the exceptionpublic FindItemsResults<Appointment> findAppointments(FolderId parentFolderId, CalendarView calendarView) throws Exception
parentFolderId
- the parent folder idcalendarView
- the calendar viewException
- the exceptionpublic FindItemsResults<Appointment> findAppointments(WellKnownFolderName parentFolderName, CalendarView calendarView) throws Exception
parentFolderName
- the parent folder namecalendarView
- the calendar viewException
- the exceptionpublic ServiceResponseCollection<ServiceResponse> loadPropertiesForItems(Iterable<Item> items, PropertySet propertySet) throws Exception
items
- the itempropertySet
- the property setException
- the exceptionpublic ServiceResponseCollection<ServiceResponse> internalLoadPropertiesForItems(Iterable<Item> items, PropertySet propertySet, ServiceErrorHandling errorHandling) throws Exception
items
- the itempropertySet
- the property seterrorHandling
- the error handlingException
- the exceptionpublic ServiceResponseCollection<GetItemResponse> bindToItems(Iterable<ItemId> itemIds, PropertySet propertySet) throws Exception
itemIds
- the item idspropertySet
- the property setException
- the exceptionpublic Item bindToItem(ItemId itemId, PropertySet propertySet) throws Exception
itemId
- the item idpropertySet
- the property setException
- the exceptionpublic <TItem extends Item> TItem bindToItem(Class<TItem> c, ItemId itemId, PropertySet propertySet) throws Exception
TItem
- The type of the item.c
- the citemId
- the item idpropertySet
- the property setException
- the exceptionpublic ServiceResponseCollection<ServiceResponse> deleteItems(Iterable<ItemId> itemIds, DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences) throws Exception
itemIds
- the item idsdeleteMode
- the delete modesendCancellationsMode
- the send cancellations modeaffectedTaskOccurrences
- the affected task occurrencesException
- the exceptionpublic void deleteItem(ItemId itemId, DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences) throws Exception
itemId
- the item iddeleteMode
- the delete modesendCancellationsMode
- the send cancellations modeaffectedTaskOccurrences
- the affected task occurrencesException
- the exceptionprotected ServiceResponseCollection<GetAttachmentResponse> getAttachments(Attachment[] attachments, BodyType bodyType, Iterable<PropertyDefinitionBase> additionalProperties) throws Exception
attachments
- the attachmentsbodyType
- the body typeadditionalProperties
- the additional propertyException
- on errorpublic void getAttachment(Attachment attachment, BodyType bodyType, Iterable<PropertyDefinitionBase> additionalProperties) throws Exception
attachment
- the attachmentbodyType
- the body typeadditionalProperties
- the additional propertyException
- the exceptionpublic ServiceResponseCollection<CreateAttachmentResponse> createAttachments(String parentItemId, Iterable<Attachment> attachments) throws ServiceResponseException, Exception
parentItemId
- the parent item idattachments
- the attachmentsServiceResponseException
- the service response exceptionException
- the exceptionpublic ServiceResponseCollection<DeleteAttachmentResponse> deleteAttachments(Iterable<Attachment> attachments) throws ServiceResponseException, Exception
attachments
- the attachmentsServiceResponseException
- the service response exceptionException
- the exceptionpublic NameResolutionCollection resolveName(String nameToResolve) throws Exception
nameToResolve
- the name to resolveException
- the exceptionpublic NameResolutionCollection resolveName(String nameToResolve, Iterable<FolderId> parentFolderIds, ResolveNameSearchLocation searchScope, boolean returnContactDetails) throws Exception
nameToResolve
- the name to resolveparentFolderIds
- the parent folder idssearchScope
- the search scopereturnContactDetails
- the return contact detailsException
- the exceptionpublic NameResolutionCollection resolveName(String nameToResolve, Iterable<FolderId> parentFolderIds, ResolveNameSearchLocation searchScope, boolean returnContactDetails, PropertySet contactDataPropertySet) throws Exception
nameToResolve
- The name to resolve.parentFolderIds
- The Ids of the contact folder in which to look for matching
contacts.searchScope
- The scope of the search.returnContactDetails
- Indicates whether full contact information should be returned
for each of the found contacts.contactDataPropertySet
- The property set for the contact detailsException
- on errorpublic NameResolutionCollection resolveName(String nameToResolve, ResolveNameSearchLocation searchScope, boolean returnContactDetails, PropertySet contactDataPropertySet) throws Exception
nameToResolve
- The name to resolve.searchScope
- The scope of the search.returnContactDetails
- Indicates whether full contact information should be returned
for each of the found contacts.contactDataPropertySet
- The property set for the contact detailsException
- on errorpublic NameResolutionCollection resolveName(String nameToResolve, ResolveNameSearchLocation searchScope, boolean returnContactDetails) throws Exception
nameToResolve
- the name to resolvesearchScope
- the search scopereturnContactDetails
- the return contact detailsException
- the exceptionpublic ExpandGroupResults expandGroup(EmailAddress emailAddress) throws Exception
emailAddress
- the email addressException
- the exceptionpublic ExpandGroupResults expandGroup(ItemId groupId) throws Exception
groupId
- the group idException
- the exceptionpublic ExpandGroupResults expandGroup(String smtpAddress) throws Exception
smtpAddress
- the smtp addressException
- the exceptionpublic ExpandGroupResults expandGroup(String address, String routingType) throws Exception
address
- the addressroutingType
- the routing typeException
- the exceptionpublic Date getPasswordExpirationDate(String mailboxSmtpAddress) throws Exception
mailboxSmtpAddress
- The e-mail address of the user.Exception
- on errorpublic PullSubscription subscribeToPullNotifications(Iterable<FolderId> folderIds, int timeout, String watermark, EventType... eventTypes) throws Exception
folderIds
- The Ids of the folder to subscribe totimeout
- The timeout, in minutes, after which the subscription expires.
Timeout must be between 1 and 1440.watermark
- An optional watermark representing a previously opened
subscription.eventTypes
- The event types to subscribe to.Exception
- on errorpublic AsyncRequestResult beginSubscribeToPullNotifications(AsyncCallback callback, Object state, Iterable<FolderId> folderIds, int timeout, String watermark, EventType... eventTypes) throws Exception
callback
- The AsyncCallback delegate.state
- An object that contains state information for this request.folderIds
- The Ids of the folder to subscribe to.timeout
- The timeout, in minutes, after which the subscription expires.
Timeout must be between 1 and 1440.watermark
- An optional watermark representing a previously opened
subscription.eventTypes
- The event types to subscribe to.Exception
public PullSubscription subscribeToPullNotificationsOnAllFolders(int timeout, String watermark, EventType... eventTypes) throws Exception
timeout
- the timeoutwatermark
- the watermarkeventTypes
- the event typesException
- the exceptionpublic IAsyncResult beginSubscribeToPullNotificationsOnAllFolders(AsyncCallback callback, Object state, int timeout, String watermark, EventType... eventTypes) throws Exception
callback
- The AsyncCallback delegate.state
- An object that contains state information for this request.timeout
- The timeout, in minutes, after which the subscription expires.
Timeout must be between 1 and 1440.watermark
- An optional watermark representing a previously opened
subscription.eventTypes
- The event types to subscribe to.Exception
public PullSubscription endSubscribeToPullNotifications(IAsyncResult asyncResult) throws Exception
asyncResult
- An IAsyncResult that references the asynchronous request.Exception
public void unsubscribe(String subscriptionId) throws Exception
subscriptionId
- the subscription idException
- the exceptionpublic IAsyncResult beginUnsubscribe(AsyncCallback callback, Object state, String subscriptionId) throws Exception
callback
- The AsyncCallback delegate.state
- An object that contains state information for this request.subscriptionId
- The Id of the pull subscription to unsubscribe from.Exception
public void endUnsubscribe(IAsyncResult asyncResult) throws Exception
asyncResult
- An IAsyncResult that references the asynchronous request.Exception
public GetEventsResults getEvents(String subscriptionId, String waterMark) throws Exception
subscriptionId
- the subscription idwaterMark
- the water markException
- the exceptionpublic IAsyncResult beginGetEvents(AsyncCallback callback, Object state, String subscriptionId, String watermark) throws Exception
callback
- The AsyncCallback delegate.state
- An object that contains state information for this request.subscriptionId
- The id of the pull subscription for which to get the eventswatermark
- The watermark representing the point in time where to start
receiving eventsException
public GetEventsResults endGetEvents(IAsyncResult asyncResult) throws Exception
asyncResult
- An IAsyncResult that references the asynchronous request.Exception
public PushSubscription subscribeToPushNotifications(Iterable<FolderId> folderIds, URI url, int frequency, String watermark, EventType... eventTypes) throws Exception
folderIds
- the folder idsurl
- the urlfrequency
- the frequencywatermark
- the watermarkeventTypes
- the event typesException
- the exceptionpublic IAsyncResult beginSubscribeToPushNotifications(AsyncCallback callback, Object state, Iterable<FolderId> folderIds, URI url, int frequency, String watermark, EventType... eventTypes) throws Exception
callback
- The asynccallback delegatestate
- An object that contains state information for this requestfolderIds
- The ids of the folder to subscribeurl
- the url of web service endpoint the exchange server shouldfrequency
- the frequency,in minutes at which the exchange server should
contact the web Service endpoint. Frequency must be between 1
and 1440.watermark
- An optional watermark representing a previously opened
subscriptioneventTypes
- The event types to subscribe to.Exception
public PushSubscription subscribeToPushNotificationsOnAllFolders(URI url, int frequency, String watermark, EventType... eventTypes) throws Exception
url
- the urlfrequency
- the frequencywatermark
- the watermarkeventTypes
- the event typesException
- the exceptionpublic IAsyncResult beginSubscribeToPushNotificationsOnAllFolders(AsyncCallback callback, Object state, URI url, int frequency, String watermark, EventType... eventTypes) throws Exception
callback
- The asynccallback delegatestate
- An object that contains state inforamtion for this requesturl
- the urlfrequency
- the frequency,in minutes at which the exchange server should
contact the web Service endpoint. Frequency must be between 1
and 1440.watermark
- An optional watermark representing a previously opened
subscriptioneventTypes
- The event types to subscribe to.Exception
public PushSubscription endSubscribeToPushNotifications(IAsyncResult asyncResult) throws Exception
asyncResult
- An IAsyncResult that references the asynchronous request.Exception
public StreamingSubscription subscribeToStreamingNotifications(Iterable<FolderId> folderIds, EventType... eventTypes) throws Exception
folderIds
- The Ids of the folder to subscribe to.eventTypes
- The event types to subscribe to.Exception
public StreamingSubscription subscribeToStreamingNotificationsOnAllFolders(EventType... eventTypes) throws Exception
eventTypes
- The event types to subscribe to.Exception
public IAsyncResult beginSubscribeToStreamingNotifications(AsyncCallback callback, Object state, Iterable<FolderId> folderIds, EventType... eventTypes) throws Exception
callback
- The AsyncCallback delegatestate
- An object that contains state information for this request.folderIds
- The Ids of the folder to subscribe to.eventTypes
- The event types to subscribe to.Exception
public IAsyncResult beginSubscribeToStreamingNotificationsOnAllFolders(AsyncCallback callback, Object state, EventType... eventTypes) throws Exception
callback
- The AsyncCallback delegatestate
- An object that contains state information for this request.Exception
public StreamingSubscription endSubscribeToStreamingNotifications(IAsyncResult asyncResult) throws IndexOutOfBoundsException, Exception
asyncResult
- An IAsyncResult that references the asynchronous request.Exception
IndexOutOfBoundsException
public ChangeCollection<ItemChange> syncFolderItems(FolderId syncFolderId, PropertySet propertySet, Iterable<ItemId> ignoredItemIds, int maxChangesReturned, SyncFolderItemsScope syncScope, String syncState) throws Exception
syncFolderId
- The Id of the folder containing the item to synchronize with.propertySet
- The set of property to retrieve for synchronized item.ignoredItemIds
- The optional list of item Ids that should be ignored.maxChangesReturned
- The maximum number of changes that should be returned.syncScope
- The sync scope identifying item to include in the
ChangeCollection.syncState
- The optional sync state representing the point in time when to
start the synchronization.Exception
- the exceptionpublic IAsyncResult beginSyncFolderItems(AsyncCallback callback, Object state, FolderId syncFolderId, PropertySet propertySet, Iterable<ItemId> ignoredItemIds, int maxChangesReturned, SyncFolderItemsScope syncScope, String syncState) throws Exception
callback
- The AsyncCallback delegatestate
- An object that contains state information for this requestsyncFolderId
- The Id of the folder containing the item to synchronize withpropertySet
- The set of property to retrieve for synchronized item.ignoredItemIds
- The optional list of item Ids that should be ignored.maxChangesReturned
- The maximum number of changes that should be returned.syncScope
- The sync scope identifying item to include in the
ChangeCollectionsyncState
- The optional sync state representing the point in time when to
start the synchronizationException
public ChangeCollection<ItemChange> endSyncFolderItems(IAsyncResult asyncResult) throws Exception
asyncResult
- An IAsyncResult that references the asynchronous request.Exception
public ChangeCollection<FolderChange> syncFolderHierarchy(FolderId syncFolderId, PropertySet propertySet, String syncState) throws Exception
syncFolderId
- the sync folder idpropertySet
- the property setsyncState
- the sync stateException
- the exceptionpublic IAsyncResult beginSyncFolderHierarchy(AsyncCallback callback, Object state, FolderId syncFolderId, PropertySet propertySet, String syncState) throws Exception
callback
- The AsyncCallback delegatestate
- An object that contains state information for this request.syncFolderId
- The Id of the folder containing the item to synchronize with.
A null value indicates the root folder of the mailbox.propertySet
- The set of property to retrieve for synchronized item.syncState
- The optional sync state representing the point in time when to
start the synchronization.Exception
public ChangeCollection<FolderChange> syncFolderHierarchy(PropertySet propertySet, String syncState) throws Exception
propertySet
- The set of property to retrieve for synchronized item.syncState
- The optional sync state representing the point in time when to
start the synchronization.Exception
public ChangeCollection<FolderChange> endSyncFolderHierarchy(IAsyncResult asyncResult) throws Exception
asyncResult
- An IAsyncResult that references the asynchronous request.Exception
public OofSettings getUserOofSettings(String smtpAddress) throws Exception
smtpAddress
- the smtp addressException
- the exceptionpublic void setUserOofSettings(String smtpAddress, OofSettings oofSettings) throws Exception
smtpAddress
- the smtp addressoofSettings
- the oof settingsException
- the exceptionpublic GetUserAvailabilityResults getUserAvailability(Iterable<AttendeeInfo> attendees, TimeWindow timeWindow, AvailabilityData requestedData, AvailabilityOptions options) throws Exception
attendees
- the attendeestimeWindow
- the time windowrequestedData
- the requested dataoptions
- the optionsException
- the exceptionpublic GetUserAvailabilityResults getUserAvailability(Iterable<AttendeeInfo> attendees, TimeWindow timeWindow, AvailabilityData requestedData) throws Exception
attendees
- the attendeestimeWindow
- the time windowrequestedData
- the requested dataException
- the exceptionpublic EmailAddressCollection getRoomLists() throws Exception
Exception
- the exceptionpublic Collection<EmailAddress> getRooms(EmailAddress emailAddress) throws Exception
emailAddress
- the email addressException
- the exceptionpublic Collection<Conversation> findConversation(ConversationIndexedItemView view, FolderId folderId) throws Exception
view
- The view controlling the number of conversations returned.folderId
- The Id of the folder in which to search for conversations.Exception
public ServiceResponseCollection<ServiceResponse> enableAlwaysCategorizeItemsInConversations(Iterable<ConversationId> conversationId, Iterable<String> categories, boolean processSynchronously) throws Exception
conversationId
- The id of the conversation.categories
- The categories that should be stamped on item in the
conversation.processSynchronously
- Indicates whether the method should return only once enabling
this rule and stamping existing item in the conversation is
completely done. If processSynchronously is false, the method
returns immediately.Exception
public ServiceResponseCollection<ServiceResponse> disableAlwaysCategorizeItemsInConversations(Iterable<ConversationId> conversationId, boolean processSynchronously) throws Exception
conversationId
- The id of the conversation.processSynchronously
- Indicates whether the method should return only once enabling
this rule and stamping existing item in the conversation is
completely done. If processSynchronously is false, the method
returns immediately.Exception
public ServiceResponseCollection<ServiceResponse> enableAlwaysDeleteItemsInConversations(Iterable<ConversationId> conversationId, boolean processSynchronously) throws Exception
conversationId
- The id of the conversation.processSynchronously
- Indicates whether the method should return only once enabling
this rule and stamping existing item in the conversation is
completely done. If processSynchronously is false, the method
returns immediately.Exception
public ServiceResponseCollection<ServiceResponse> disableAlwaysDeleteItemsInConversations(Iterable<ConversationId> conversationId, boolean processSynchronously) throws Exception
conversationId
- The id of the conversation.processSynchronously
- Indicates whether the method should return only once enabling
this rule and stamping existing item in the conversation is
completely done. If processSynchronously is false, the method
returns immediately.Exception
public ServiceResponseCollection<ServiceResponse> enableAlwaysMoveItemsInConversations(Iterable<ConversationId> conversationId, FolderId destinationFolderId, boolean processSynchronously) throws Exception
conversationId
- The Id of the folder to which conversation item should be
moved.destinationFolderId
- The Id of the destination folder.processSynchronously
- Indicates whether the method should return only once enabling
this rule and stamping existing item in the conversation is
completely done. If processSynchronously is false, the method
returns immediately.Exception
public ServiceResponseCollection<ServiceResponse> disableAlwaysMoveItemsInConversations(Iterable<ConversationId> conversationIds, boolean processSynchronously) throws Exception
conversationIds
- The conversation ids.processSynchronously
- Indicates whether the method should return only once disabling
this rule is completely done. If processSynchronously is
false, the method returns immediately.Exception
public ServiceResponseCollection<ServiceResponse> moveItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, FolderId destinationFolderId) throws Exception
idLastSyncTimePairs
- The pairs of Id of conversation whose item should be moved
and the dateTime conversation was last synced (Items received
after that dateTime will not be moved).contextFolderId
- The Id of the folder that contains the conversation.destinationFolderId
- The Id of the destination folder.Exception
public ServiceResponseCollection<ServiceResponse> copyItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, FolderId destinationFolderId) throws Exception
idLastSyncTimePairs
- The pairs of Id of conversation whose item should be copied
and the dateTime conversation was last synced (Items received
after that dateTime will not be copied).contextFolderId
- The context folder id.destinationFolderId
- The destination folder id.Exception
public ServiceResponseCollection<ServiceResponse> deleteItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, DeleteMode deleteMode) throws Exception
idLastSyncTimePairs
- The pairs of Id of conversation whose item should be deleted
and the date and time conversation was last synced (Items
received after that date will not be deleted). conversation
was last synced (Items received after that dateTime will not
be copied).contextFolderId
- The Id of the folder that contains the conversation.deleteMode
- The deletion modeException
public ServiceResponseCollection<ServiceResponse> setReadStateForItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, boolean isRead) throws Exception
idLastSyncTimePairs
- The pairs of Id of conversation whose item should read state
set and the date and time conversation was last synced (Items
received after that date will not have their read state set).
was last synced (Items received after that date will not be
deleted). conversation was last synced (Items received after
that dateTime will not be copied).contextFolderId
- The Id of the folder that contains the conversation.isRead
- if set to Exception
public ServiceResponseCollection<ConvertIdResponse> convertIds(Iterable<AlternateIdBase> ids, IdFormat destinationFormat) throws Exception
ids
- the idsdestinationFormat
- the destination formatException
- the exceptionpublic AlternateIdBase convertId(AlternateIdBase id, IdFormat destinationFormat) throws Exception
id
- the iddestinationFormat
- the destination formatException
- the exceptionpublic Collection<DelegateUserResponse> addDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, DelegateUser... delegateUsers) throws Exception
mailbox
- the mailboxmeetingRequestsDeliveryScope
- the meeting request delivery scopedelegateUsers
- the delegate usersException
- the exceptionpublic Collection<DelegateUserResponse> addDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, Iterable<DelegateUser> delegateUsers) throws Exception
mailbox
- the mailboxmeetingRequestsDeliveryScope
- the meeting request delivery scopedelegateUsers
- the delegate usersException
- the exceptionpublic Collection<DelegateUserResponse> updateDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, DelegateUser... delegateUsers) throws Exception
mailbox
- the mailboxmeetingRequestsDeliveryScope
- the meeting request delivery scopedelegateUsers
- the delegate usersException
- the exceptionpublic Collection<DelegateUserResponse> updateDelegates(Mailbox mailbox, MeetingRequestsDeliveryScope meetingRequestsDeliveryScope, Iterable<DelegateUser> delegateUsers) throws Exception
mailbox
- the mailboxmeetingRequestsDeliveryScope
- the meeting request delivery scopedelegateUsers
- the delegate usersException
- the exceptionpublic Collection<DelegateUserResponse> removeDelegates(Mailbox mailbox, UserId... userIds) throws Exception
mailbox
- the mailboxuserIds
- the user idsException
- the exceptionpublic Collection<DelegateUserResponse> removeDelegates(Mailbox mailbox, Iterable<UserId> userIds) throws Exception
mailbox
- the mailboxuserIds
- the user idsException
- the exceptionpublic DelegateInformation getDelegates(Mailbox mailbox, boolean includePermissions, UserId... userIds) throws Exception
mailbox
- the mailboxincludePermissions
- the include permissionsuserIds
- the user idsException
- the exceptionpublic DelegateInformation getDelegates(Mailbox mailbox, boolean includePermissions, Iterable<UserId> userIds) throws Exception
mailbox
- the mailboxincludePermissions
- the include permissionsuserIds
- the user idsException
- the exceptionpublic void createUserConfiguration(UserConfiguration userConfiguration) throws Exception
userConfiguration
- the user configurationException
- the exceptionpublic void deleteUserConfiguration(String name, FolderId parentFolderId) throws Exception
name
- the nameparentFolderId
- the parent folder idException
- the exceptionpublic UserConfiguration getUserConfiguration(String name, FolderId parentFolderId, UserConfigurationProperties properties) throws Exception
name
- the nameparentFolderId
- the parent folder idproperties
- the propertyException
- the exceptionpublic void loadPropertiesForUserConfiguration(UserConfiguration userConfiguration, UserConfigurationProperties properties) throws Exception
userConfiguration
- the user configurationproperties
- the propertyException
- the exceptionpublic void updateUserConfiguration(UserConfiguration userConfiguration) throws Exception
userConfiguration
- the user configurationException
- the exceptionpublic RuleCollection getInboxRules() throws Exception
Exception
public RuleCollection getInboxRules(String mailboxSmtpAddress) throws Exception
mailboxSmtpAddress
- The SMTP address of the user whose inbox rules should be
retrievedException
public void updateInboxRules(Iterable<RuleOperation> operations, boolean removeOutlookRuleBlob) throws Exception
operations
- The operations that should be applied to the user's inbox
rules.removeOutlookRuleBlob
- Indicate whether or not to remove Outlook Rule Blob.Exception
public void updateInboxRules(Iterable<RuleOperation> operations, boolean removeOutlookRuleBlob, String mailboxSmtpAddress) throws Exception
operations
- The operations that should be applied to the user's inbox
rules.removeOutlookRuleBlob
- Indicate whether or not to remove Outlook Rule Blob.mailboxSmtpAddress
- The SMTP address of the user whose inbox rules should be
retrievedException
public void autodiscoverUrl(String emailAddress) throws Exception
emailAddress
- the email addressException
- the exceptionpublic void autodiscoverUrl(String emailAddress, IAutodiscoverRedirectionUrl validateRedirectionUrlCallback) throws Exception
emailAddress
- the email address to use.validateRedirectionUrlCallback
- The callback used to validate redirection URLException
- the exceptionprotected Document executeDiagnosticMethod(String verb, Node parameter) throws Exception
verb
- The verb.parameter
- The parameter.Exception
public void validate() throws ServiceLocalException
validate
in class ExchangeServiceBase
ServiceLocalException
- the service local exceptionpublic HttpWebRequest prepareHttpWebRequest() throws ServiceLocalException, URISyntaxException
ServiceLocalException
- the service local exceptionURISyntaxException
- the uRI syntax exceptionpublic HttpWebRequest prepareHttpPoolingWebRequest() throws ServiceLocalException, URISyntaxException
ServiceLocalException
- The service local exceptionURISyntaxException
- the uRI syntax exceptionpublic void processHttpErrorResponse(HttpWebRequest httpWebResponse, Exception webException) throws Exception
processHttpErrorResponse
in class ExchangeServiceBase
httpWebResponse
- The HTTP web response.webException
- The web exceptionException
public URI getUrl()
public void setUrl(URI url)
url
- URL of the Exchange Web Services.public ImpersonatedUserId getImpersonatedUserId()
public void setImpersonatedUserId(ImpersonatedUserId impersonatedUserId)
impersonatedUserId
- the new impersonated user idpublic Locale getPreferredCulture()
public void setPreferredCulture(Locale preferredCulture)
preferredCulture
- the new preferred culturepublic DateTimePrecision getDateTimePrecision()
public void setDateTimePrecision(DateTimePrecision d)
d
- date time precisionpublic void setPreferredCulture(DateTimePrecision dateTimePrecision)
dateTimePrecision
- the new DateTimePrecisionpublic IFileAttachmentContentHandler getFileAttachmentContentHandler()
public void setFileAttachmentContentHandler(IFileAttachmentContentHandler fileAttachmentContentHandler)
fileAttachmentContentHandler
- the new file attachment content handlerpublic UnifiedMessaging getUnifiedMessaging()
public boolean getEnableScpLookup()
public void setEnableScpLookup(boolean value)
public boolean getExchange2007CompatibilityMode()
public void setExchange2007CompatibilityMode(boolean value)
exchange2007CompatibilityMode
property,
set to true, can be used to indicate that we should use "Exchange2007" as the server version String
rather than Exchange2007_SP1.
value
- true if the Exchange2007 compatibility mode is enabled.public Collection<TimeZoneDefinition> getServerTimeZones(Iterable<String> timeZoneIds) throws Exception
timeZoneIds
- the time zone idsException
public Collection<TimeZoneDefinition> getServerTimeZones() throws Exception
Exception
public boolean autodiscoverRedirectionUrlValidationCallback(String redirectionUrl) throws AutodiscoverLocalException
IAutodiscoverRedirectionUrl
autodiscoverRedirectionUrlValidationCallback
in interface IAutodiscoverRedirectionUrl
redirectionUrl
- the redirection urlAutodiscoverLocalException
- the autodiscover local exceptionCopyright © 2012–2015 Microsoft. All rights reserved.