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
Class ExchangeService

java.lang.Object
  extended by microsoft.exchange.webservices.data.ExchangeServiceBase
      extended by microsoft.exchange.webservices.data.ExchangeService
All Implemented Interfaces:
IAutodiscoverRedirectionUrl
public final class ExchangeService
extends ExchangeServiceBase
implements IAutodiscoverRedirectionUrl

Represents a binding to the Exchange Web Services.

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.
ExchangeService(ExchangeVersion requestedServerVersion, TimeZone timeZone)
          Initializes a new instance of the class, targeting the specified version of EWS and scoped to the to the specified 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.
protected
<TFolder extends Folder>
TFolder
bindToFolder(Class<TFolder> cls, FolderId folderId, PropertySet propertySet)
          Binds to folder.
protected  Folder bindToFolder(FolderId folderId, PropertySet propertySet)
          Binds to a folder.
protected
<TItem extends Item>
TItem
bindToItem(Class<TItem> c, ItemId itemId, PropertySet propertySet)
          Bind to item.
protected  Item bindToItem(ItemId itemId, PropertySet propertySet)
          * Binds to multiple items in a single call to EWS.
 ServiceResponseCollection<GetItemResponse> bindToItems(Iterable<ItemId> itemIds, PropertySet propertySet)
          * Binds to multiple items 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.
protected  Folder copyFolder(FolderId folderId, FolderId destinationFolderId)
          Copies a folder.
protected  Item copyItem(ItemId itemId, FolderId destinationFolderId)
          Copies an item.
 ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds, FolderId destinationFolderId)
          * Copies multiple items in a single call to EWS.
 ServiceResponseCollection<MoveCopyItemResponse> copyItems(Iterable<ItemId> itemIds, FolderId destinationFolderId, boolean returnNewItemIds)
          Copies multiple items in a single call to EWS.
 ServiceResponseCollection<ServiceResponse> copyItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, FolderId destinationFolderId)
          Copies the items in the specified conversation to the specified destination folder.
protected  ServiceResponseCollection<CreateAttachmentResponse> createAttachments(String parentItemId, Iterable<Attachment> attachments)
          * Creates attachments.
protected  void createFolder(Folder folder, FolderId parentFolderId)
          Creates a folder.
protected  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 items in a single EWS call.
protected  void createUserConfiguration(UserConfiguration userConfiguration)
          Creates the user configuration.
protected  ServiceResponseCollection<DeleteAttachmentResponse> deleteAttachments(Iterable<Attachment> attachments)
          * Deletes attachments.
protected  void deleteFolder(FolderId folderId, DeleteMode deleteMode)
          Deletes a folder.
protected  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 items in a single call to EWS.
 ServiceResponseCollection<ServiceResponse> deleteItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, DeleteMode deleteMode)
          Deletes the items in the specified conversation.
protected  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.
protected  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.
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 folders by searching the sub-folders of the specified folder.
 FindFoldersResults findFolders(FolderId parentFolderId, SearchFilter searchFilter, FolderView view)
          Obtains a list of folders by searching the sub-folders of the specified folder.
 FindFoldersResults findFolders(WellKnownFolderName parentFolderName, FolderView view)
          * Obtains a list of folders by searching the sub-folders of the specified folder.
 FindFoldersResults findFolders(WellKnownFolderName parentFolderName, SearchFilter searchFilter, FolderView view)
          Obtains a list of folders by searching the sub-folders 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 items by searching the contents of a specific folder.
 FindItemsResults<Item> findItems(FolderId parentFolderId, ItemView view)
          Obtains a list of items by searching the contents of a specific folder.
 GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, ItemView view, Grouping groupBy)
          Obtains a grouped list of items by searching the contents of a specific folder.
 FindItemsResults<Item> findItems(FolderId parentFolderId, SearchFilter searchFilter, ItemView view)
          Obtains a list of items by searching the contents of a specific folder.
 GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, SearchFilter searchFilter, ItemView view, Grouping groupBy)
          Obtains a grouped list of items by searching the contents of a specific folder.
 FindItemsResults<Item> findItems(FolderId parentFolderId, String queryString, ItemView view)
          Obtains a list of items by searching the contents of a specific folder.
 GroupedFindItemsResults<Item> findItems(FolderId parentFolderId, String queryString, ItemView view, Grouping groupBy)
          Obtains a grouped list of items by searching the contents of a specific folder.
protected
<TItem extends Item>
ServiceResponseCollection<FindItemResponse<TItem>>
findItems(Iterable<FolderId> parentFolderIds, SearchFilter searchFilter, String queryString, ViewBase view, Grouping groupBy, microsoft.exchange.webservices.data.ServiceErrorHandling errorHandlingMode)
          Finds items.
 FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, ItemView view)
          Obtains a list of items by searching the contents of a specific folder.
 FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, SearchFilter searchFilter, ItemView view)
          Obtains a list of items by searching the contents of a specific folder.
 GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, SearchFilter searchFilter, ItemView view, Grouping groupBy)
          Obtains a grouped list of items by searching the contents of a specific folder.
 FindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, String queryString, ItemView view)
          Obtains a list of items by searching the contents of a specific folder.
 GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName, String queryString, ItemView view, Grouping groupBy)
          Obtains a grouped list of items by searching the contents of a specific folder.
protected  void getAttachment(Attachment attachment, BodyType bodyType, Iterable<PropertyDefinitionBase> additionalProperties)
          Gets the attachment.
protected  ServiceResponseCollection<microsoft.exchange.webservices.data.GetAttachmentResponse> getAttachments(Attachment[] attachments, BodyType bodyType, Iterable<PropertyDefinitionBase> additionalProperties)
          Gets attachments.
 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.
protected  GetEventsResults getEvents(String subscriptionId, String waterMark)
          * Retrieves the latests events associated with a pull subscription.
protected  boolean getExchange2007CompatibilityMode()
          Gets or sets a value indicating whether Exchange2007 compatibility mode is enabled.
 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.
 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.
protected  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.
protected  List<Item> internalCreateResponseObject(ServiceObject responseObject, FolderId parentFolderId, MessageDisposition messageDisposition)
          Create response object.
protected  void loadPropertiesForFolder(Folder folder, PropertySet propertySet)
          Load specified properties for a folder.
 ServiceResponseCollection<ServiceResponse> loadPropertiesForItems(Iterable<Item> items, PropertySet propertySet)
          * Loads the properties of multiple items in a single call to EWS.
protected  void loadPropertiesForUserConfiguration(UserConfiguration userConfiguration, UserConfigurationProperties properties)
          * Loads the properties of the specified userConfiguration.
protected  Folder moveFolder(FolderId folderId, FolderId destinationFolderId)
          Move a folder.
protected  Item moveItem(ItemId itemId, FolderId destinationFolderId)
          Copies multiple items in a single call to EWS.
 ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds, FolderId destinationFolderId)
          * Moves multiple items in a single call to EWS.
 ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds, FolderId destinationFolderId, boolean returnNewItemIds)
          Moves multiple items in a single call to EWS.
 ServiceResponseCollection<ServiceResponse> moveItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs, FolderId contextFolderId, FolderId destinationFolderId)
          Moves the items in the specified conversation to the specified destination folder.
protected  microsoft.exchange.webservices.data.HttpWebRequest prepareHttpWebRequest()
          Prepare http web request.
protected  void processHttpErrorResponse(microsoft.exchange.webservices.data.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, 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.
protected  void sendItem(Item item, FolderId savedCopyDestinationFolderId)
          Send item.
 void setEnableScpLookup(boolean value)
           
protected  void setExchange2007CompatibilityMode(boolean value)
           
 void setFileAttachmentContentHandler(IFileAttachmentContentHandler fileAttachmentContentHandler)
          Sets the file attachment content handler.
 void setImpersonatedUserId(ImpersonatedUserId impersonatedUserId)
          Sets the impersonated user id.
 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 items 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 notifications.
 PullSubscription subscribeToPullNotificationsOnAllFolders(int timeout, String watermark, EventType... eventTypes)
          * Subscribes to pull notifications on all folders in the authenticated user's mailbox.
 PushSubscription subscribeToPushNotifications(Iterable<FolderId> folderIds, URI url, int frequency, String watermark, EventType... eventTypes)
          * Subscribes to push notifications.
 PushSubscription subscribeToPushNotificationsOnAllFolders(URI url, int frequency, String watermark, EventType... eventTypes)
          * Subscribes to push notifications on all folders in the authenticated user's mailbox.
 StreamingSubscription subscribeToStreamingNotifications(Iterable<FolderId> folderIds, EventType... eventTypes)
          Subscribes to streaming notifications.
 StreamingSubscription subscribeToStreamingNotificationsOnAllFolders(EventType... eventTypes)
          Subscribes to streaming notifications on all folders in the authenticated user's mailbox.
 ChangeCollection<FolderChange> syncFolderHierarchy(FolderId syncFolderId, PropertySet propertySet, String syncState)
          * Synchronizes the sub-folders 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 items of a specific folder.
protected  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.
protected  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.
protected  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 items in a single EWS call.
protected  void updateUserConfiguration(UserConfiguration userConfiguration)
          * Updates a UserConfiguration.
protected  void validate()
          * Validates this instance.
 
Methods inherited from class microsoft.exchange.webservices.data.ExchangeServiceBase
checkURIPath, convertDateTimeToUniversalDateTimeString, convertStartDateToUnspecifiedDateTime, convertUniversalDateTimeStringToDate, doOnSerializeCustomSoapHeaders, getAcceptGzipEncoding, getCookie, getCredentials, getHttpHeaders, getOnSerializeCustomSoapHeaders, getRequestedServerVersion, getServerInfo, getSimpleHttpConnectionManager, getTimeout, getTraceFlags, getTraceListener, getUseDefaultCredentials, getUserAgent, getWebProxy, internalProcessHttpErrorResponse, isPreAuthenticate, isTraceEnabled, isTraceEnabledFor, prepareHttpWebRequestForUrl, setAcceptGzipEncoding, setCookie, setCredentials, setCustomUserAgent, setOnSerializeCustomSoapHeaders, setPreAuthenticate, setTimeout, setTraceEnabled, setTraceFlags, setTraceListener, setUseDefaultCredentials, setUserAgent, setWebProxy, traceHttpRequestHeaders, traceHttpResponseHeaders, 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

ExchangeService

public ExchangeService(ExchangeVersion requestedServerVersion,
                       TimeZone timeZone)
Initializes a new instance of the class, targeting the specified version of EWS and scoped to the to the specified time zone.

Parameters:
requestedServerVersion - The version of EWS that the service targets.
timeZone - The time zone to which the service is scoped.
Method Detail

internalCreateResponseObject

protected 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 items created or modified as a result of the "creation" of the response object.
Throws:
Exception - the exception

createFolder

protected 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

protected void updateFolder(Folder folder)
                     throws Exception
Updates a folder.

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

copyFolder

protected 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

protected 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 folders by searching the sub-folders of the specified folder.

Parameters:
parentFolderId - The Id of the folder in which to search for folders.
searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
view - The view controlling the number of folders 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 folders by searching the sub-folders of the specified folder.

Parameters:
parentFolderId - The Id of the folder in which to search for folders.
view - The view controlling the number of folders 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 folders by searching the sub-folders of the specified folder.

Parameters:
parentFolderName - The name of the folder in which to search for folders.
searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
view - The view controlling the number of folders 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 folders by searching the sub-folders 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

protected void loadPropertiesForFolder(Folder folder,
                                       PropertySet propertySet)
                                throws Exception
Load specified properties for a folder.

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

bindToFolder

protected 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

protected <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

protected 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

protected 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 folders.
Throws:
Exception - the exception

createItems

public ServiceResponseCollection<ServiceResponse> createItems(Collection<Item> items,
                                                              FolderId parentFolderId,
                                                              MessageDisposition messageDisposition,
                                                              SendInvitationsMode sendInvitationsMode)
                                                       throws Exception
* Creates multiple items in a single EWS call. Supported item classes are EmailMessage, Appointment, Contact, PostItem, Task and Item. CreateItems does not support items that have unsaved attachments.

Parameters:
items - the items
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 items.
Throws:
Exception - the exception

createItem

protected 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 items in a single EWS call. UpdateItems does not support items that have unsaved attachments.

Parameters:
items - the items
savedItemsDestinationFolderId - the saved items 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 items.
Throws:
Exception - the exception

updateItem

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

Parameters:
item - the item
savedItemsDestinationFolderId - the saved items 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

protected 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 items 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 items in a single call to EWS.

Parameters:
itemIds - The Ids of the items to copy.
destinationFolderId - The Id of the folder to copy the items 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

copyItem

protected Item copyItem(ItemId itemId,
                        FolderId destinationFolderId)
                 throws IndexOutOfBoundsException,
                        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:
IndexOutOfBoundsException - the index out of bounds exception
Exception - the exception

moveItems

public ServiceResponseCollection<MoveCopyItemResponse> moveItems(Iterable<ItemId> itemIds,
                                                                 FolderId destinationFolderId)
                                                          throws Exception
* Moves multiple items 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 items in a single call to EWS.

Parameters:
itemIds - The Ids of the items to move.
destinationFolderId - The Id of the folder to move the items 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

moveItem

protected Item moveItem(ItemId itemId,
                        FolderId destinationFolderId)
                 throws IndexOutOfBoundsException,
                        Exception
Copies multiple items 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:
IndexOutOfBoundsException - the index out of bounds exception
Exception - the exception

findItems

protected <TItem extends Item> ServiceResponseCollection<FindItemResponse<TItem>> findItems(Iterable<FolderId> parentFolderIds,
                                                                                            SearchFilter searchFilter,
                                                                                            String queryString,
                                                                                            ViewBase view,
                                                                                            Grouping groupBy,
                                                                                            microsoft.exchange.webservices.data.ServiceErrorHandling errorHandlingMode)
                                                                             throws Exception
Finds items.

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 folders 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 items 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 items 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 items 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 items 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 items 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 items 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

findItems

public GroupedFindItemsResults<Item> findItems(FolderId parentFolderId,
                                               String queryString,
                                               ItemView view,
                                               Grouping groupBy)
                                        throws Exception
Obtains a grouped list of items 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
groupBy - the group by
Returns:
A list of items containing the contents of the specified folder.
Throws:
Exception - the exception

findItems

public GroupedFindItemsResults<Item> findItems(FolderId parentFolderId,
                                               SearchFilter searchFilter,
                                               ItemView view,
                                               Grouping groupBy)
                                        throws Exception
Obtains a grouped list of items 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
groupBy - the group by
Returns:
A list of items containing the contents of the specified folder.
Throws:
Exception - the exception

findItems

public GroupedFindItemsResults<Item> findItems(FolderId parentFolderId,
                                               ItemView view,
                                               Grouping groupBy)
                                        throws Exception
Obtains a grouped list of items 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
groupBy - the group by
Returns:
A list of items containing the contents of the specified folder.
Throws:
Exception - the exception

findItems

protected <TItem extends Item> ServiceResponseCollection<FindItemResponse<TItem>> findItems(Class<TItem> cls,
                                                                                            FolderId parentFolderId,
                                                                                            SearchFilter searchFilter,
                                                                                            ViewBase view,
                                                                                            Grouping groupBy)
                                                                             throws Exception
Obtains a grouped list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.

Type Parameters:
TItem - the generic type
Parameters:
cls - the cls
parentFolderId - the parent folder id
searchFilter - the search filter
view - the view
groupBy - the group by
Returns:
A list of items containing the contents of the specified folder.
Throws:
Exception - the exception

findItems

public GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName,
                                               String queryString,
                                               ItemView view,
                                               Grouping groupBy)
                                        throws Exception
Obtains a grouped list of items 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
groupBy - the group by
Returns:
A collection of grouped items containing the contents of the specified.
Throws:
Exception - the exception

findItems

public GroupedFindItemsResults<Item> findItems(WellKnownFolderName parentFolderName,
                                               SearchFilter searchFilter,
                                               ItemView view,
                                               Grouping groupBy)
                                        throws Exception
Obtains a grouped list of items 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
groupBy - the group by
Returns:
A collection of grouped items containing the contents of the specified.
Throws:
Exception - the exception

findAppointments

public FindItemsResults<Appointment> findAppointments(FolderId parentFolderId,
                                                      CalendarView calendarView)
                                               throws Exception
* Obtains a list of appointments by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:
parentFolderId - the parent folder id
calendarView - the calendar view
Returns:
A collection of appointments representing the contents of the specified folder.
Throws:
Exception - the exception

findAppointments

public FindItemsResults<Appointment> findAppointments(WellKnownFolderName parentFolderName,
                                                      CalendarView calendarView)
                                               throws Exception
* Obtains a list of appointments by searching the contents of a specific folder. Calling this method results in a call to EWS.

Parameters:
parentFolderName - the parent folder name
calendarView - the calendar view
Returns:
A collection of appointments representing the contents of the specified folder.
Throws:
Exception - the exception

loadPropertiesForItems

public ServiceResponseCollection<ServiceResponse> loadPropertiesForItems(Iterable<Item> items,
                                                                         PropertySet propertySet)
                                                                  throws Exception
* Loads the properties of multiple items in a single call to EWS.

Parameters:
items - the items
propertySet - the property set
Returns:
A ServiceResponseCollection providing results for each of the specified items.
Throws:
Exception - the exception

bindToItems

public ServiceResponseCollection<GetItemResponse> bindToItems(Iterable<ItemId> itemIds,
                                                              PropertySet propertySet)
                                                       throws Exception
* Binds to multiple items in a single call to EWS.

Parameters:
itemIds - the item ids
propertySet - the property set
Returns:
A ServiceResponseCollection providing results for each of the specified item Ids.
Throws:
Exception - the exception

bindToItem

protected Item bindToItem(ItemId itemId,
                          PropertySet propertySet)
                   throws Exception
* Binds to multiple items in a single call to EWS.

Parameters:
itemId - the item id
propertySet - the property set
Returns:
A ServiceResponseCollection providing results for each of the specified item Ids.
Throws:
Exception - the exception

bindToItem

protected <TItem extends Item> TItem bindToItem(Class<TItem> c,
                                                ItemId itemId,
                                                PropertySet propertySet)
                                 throws Exception
Bind to item.

Type Parameters:
TItem - The type of the item.
Parameters:
c - the c
itemId - the item id
propertySet - the property set
Returns:
the t item
Throws:
Exception - the exception

deleteItems

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

Parameters:
itemIds - the item ids
deleteMode - the delete mode
sendCancellationsMode - the send cancellations mode
affectedTaskOccurrences - the affected task occurrences
Returns:
A ServiceResponseCollection providing deletion results for each of the specified item Ids.
Throws:
Exception - the exception

deleteItem

protected void deleteItem(ItemId itemId,
                          DeleteMode deleteMode,
                          SendCancellationsMode sendCancellationsMode,
                          AffectedTaskOccurrence affectedTaskOccurrences)
                   throws Exception
Deletes an item. Calling this method results in a call to EWS.

Parameters:
itemId - the item id
deleteMode - the delete mode
sendCancellationsMode - the send cancellations mode
affectedTaskOccurrences - the affected task occurrences
Throws:
Exception - the exception

getAttachments

protected ServiceResponseCollection<microsoft.exchange.webservices.data.GetAttachmentResponse> getAttachments(Attachment[] attachments,
                                                                                                              BodyType bodyType,
                                                                                                              Iterable<PropertyDefinitionBase> additionalProperties)
                                                                                                       throws Exception
Gets attachments.

Parameters:
attachments - the attachments
bodyType - the body type
additionalProperties - the additional properties
Returns:
Service response collection.
Throws:
Exception

getAttachment

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

Parameters:
attachment - the attachment
bodyType - the body type
additionalProperties - the additional properties
Throws:
Exception - the exception

createAttachments

protected ServiceResponseCollection<CreateAttachmentResponse> createAttachments(String parentItemId,
                                                                                Iterable<Attachment> attachments)
                                                                         throws ServiceResponseException,
                                                                                Exception
* Creates attachments.

Parameters:
parentItemId - the parent item id
attachments - the attachments
Returns:
Service response collection.
Throws:
ServiceResponseException - the service response exception
Exception - the exception

deleteAttachments

protected ServiceResponseCollection<DeleteAttachmentResponse> deleteAttachments(Iterable<Attachment> attachments)
                                                                         throws ServiceResponseException,
                                                                                Exception
* Deletes attachments.

Parameters:
attachments - the attachments
Returns:
the service response collection
Throws:
ServiceResponseException - the service response exception
Exception - the exception

resolveName

public NameResolutionCollection resolveName(String nameToResolve)
                                     throws Exception
* 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. Calling this method results in a call to EWS.

Parameters:
nameToResolve - the name to resolve
Returns:
A collection of name resolutions whose names match the one passed as a parameter.
Throws:
Exception - the exception

resolveName

public NameResolutionCollection resolveName(String nameToResolve,
                                            Iterable<FolderId> parentFolderIds,
                                            ResolveNameSearchLocation searchScope,
                                            boolean returnContactDetails)
                                     throws Exception
* 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. Calling this method results in a call to EWS.

Parameters:
nameToResolve - the name to resolve
parentFolderIds - the parent folder ids
searchScope - the search scope
returnContactDetails - the return contact details
Returns:
A collection of name resolutions whose names match the one passed as a parameter.
Throws:
Exception - the exception

resolveName

public NameResolutionCollection resolveName(String nameToResolve,
                                            ResolveNameSearchLocation searchScope,
                                            boolean returnContactDetails)
                                     throws Exception
* 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. Calling this method results in a call to EWS.

Parameters:
nameToResolve - the name to resolve
searchScope - the search scope
returnContactDetails - the return contact details
Returns:
A collection of name resolutions whose names match the one passed as a parameter.
Throws:
Exception - the exception

expandGroup

public ExpandGroupResults expandGroup(EmailAddress emailAddress)
                               throws IndexOutOfBoundsException,
                                      Exception
* Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.

Parameters:
emailAddress - the email address
Returns:
URL of the Exchange Web Services.
Throws:
IndexOutOfBoundsException - the index out of bounds exception
Exception - the exception

expandGroup

public ExpandGroupResults expandGroup(ItemId groupId)
                               throws Exception
* Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.

Parameters:
groupId - the group id
Returns:
An ExpandGroupResults containing the members of the group.
Throws:
Exception - the exception

expandGroup

public ExpandGroupResults expandGroup(String smtpAddress)
                               throws Exception
* Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.

Parameters:
smtpAddress - the smtp address
Returns:
An ExpandGroupResults containing the members of the group.
Throws:
Exception - the exception

expandGroup

public ExpandGroupResults expandGroup(String address,
                                      String routingType)
                               throws Exception
* Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.

Parameters:
address - the address
routingType - the routing type
Returns:
An ExpandGroupResults containing the members of the group.
Throws:
Exception - the exception

subscribeToPullNotificationsOnAllFolders

public PullSubscription subscribeToPullNotificationsOnAllFolders(int timeout,
                                                                 String watermark,
                                                                 EventType... eventTypes)
                                                          throws Exception
* Subscribes to pull notifications on all folders in the authenticated user's mailbox. Calling this method results in a call to EWS.

Parameters:
timeout - the timeout
watermark - the watermark
eventTypes - the event types
Returns:
A PullSubscription representing the new subscription.
Throws:
Exception - the exception

subscribeToPullNotifications

public PullSubscription subscribeToPullNotifications(Iterable<FolderId> folderIds,
                                                     int timeout,
                                                     String watermark,
                                                     EventType... eventTypes)
                                              throws Exception
* Subscribes to pull notifications. Calling this method results in a call to EWS.

Parameters:
folderIds - the folder ids
timeout - the timeout
watermark - the watermark
eventTypes - the event types
Returns:
A PullSubscription representing the new subscription.
Throws:
Exception - the exception

unsubscribe

protected void unsubscribe(String subscriptionId)
                    throws Exception
* Unsubscribes from a pull subscription. Calling this method results in a call to EWS.

Parameters:
subscriptionId - the subscription id
Throws:
Exception - the exception

getEvents

protected GetEventsResults getEvents(String subscriptionId,
                                     String waterMark)
                              throws Exception
* Retrieves the latests events associated with a pull subscription. Calling this method results in a call to EWS.

Parameters:
subscriptionId - the subscription id
waterMark - the water mark
Returns:
A GetEventsResults containing a list of events associated with the subscription.
Throws:
Exception - the exception

subscribeToPushNotifications

public PushSubscription subscribeToPushNotifications(Iterable<FolderId> folderIds,
                                                     URI url,
                                                     int frequency,
                                                     String watermark,
                                                     EventType... eventTypes)
                                              throws Exception
* Subscribes to push notifications. Calling this method results in a call to EWS.

Parameters:
folderIds - the folder ids
url - the url
frequency - the frequency
watermark - the watermark
eventTypes - the event types
Returns:
A PushSubscription representing the new subscription.
Throws:
Exception - the exception

subscribeToPushNotificationsOnAllFolders

public PushSubscription subscribeToPushNotificationsOnAllFolders(URI url,
                                                                 int frequency,
                                                                 String watermark,
                                                                 EventType... eventTypes)
                                                          throws Exception
* Subscribes to push notifications on all folders in the authenticated user's mailbox. Calling this method results in a call to EWS.

Parameters:
url - the url
frequency - the frequency
watermark - the watermark
eventTypes - the event types
Returns:
A PushSubscription representing the new subscription.
Throws:
Exception - the exception

subscribeToStreamingNotificationsOnAllFolders

public StreamingSubscription subscribeToStreamingNotificationsOnAllFolders(EventType... eventTypes)
                                                                    throws Exception
Subscribes to streaming notifications on all folders in the authenticated user's mailbox. Calling this method results in a call to EWS.

Parameters:
eventTypes - The event types to subscribe to.
Returns:
A StreamingSubscription representing the new subscription.
Throws:
Exception

subscribeToStreamingNotifications

public StreamingSubscription subscribeToStreamingNotifications(Iterable<FolderId> folderIds,
                                                               EventType... eventTypes)
                                                        throws Exception
Subscribes to streaming notifications. Calling this method results in a call to EWS.

Parameters:
folderIds - The Ids of the folder to subscribe to.
eventTypes - The event types to subscribe to.
Returns:
A StreamingSubscription representing the new subscription.
Throws:
Exception

syncFolderItems

public ChangeCollection<ItemChange> syncFolderItems(FolderId syncFolderId,
                                                    PropertySet propertySet,
                                                    Iterable<ItemId> ignoredItemIds,
                                                    int maxChangesReturned,
                                                    SyncFolderItemsScope syncScope,
                                                    String syncState)
                                             throws Exception
* Synchronizes the items of a specific folder. Calling this method results in a call to EWS.

Parameters:
syncFolderId - The Id of the folder containing the items to synchronize with.
propertySet - The set of properties to retrieve for synchronized items.
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 items to include in the ChangeCollection.
syncState - The optional sync state representing the point in time when to start the synchronization.
Returns:
A ChangeCollection containing a list of changes that occurred in the specified folder.
Throws:
Exception - the exception

syncFolderHierarchy

public ChangeCollection<FolderChange> syncFolderHierarchy(FolderId syncFolderId,
                                                          PropertySet propertySet,
                                                          String syncState)
                                                   throws Exception
* Synchronizes the sub-folders of a specific folder. Calling this method results in a call to EWS.

Parameters:
syncFolderId - the sync folder id
propertySet - the property set
syncState - the sync state
Returns:
A ChangeCollection containing a list of changes that occurred in the specified folder.
Throws:
Exception - the exception

syncFolderHierarchy

public ChangeCollection<FolderChange> syncFolderHierarchy(PropertySet propertySet,
                                                          String syncState)
                                                   throws Exception
* Synchronizes the entire folder hierarchy of the mailbox this Service is connected to. Calling this method results in a call to EWS.

Parameters:
propertySet - the property set
syncState - the sync state
Returns:
A ChangeCollection containing a list of changes that occurred in the specified folder.
Throws:
Exception - the exception

getUserOofSettings

public OofSettings getUserOofSettings(String smtpAddress)
                               throws Exception
* Gets Out of Office (OOF) settings for a specific user. Calling this method results in a call to EWS.

Parameters:
smtpAddress - the smtp address
Returns:
An OofSettings instance containing OOF information for the specified user.
Throws:
Exception - the exception

setUserOofSettings

public void setUserOofSettings(String smtpAddress,
                               OofSettings oofSettings)
                        throws Exception
* Sets Out of Office (OOF) settings for a specific user. Calling this method results in a call to EWS.

Parameters:
smtpAddress - the smtp address
oofSettings - the oof settings
Throws:
Exception - the exception

getUserAvailability

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

Parameters:
attendees - the attendees
timeWindow - the time window
requestedData - the requested data
options - the options
Returns:
The availability information for each user appears in a unique FreeBusyResponse object. The order of users in the request determines the order of availability data for each user in the response.
Throws:
Exception - the exception

getUserAvailability

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

Parameters:
attendees - the attendees
timeWindow - the time window
requestedData - the requested data
Returns:
The availability information for each user appears in a unique FreeBusyResponse object. The order of users in the request determines the order of availability data for each user in the response.
Throws:
Exception - the exception

getRoomLists

public EmailAddressCollection getRoomLists()
                                    throws Exception
* Retrieves a collection of all room lists in the organization.

Returns:
An EmailAddressCollection containing all the room lists in the organization
Throws:
Exception - the exception

getRooms

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

Parameters:
emailAddress - the email address
Returns:
A collection of EmailAddress objects representing all the rooms within the specifed room list.
Throws:
Exception - the exception

findConversation

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

Parameters:
view - The view controlling the number of conversations returned.
folderId - The Id of the folder in which to search for conversations.
Throws:
Exception

enableAlwaysCategorizeItemsInConversations

public ServiceResponseCollection<ServiceResponse> enableAlwaysCategorizeItemsInConversations(Iterable<ConversationId> conversationId,
                                                                                             Iterable<String> categories,
                                                                                             boolean processSynchronously)
                                                                                      throws Exception
Sets up a conversation so that any item received within that conversation is always categorized. Calling this method results in a call to EWS.

Parameters:
conversationId - The id of the conversation.
categories - The categories that should be stamped on items in the conversation.
processSynchronously - Indicates whether the method should return only once enabling this rule and stamping existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.
Throws:
Exception

disableAlwaysCategorizeItemsInConversations

public ServiceResponseCollection<ServiceResponse> disableAlwaysCategorizeItemsInConversations(Iterable<ConversationId> conversationId,
                                                                                              boolean processSynchronously)
                                                                                       throws Exception
Sets up a conversation so that any item received within that conversation is no longer categorized. Calling this method results in a call to EWS.

Parameters:
conversationId - The id of the conversation.
processSynchronously - Indicates whether the method should return only once enabling this rule and stamping existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.
Throws:
Exception

enableAlwaysDeleteItemsInConversations

public ServiceResponseCollection<ServiceResponse> enableAlwaysDeleteItemsInConversations(Iterable<ConversationId> conversationId,
                                                                                         boolean processSynchronously)
                                                                                  throws Exception
Sets up a conversation so that any item received within that conversation is always moved to Deleted Items folder. Calling this method results in a call to EWS.

Parameters:
conversationId - The id of the conversation.
processSynchronously - Indicates whether the method should return only once enabling this rule and stamping existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.
Throws:
Exception

disableAlwaysDeleteItemsInConversations

public ServiceResponseCollection<ServiceResponse> disableAlwaysDeleteItemsInConversations(Iterable<ConversationId> conversationId,
                                                                                          boolean processSynchronously)
                                                                                   throws Exception
Sets up a conversation so that any item received within that conversation is no longer moved to Deleted Items folder. Calling this method results in a call to EWS.

Parameters:
conversationId - The id of the conversation.
processSynchronously - Indicates whether the method should return only once enabling this rule and stamping existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.
Throws:
Exception

enableAlwaysMoveItemsInConversations

public ServiceResponseCollection<ServiceResponse> enableAlwaysMoveItemsInConversations(Iterable<ConversationId> conversationId,
                                                                                       FolderId destinationFolderId,
                                                                                       boolean processSynchronously)
                                                                                throws Exception
Sets up a conversation so that any item received within that conversation is always moved to a specific folder. Calling this method results in a call to EWS.

Parameters:
conversationId - The Id of the folder to which conversation items 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 items in the conversation is completely done. If processSynchronously is false, the method returns immediately.
Throws:
Exception

disableAlwaysMoveItemsInConversations

public ServiceResponseCollection<ServiceResponse> disableAlwaysMoveItemsInConversations(Iterable<ConversationId> conversationIds,
                                                                                        boolean processSynchronously)
                                                                                 throws Exception
Sets up a conversation so that any item received within that conversation is no longer moved to a specific folder. Calling this method results in a call to EWS.

Parameters:
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.
Throws:
Exception

moveItemsInConversations

public ServiceResponseCollection<ServiceResponse> moveItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs,
                                                                           FolderId contextFolderId,
                                                                           FolderId destinationFolderId)
                                                                    throws Exception
Moves the items in the specified conversation to the specified destination folder. Calling this method results in a call to EWS.

Parameters:
idLastSyncTimePairs - The pairs of Id of conversation whose items 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.
Throws:
Exception

copyItemsInConversations

public ServiceResponseCollection<ServiceResponse> copyItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs,
                                                                           FolderId contextFolderId,
                                                                           FolderId destinationFolderId)
                                                                    throws Exception
Copies the items in the specified conversation to the specified destination folder. Calling this method results in a call to EWS.

Parameters:
idLastSyncTimePairs - The pairs of Id of conversation whose items 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.
Throws:
Exception

deleteItemsInConversations

public ServiceResponseCollection<ServiceResponse> deleteItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs,
                                                                             FolderId contextFolderId,
                                                                             DeleteMode deleteMode)
                                                                      throws Exception
Deletes the items in the specified conversation. Calling this method results in a call to EWS.

Parameters:
idLastSyncTimePairs - The pairs of Id of conversation whose items 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 mode
Throws:
Exception
Exception

setReadStateForItemsInConversations

public ServiceResponseCollection<ServiceResponse> setReadStateForItemsInConversations(Iterable<HashMap<ConversationId,Date>> idLastSyncTimePairs,
                                                                                      FolderId contextFolderId,
                                                                                      boolean isRead)
                                                                               throws Exception
Sets the read state for items in conversation. Calling this mehtod would result in call to EWS.

Parameters:
idLastSyncTimePairs - The pairs of Id of conversation whose items 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 true, conversation items are marked as read; otherwise they are marked as unread.
Throws:
Exception
Exception

convertIds

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

Parameters:
ids - the ids
destinationFormat - the destination format
Returns:
A ServiceResponseCollection providing conversion results for each specified Ids.
Throws:
Exception - the exception

convertId

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

Parameters:
id - the id
destinationFormat - the destination format
Returns:
The converted Id.
Throws:
Exception - the exception

addDelegates

public Collection<DelegateUserResponse> addDelegates(Mailbox mailbox,
                                                     MeetingRequestsDeliveryScope meetingRequestsDeliveryScope,
                                                     DelegateUser... delegateUsers)
                                              throws Exception
* Adds delegates to a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
meetingRequestsDeliveryScope - the meeting requests delivery scope
delegateUsers - the delegate users
Returns:
A collection of DelegateUserResponse objects providing the results of the operation.
Throws:
Exception - the exception

addDelegates

public Collection<DelegateUserResponse> addDelegates(Mailbox mailbox,
                                                     MeetingRequestsDeliveryScope meetingRequestsDeliveryScope,
                                                     Iterable<DelegateUser> delegateUsers)
                                              throws Exception
* Adds delegates to a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
meetingRequestsDeliveryScope - the meeting requests delivery scope
delegateUsers - the delegate users
Returns:
A collection of DelegateUserResponse objects providing the results of the operation.
Throws:
Exception - the exception

updateDelegates

public Collection<DelegateUserResponse> updateDelegates(Mailbox mailbox,
                                                        MeetingRequestsDeliveryScope meetingRequestsDeliveryScope,
                                                        DelegateUser... delegateUsers)
                                                 throws Exception
* Updates delegates on a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
meetingRequestsDeliveryScope - the meeting requests delivery scope
delegateUsers - the delegate users
Returns:
A collection of DelegateUserResponse objects providing the results of the operation.
Throws:
Exception - the exception

updateDelegates

public Collection<DelegateUserResponse> updateDelegates(Mailbox mailbox,
                                                        MeetingRequestsDeliveryScope meetingRequestsDeliveryScope,
                                                        Iterable<DelegateUser> delegateUsers)
                                                 throws Exception
* Updates delegates on a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
meetingRequestsDeliveryScope - the meeting requests delivery scope
delegateUsers - the delegate users
Returns:
A collection of DelegateUserResponse objects providing the results of the operation.
Throws:
Exception - the exception

removeDelegates

public Collection<DelegateUserResponse> removeDelegates(Mailbox mailbox,
                                                        UserId... userIds)
                                                 throws Exception
* Removes delegates on a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
userIds - the user ids
Returns:
A collection of DelegateUserResponse objects providing the results of the operation.
Throws:
Exception - the exception

removeDelegates

public Collection<DelegateUserResponse> removeDelegates(Mailbox mailbox,
                                                        Iterable<UserId> userIds)
                                                 throws Exception
* Removes delegates on a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
userIds - the user ids
Returns:
A collection of DelegateUserResponse objects providing the results of the operation.
Throws:
Exception - the exception

getDelegates

public DelegateInformation getDelegates(Mailbox mailbox,
                                        boolean includePermissions,
                                        UserId... userIds)
                                 throws Exception
* Retrieves the delegates of a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
includePermissions - the include permissions
userIds - the user ids
Returns:
A GetDelegateResponse providing the results of the operation.
Throws:
Exception - the exception

getDelegates

public DelegateInformation getDelegates(Mailbox mailbox,
                                        boolean includePermissions,
                                        Iterable<UserId> userIds)
                                 throws Exception
* Retrieves the delegates of a specific mailbox. Calling this method results in a call to EWS.

Parameters:
mailbox - the mailbox
includePermissions - the include permissions
userIds - the user ids
Returns:
A GetDelegateResponse providing the results of the operation.
Throws:
Exception - the exception

createUserConfiguration

protected void createUserConfiguration(UserConfiguration userConfiguration)
                                throws Exception
Creates the user configuration.

Parameters:
userConfiguration - the user configuration
Throws:
Exception - the exception

deleteUserConfiguration

protected void deleteUserConfiguration(String name,
                                       FolderId parentFolderId)
                                throws Exception
* Creates a UserConfiguration.

Parameters:
name - the name
parentFolderId - the parent folder id
Throws:
Exception - the exception

getUserConfiguration

protected UserConfiguration getUserConfiguration(String name,
                                                 FolderId parentFolderId,
                                                 UserConfigurationProperties properties)
                                          throws IndexOutOfBoundsException,
                                                 Exception
* Creates a UserConfiguration.

Parameters:
name - the name
parentFolderId - the parent folder id
properties - the properties
Returns:
the user configuration
Throws:
IndexOutOfBoundsException - the index out of bounds exception
Exception - the exception

loadPropertiesForUserConfiguration

protected void loadPropertiesForUserConfiguration(UserConfiguration userConfiguration,
                                                  UserConfigurationProperties properties)
                                           throws Exception
* Loads the properties of the specified userConfiguration.

Parameters:
userConfiguration - the user configuration
properties - the properties
Throws:
Exception - the exception

updateUserConfiguration

protected void updateUserConfiguration(UserConfiguration userConfiguration)
                                throws Exception
* Updates a UserConfiguration.

Parameters:
userConfiguration - the user configuration
Throws:
Exception - the exception

getInboxRules

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

Returns:
A RuleCollection object containing the authenticated users inbox rules.
Throws:
Exception

getInboxRules

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

Parameters:
mailboxSmtpAddress - The SMTP address of the user whose inbox rules should be retrieved
Returns:
A RuleCollection object containing the inbox rules of the specified user.
Throws:
Exception

updateInboxRules

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

Parameters:
operations - The operations that should be applied to the user's inbox rules.
removeOutlookRuleBlob - Indicate whether or not to remove Outlook Rule Blob.
Throws:
Exception

updateInboxRules

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

Parameters:
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 retrieved
Throws:
Exception

autodiscoverUrl

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

Parameters:
emailAddress - the email address
Throws:
Exception - the exception

autodiscoverUrl

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

Parameters:
emailAddress - the email address to use.
validateRedirectionUrlCallback - The callback used to validate redirection URL
Throws:
Exception - the exception

executeDiagnosticMethod

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

Parameters:
verb - The verb.
parameter - The parameter.
Throws:
Exception

validate

protected void validate()
                 throws ServiceLocalException
* Validates this instance.

Overrides:
validate in class ExchangeServiceBase
Throws:
ServiceLocalException - the service local exception

prepareHttpWebRequest

protected microsoft.exchange.webservices.data.HttpWebRequest prepareHttpWebRequest()
                                                                            throws ServiceLocalException,
                                                                                   URISyntaxException
Prepare http web request.

Returns:
the http web request
Throws:
ServiceLocalException - the service local exception
URISyntaxException - the uRI syntax exception

processHttpErrorResponse

protected void processHttpErrorResponse(microsoft.exchange.webservices.data.HttpWebRequest httpWebResponse,
                                        Exception webException)
                                 throws Exception
Processes an HTTP error response.

Specified by:
processHttpErrorResponse in class ExchangeServiceBase
Parameters:
httpWebResponse - The HTTP web response.
webException - The web exception
Throws:
Exception

getUrl

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

Returns:
URL of the Exchange Web Services.

setUrl

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

Parameters:
url - URL of the Exchange Web Services.

getImpersonatedUserId

public ImpersonatedUserId getImpersonatedUserId()
Gets the impersonated user id.

Returns:
the impersonated user id

setImpersonatedUserId

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

Parameters:
impersonatedUserId - the new impersonated user id

getPreferredCulture

public Locale getPreferredCulture()
Gets the preferred culture.

Returns:
the preferred culture

setPreferredCulture

public void setPreferredCulture(Locale preferredCulture)
Sets the preferred culture.

Parameters:
preferredCulture - the new preferred culture

getFileAttachmentContentHandler

public IFileAttachmentContentHandler getFileAttachmentContentHandler()
Gets the file attachment content handler.

Returns:
the file attachment content handler

setFileAttachmentContentHandler

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

Parameters:
fileAttachmentContentHandler - the new file attachment content handler

getUnifiedMessaging

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

Returns:
the unified messaging

getEnableScpLookup

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

setEnableScpLookup

public void setEnableScpLookup(boolean value)

getExchange2007CompatibilityMode

protected boolean getExchange2007CompatibilityMode()
Gets or sets a value indicating whether Exchange2007 compatibility mode is enabled. In order to support E12 servers, the Exchange2007CompatibilityMode property can be used to indicate that we should use "Exchange2007" as the server version string rather than Exchange2007_SP1.

setExchange2007CompatibilityMode

protected void setExchange2007CompatibilityMode(boolean value)

getServerTimeZones

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

Parameters:
timeZoneIds - the time zone ids
Returns:
A Collection containing the definitions of the specified time zones.

getServerTimeZones

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

Returns:
A Collection containing the definitions of the specified time zones.

autodiscoverRedirectionUrlValidationCallback

public boolean autodiscoverRedirectionUrlValidationCallback(String redirectionUrl)
                                                     throws AutodiscoverLocalException
Description copied from interface: IAutodiscoverRedirectionUrl
Autodiscover redirection url validation callback.

Specified by:
autodiscoverRedirectionUrlValidationCallback in interface IAutodiscoverRedirectionUrl
Parameters:
redirectionUrl - the redirection url
Returns:
true, if successful
Throws:
AutodiscoverLocalException - the autodiscover local exception
Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012. All Rights Reserved.