Class ExchangeService

    • Constructor Detail

      • ExchangeService

        public ExchangeService()
        Initializes a new instance of the ExchangeService 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 ExchangeService 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,
                               org.apache.http.impl.client.CloseableHttpClient httpClient,
                               org.apache.http.impl.client.CloseableHttpClient httpPoolingClient)
        Initializes a new instance of the ExchangeService class, targeting the specified version of EWS and scoped to the system's current time zone. Additionally specifies an external HttpClient to use, e.g. one wired up with a thread-safe pooling http connection factory. It is perfectly acceptable for both arguments to use the same HttpClient.
        Parameters:
        requestedServerVersion - the requested server version
        httpClient - external HttpClient instance to use
        httpPoolingClient - external HttpClient instance to use for pooling
    • Method Detail

      • internalCreateResponseObject

        public List<IteminternalCreateResponseObject​(ServiceObject responseObject,
                                                       FolderId parentFolderId,
                                                       MessageDisposition messageDisposition)
                                                throws Exception
        Create response object.
        Parameters:
        responseObject - the response object
        parentFolderId - the parent folder id
        messageDisposition - the message disposition
        Returns:
        The list of item created or modified as a result of the "creation" of the response object.
        Throws:
        Exception - the exception
      • createFolder

        public void createFolder​(Folder folder,
                                 FolderId parentFolderId)
                          throws Exception
        Creates a folder. Calling this method results in a call to EWS.
        Parameters:
        folder - The folder.
        parentFolderId - The parent folder Id
        Throws:
        Exception - the exception
      • copyFolder

        public Folder copyFolder​(FolderId folderId,
                                 FolderId destinationFolderId)
                          throws Exception
        Copies a folder. Calling this method results in a call to EWS.
        Parameters:
        folderId - The folderId.
        destinationFolderId - The destination folder id.
        Returns:
        the folder
        Throws:
        Exception - the exception
      • moveFolder

        public Folder moveFolder​(FolderId folderId,
                                 FolderId destinationFolderId)
                          throws Exception
        Move a folder.
        Parameters:
        folderId - The folderId.
        destinationFolderId - The destination folder id.
        Returns:
        the folder
        Throws:
        Exception - the exception
      • findFolders

        public FindFoldersResults findFolders​(FolderId parentFolderId,
                                              SearchFilter searchFilter,
                                              FolderView view)
                                       throws Exception
        Obtains a list of folder by searching the sub-folder of the specified folder.
        Parameters:
        parentFolderId - The Id of the folder in which to search for folder.
        searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
        view - The view controlling the number of folder returned.
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findFolders

        public FindFoldersResults findFolders​(FolderId parentFolderId,
                                              FolderView view)
                                       throws Exception
        Obtains a list of folder by searching the sub-folder of the specified folder.
        Parameters:
        parentFolderId - The Id of the folder in which to search for folder.
        view - The view controlling the number of folder returned.
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findFolders

        public FindFoldersResults findFolders​(WellKnownFolderName parentFolderName,
                                              SearchFilter searchFilter,
                                              FolderView view)
                                       throws Exception
        Obtains a list of folder by searching the sub-folder of the specified folder.
        Parameters:
        parentFolderName - The name of the folder in which to search for folder.
        searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
        view - The view controlling the number of folder returned.
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findFolders

        public FindFoldersResults findFolders​(WellKnownFolderName parentFolderName,
                                              FolderView view)
                                       throws Exception
        Obtains a list of folder by searching the sub-folder of the specified folder.
        Parameters:
        parentFolderName - the parent folder name
        view - the view
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • bindToFolder

        public <TFolder extends Folder> TFolder bindToFolder​(Class<TFolder> cls,
                                                             FolderId folderId,
                                                             PropertySet propertySet)
                                                      throws Exception
        Binds to folder.
        Type Parameters:
        TFolder - The type of the folder.
        Parameters:
        cls - Folder class
        folderId - The folder id.
        propertySet - The property set.
        Returns:
        Folder
        Throws:
        Exception - the exception
      • deleteFolder

        public void deleteFolder​(FolderId folderId,
                                 DeleteMode deleteMode)
                          throws Exception
        Deletes a folder. Calling this method results in a call to EWS.
        Parameters:
        folderId - The folder id
        deleteMode - The delete mode
        Throws:
        Exception - the exception
      • emptyFolder

        public void emptyFolder​(FolderId folderId,
                                DeleteMode deleteMode,
                                boolean deleteSubFolders)
                         throws Exception
        Empties a folder. Calling this method results in a call to EWS.
        Parameters:
        folderId - The folder id
        deleteMode - The delete mode
        deleteSubFolders - if set to "true" empty folder should also delete sub folder.
        Throws:
        Exception - the exception
      • createItems

        public ServiceResponseCollection<ServiceResponsecreateItems​(Collection<Item> items,
                                                                      FolderId parentFolderId,
                                                                      MessageDisposition messageDisposition,
                                                                      SendInvitationsMode sendInvitationsMode)
                                                               throws Exception
        Creates multiple item in a single EWS call. Supported item classes are EmailMessage, Appointment, Contact, PostItem, Task and Item. CreateItems does not support item that have unsaved attachments.
        Parameters:
        items - the item
        parentFolderId - the parent folder id
        messageDisposition - the message disposition
        sendInvitationsMode - the send invitations mode
        Returns:
        A ServiceResponseCollection providing creation results for each of the specified item.
        Throws:
        Exception - the exception
      • createItem

        public void createItem​(Item item,
                               FolderId parentFolderId,
                               MessageDisposition messageDisposition,
                               SendInvitationsMode sendInvitationsMode)
                        throws Exception
        Creates an item. Calling this method results in a call to EWS.
        Parameters:
        item - the item
        parentFolderId - the parent folder id
        messageDisposition - the message disposition
        sendInvitationsMode - the send invitations mode
        Throws:
        Exception - the exception
      • updateItem

        public Item updateItem​(Item item,
                               FolderId savedItemsDestinationFolderId,
                               ConflictResolutionMode conflictResolution,
                               MessageDisposition messageDisposition,
                               SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
                        throws Exception
        Updates an item.
        Parameters:
        item - the item
        savedItemsDestinationFolderId - the saved item destination folder id
        conflictResolution - the conflict resolution
        messageDisposition - the message disposition
        sendInvitationsOrCancellationsMode - the send invitations or cancellations mode
        Returns:
        A ServiceResponseCollection providing deletion results for each of the specified item Ids.
        Throws:
        Exception - the exception
      • sendItem

        public void sendItem​(Item item,
                             FolderId savedCopyDestinationFolderId)
                      throws Exception
        Send item.
        Parameters:
        item - the item
        savedCopyDestinationFolderId - the saved copy destination folder id
        Throws:
        Exception - the exception
      • copyItems

        public ServiceResponseCollection<MoveCopyItemResponsecopyItems​(Iterable<ItemId> itemIds,
                                                                         FolderId destinationFolderId,
                                                                         boolean returnNewItemIds)
                                                                  throws Exception
        Copies multiple item in a single call to EWS.
        Parameters:
        itemIds - The Ids of the item to copy.
        destinationFolderId - The Id of the folder to copy the item to.
        returnNewItemIds - Flag indicating whether service should return new ItemIds or not.
        Returns:
        A ServiceResponseCollection providing copy results for each of the specified item Ids.
        Throws:
        Exception - on error
      • copyItem

        public Item copyItem​(ItemId itemId,
                             FolderId destinationFolderId)
                      throws Exception
        Copies an item. Calling this method results in a call to EWS.
        Parameters:
        itemId - The Id of the item to copy.
        destinationFolderId - The folder in which to save sent messages, meeting invitations or cancellations. If null, the message, meeting invitation or cancellation is saved in the Sent Items folder
        Returns:
        The copy of the item.
        Throws:
        Exception - the exception
      • moveItems

        public ServiceResponseCollection<MoveCopyItemResponsemoveItems​(Iterable<ItemId> itemIds,
                                                                         FolderId destinationFolderId,
                                                                         boolean returnNewItemIds)
                                                                  throws Exception
        Moves multiple item in a single call to EWS.
        Parameters:
        itemIds - The Ids of the item to move.
        destinationFolderId - The Id of the folder to move the item to.
        returnNewItemIds - Flag indicating whether service should return new ItemIds or not.
        Returns:
        A ServiceResponseCollection providing copy results for each of the specified item Ids.
        Throws:
        Exception - on error
      • moveItem

        public Item moveItem​(ItemId itemId,
                             FolderId destinationFolderId)
                      throws Exception
        Copies multiple item in a single call to EWS.
        Parameters:
        itemId - the item id
        destinationFolderId - the destination folder id
        Returns:
        A ServiceResponseCollection providing copy results for each of the specified item Ids.
        Throws:
        Exception - the exception
      • findItems

        public <TItem extends ItemServiceResponseCollection<FindItemResponse<TItem>> findItems​(Iterable<FolderId> parentFolderIds,
                                                                                                 SearchFilter searchFilter,
                                                                                                 String queryString,
                                                                                                 ViewBase view,
                                                                                                 Grouping groupBy,
                                                                                                 ServiceErrorHandling errorHandlingMode)
                                                                                          throws Exception
        Finds item.
        Type Parameters:
        TItem - The type of item
        Parameters:
        parentFolderIds - The parent folder ids.
        searchFilter - The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
        queryString - the query string
        view - The view controlling the number of folder returned.
        groupBy - The group by.
        errorHandlingMode - Indicates the type of error handling should be done.
        Returns:
        Service response collection.
        Throws:
        Exception - the exception
      • findItems

        public FindItemsResults<ItemfindItems​(FolderId parentFolderId,
                                                String queryString,
                                                ItemView view)
                                         throws Exception
        Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderId - the parent folder id
        queryString - the query string
        view - the view
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findItems

        public FindItemsResults<ItemfindItems​(FolderId parentFolderId,
                                                SearchFilter searchFilter,
                                                ItemView view)
                                         throws Exception
        Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderId - the parent folder id
        searchFilter - the search filter
        view - the view
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findItems

        public FindItemsResults<ItemfindItems​(FolderId parentFolderId,
                                                ItemView view)
                                         throws Exception
        Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderId - the parent folder id
        view - the view
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findItems

        public FindItemsResults<ItemfindItems​(WellKnownFolderName parentFolderName,
                                                String queryString,
                                                ItemView view)
                                         throws Exception
        Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderName - the parent folder name
        queryString - the query string
        view - the view
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findItems

        public FindItemsResults<ItemfindItems​(WellKnownFolderName parentFolderName,
                                                SearchFilter searchFilter,
                                                ItemView view)
                                         throws Exception
        Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderName - the parent folder name
        searchFilter - the search filter
        view - the view
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findItems

        public FindItemsResults<ItemfindItems​(WellKnownFolderName parentFolderName,
                                                ItemView view)
                                         throws Exception
        Obtains a list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderName - the parent folder name
        view - the view
        Returns:
        An object representing the results of the search operation.
        Throws:
        Exception - the exception
      • findItems

        public GroupedFindItemsResults<ItemfindItems​(FolderId parentFolderId,
                                                       String queryString,
                                                       ItemView view,
                                                       Grouping groupBy)
                                                throws Exception
        Obtains a grouped list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderId - the parent folder id
        queryString - the query string
        view - the view
        groupBy - the group by
        Returns:
        A list of item containing the contents of the specified folder.
        Throws:
        Exception - the exception
      • findItems

        public GroupedFindItemsResults<ItemfindItems​(FolderId parentFolderId,
                                                       SearchFilter searchFilter,
                                                       ItemView view,
                                                       Grouping groupBy)
                                                throws Exception
        Obtains a grouped list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderId - the parent folder id
        searchFilter - the search filter
        view - the view
        groupBy - the group by
        Returns:
        A list of item containing the contents of the specified folder.
        Throws:
        Exception - the exception
      • findItems

        public GroupedFindItemsResults<ItemfindItems​(FolderId parentFolderId,
                                                       ItemView view,
                                                       Grouping groupBy)
                                                throws Exception
        Obtains a grouped list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderId - the parent folder id
        view - the view
        groupBy - the group by
        Returns:
        A list of item containing the contents of the specified folder.
        Throws:
        Exception - the exception
      • findItems

        protected <TItem extends ItemServiceResponseCollection<FindItemResponse<TItem>> findItems​(Class<TItem> cls,
                                                                                                    FolderId parentFolderId,
                                                                                                    SearchFilter searchFilter,
                                                                                                    ViewBase view,
                                                                                                    Grouping groupBy)
                                                                                             throws Exception
        Obtains a grouped list of item 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 item containing the contents of the specified folder.
        Throws:
        Exception - the exception
      • findItems

        public GroupedFindItemsResults<ItemfindItems​(WellKnownFolderName parentFolderName,
                                                       String queryString,
                                                       ItemView view,
                                                       Grouping groupBy)
                                                throws Exception
        Obtains a grouped list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderName - the parent folder name
        queryString - the query string
        view - the view
        groupBy - the group by
        Returns:
        A collection of grouped item containing the contents of the specified.
        Throws:
        Exception - the exception
      • findItems

        public GroupedFindItemsResults<ItemfindItems​(WellKnownFolderName parentFolderName,
                                                       SearchFilter searchFilter,
                                                       ItemView view,
                                                       Grouping groupBy)
                                                throws Exception
        Obtains a grouped list of item by searching the contents of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        parentFolderName - the parent folder name
        searchFilter - the search filter
        view - the view
        groupBy - the group by
        Returns:
        A collection of grouped item containing the contents of the specified.
        Throws:
        Exception - the exception
      • findAppointments

        public FindItemsResults<AppointmentfindAppointments​(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<AppointmentfindAppointments​(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
      • bindToItem

        public Item bindToItem​(ItemId itemId,
                               PropertySet propertySet)
                        throws Exception
        Binds to multiple item 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

        public <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
      • deleteItem

        public 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
      • 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,
                                                    Iterable<FolderId> parentFolderIds,
                                                    ResolveNameSearchLocation searchScope,
                                                    boolean returnContactDetails,
                                                    PropertySet contactDataPropertySet)
                                             throws Exception
        Finds contacts in the Global Address List and/or in specific contact folder 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 Ids of the contact folder in which to look for matching contacts.
        searchScope - The scope of the search.
        returnContactDetails - Indicates whether full contact information should be returned for each of the found contacts.
        contactDataPropertySet - The property set for the contact details
        Returns:
        a collection of name resolutions whose names match the one passed as a parameter
        Throws:
        Exception - on error
      • resolveName

        public NameResolutionCollection resolveName​(String nameToResolve,
                                                    ResolveNameSearchLocation searchScope,
                                                    boolean returnContactDetails,
                                                    PropertySet contactDataPropertySet)
                                             throws Exception
        Finds contacts in the Global Address List 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 scope of the search.
        returnContactDetails - Indicates whether full contact information should be returned for each of the found contacts.
        contactDataPropertySet - The property set for the contact details
        Returns:
        A collection of name resolutions whose names match the one passed as a parameter.
        Throws:
        Exception - on error
      • 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 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:
        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
      • getPasswordExpirationDate

        public Date getPasswordExpirationDate​(String mailboxSmtpAddress)
                                       throws Exception
        Get the password expiration date
        Parameters:
        mailboxSmtpAddress - The e-mail address of the user.
        Returns:
        The password expiration date
        Throws:
        Exception - on error
      • subscribeToPullNotifications

        public PullSubscription subscribeToPullNotifications​(Iterable<FolderId> folderIds,
                                                             int timeout,
                                                             String watermark,
                                                             EventType... eventTypes)
                                                      throws Exception
        Subscribes to pull notification. Calling this method results in a call to EWS.
        Parameters:
        folderIds - The Ids of the folder to subscribe to
        timeout - The timeout, in minutes, after which the subscription expires. Timeout must be between 1 and 1440.
        watermark - An optional watermark representing a previously opened subscription.
        eventTypes - The event types to subscribe to.
        Returns:
        A PullSubscription representing the new subscription.
        Throws:
        Exception - on error
      • beginSubscribeToPullNotifications

        public AsyncRequestResult beginSubscribeToPullNotifications​(AsyncCallback callback,
                                                                    Object state,
                                                                    Iterable<FolderId> folderIds,
                                                                    int timeout,
                                                                    String watermark,
                                                                    EventType... eventTypes)
                                                             throws Exception
        Begins an asynchronous request to subscribes to pull notification. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate.
        state - An object that contains state information for this request.
        folderIds - The Ids of the folder to subscribe to.
        timeout - The timeout, in minutes, after which the subscription expires. Timeout must be between 1 and 1440.
        watermark - An optional watermark representing a previously opened subscription.
        eventTypes - The event types to subscribe to.
        Returns:
        An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • subscribeToPullNotificationsOnAllFolders

        public PullSubscription subscribeToPullNotificationsOnAllFolders​(int timeout,
                                                                         String watermark,
                                                                         EventType... eventTypes)
                                                                  throws Exception
        Subscribes to pull notification on all folder 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
      • beginSubscribeToPullNotificationsOnAllFolders

        public IAsyncResult beginSubscribeToPullNotificationsOnAllFolders​(AsyncCallback callback,
                                                                          Object state,
                                                                          int timeout,
                                                                          String watermark,
                                                                          EventType... eventTypes)
                                                                   throws Exception
        Begins an asynchronous request to subscribe to pull notification on all folder in the authenticated user's mailbox. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate.
        state - An object that contains state information for this request.
        timeout - The timeout, in minutes, after which the subscription expires. Timeout must be between 1 and 1440.
        watermark - An optional watermark representing a previously opened subscription.
        eventTypes - The event types to subscribe to.
        Returns:
        An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • endSubscribeToPullNotifications

        public PullSubscription endSubscribeToPullNotifications​(IAsyncResult asyncResult)
                                                         throws Exception
        Ends an asynchronous request to subscribe to pull notification in the authenticated user's mailbox.
        Parameters:
        asyncResult - An IAsyncResult that references the asynchronous request.
        Returns:
        A PullSubscription representing the new subscription.
        Throws:
        Exception
      • unsubscribe

        public 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
      • beginUnsubscribe

        public IAsyncResult beginUnsubscribe​(AsyncCallback callback,
                                             Object state,
                                             String subscriptionId)
                                      throws Exception
        Begins an asynchronous request to unsubscribe from a subscription. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate.
        state - An object that contains state information for this request.
        subscriptionId - The Id of the pull subscription to unsubscribe from.
        Returns:
        An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • endUnsubscribe

        public void endUnsubscribe​(IAsyncResult asyncResult)
                            throws Exception
        Ends an asynchronous request to unsubscribe from a subscription.
        Parameters:
        asyncResult - An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • getEvents

        public 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
      • beginGetEvents

        public IAsyncResult beginGetEvents​(AsyncCallback callback,
                                           Object state,
                                           String subscriptionId,
                                           String watermark)
                                    throws Exception
        Begins an asynchronous request to retrieve the latest events associated with a pull subscription. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate.
        state - An object that contains state information for this request.
        subscriptionId - The id of the pull subscription for which to get the events
        watermark - The watermark representing the point in time where to start receiving events
        Returns:
        An IAsynResult that references the asynchronous request
        Throws:
        Exception
      • endGetEvents

        public GetEventsResults endGetEvents​(IAsyncResult asyncResult)
                                      throws Exception
        Ends an asynchronous request to retrieve the latest events associated with a pull subscription.
        Parameters:
        asyncResult - An IAsyncResult that references the asynchronous request.
        Returns:
        A GetEventsResults containing a list of events associated with the subscription.
        Throws:
        Exception
      • subscribeToPushNotifications

        public PushSubscription subscribeToPushNotifications​(Iterable<FolderId> folderIds,
                                                             URI url,
                                                             int frequency,
                                                             String watermark,
                                                             EventType... eventTypes)
                                                      throws Exception
        Subscribes to push notification. 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
      • beginSubscribeToPushNotifications

        public IAsyncResult beginSubscribeToPushNotifications​(AsyncCallback callback,
                                                              Object state,
                                                              Iterable<FolderId> folderIds,
                                                              URI url,
                                                              int frequency,
                                                              String watermark,
                                                              EventType... eventTypes)
                                                       throws Exception
        Begins an asynchronous request to subscribe to push notification. Calling this method results in a call to EWS.
        Parameters:
        callback - The asynccallback delegate
        state - An object that contains state information for this request
        folderIds - The ids of the folder to subscribe
        url - the url of web service endpoint the exchange server should
        frequency - the frequency,in minutes at which the exchange server should contact the web Service endpoint. Frequency must be between 1 and 1440.
        watermark - An optional watermark representing a previously opened subscription
        eventTypes - The event types to subscribe to.
        Returns:
        An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • subscribeToPushNotificationsOnAllFolders

        public PushSubscription subscribeToPushNotificationsOnAllFolders​(URI url,
                                                                         int frequency,
                                                                         String watermark,
                                                                         EventType... eventTypes)
                                                                  throws Exception
        Subscribes to push notification on all folder 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
      • beginSubscribeToPushNotificationsOnAllFolders

        public IAsyncResult beginSubscribeToPushNotificationsOnAllFolders​(AsyncCallback callback,
                                                                          Object state,
                                                                          URI url,
                                                                          int frequency,
                                                                          String watermark,
                                                                          EventType... eventTypes)
                                                                   throws Exception
        Begins an asynchronous request to subscribe to push notification on all folder in the authenticated user's mailbox. Calling this method results in a call to EWS.
        Parameters:
        callback - The asynccallback delegate
        state - An object that contains state inforamtion for this request
        url - the url
        frequency - the frequency,in minutes at which the exchange server should contact the web Service endpoint. Frequency must be between 1 and 1440.
        watermark - An optional watermark representing a previously opened subscription
        eventTypes - The event types to subscribe to.
        Returns:
        An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • endSubscribeToPushNotifications

        public PushSubscription endSubscribeToPushNotifications​(IAsyncResult asyncResult)
                                                         throws Exception
        Ends an asynchronous request to subscribe to push notification in the authenticated user's mailbox.
        Parameters:
        asyncResult - An IAsyncResult that references the asynchronous request.
        Returns:
        A PushSubscription representing the new subscription
        Throws:
        Exception
      • beginSubscribeToStreamingNotifications

        public IAsyncResult beginSubscribeToStreamingNotifications​(AsyncCallback callback,
                                                                   Object state,
                                                                   Iterable<FolderId> folderIds,
                                                                   EventType... eventTypes)
                                                            throws Exception
        Begins an asynchronous request to subscribe to streaming notification. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate
        state - An object that contains state information for this request.
        folderIds - The Ids of the folder to subscribe to.
        eventTypes - The event types to subscribe to.
        Returns:
        An IAsyncResult that references the asynchronous request
        Throws:
        Exception
      • beginSubscribeToStreamingNotificationsOnAllFolders

        public IAsyncResult beginSubscribeToStreamingNotificationsOnAllFolders​(AsyncCallback callback,
                                                                               Object state,
                                                                               EventType... eventTypes)
                                                                        throws Exception
        Begins an asynchronous request to subscribe to streaming notification on all folder in the authenticated user's mailbox. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate
        state - An object that contains state information for this request.
        Returns:
        An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • syncFolderItems

        public ChangeCollection<ItemChangesyncFolderItems​(FolderId syncFolderId,
                                                            PropertySet propertySet,
                                                            Iterable<ItemId> ignoredItemIds,
                                                            int maxChangesReturned,
                                                            SyncFolderItemsScope syncScope,
                                                            String syncState)
                                                     throws Exception
        Synchronizes the item of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        syncFolderId - The Id of the folder containing the item to synchronize with.
        propertySet - The set of property to retrieve for synchronized item.
        ignoredItemIds - The optional list of item Ids that should be ignored.
        maxChangesReturned - The maximum number of changes that should be returned.
        syncScope - The sync scope identifying item to include in the ChangeCollection.
        syncState - The optional sync state representing the point in time when to start the synchronization.
        Returns:
        A ChangeCollection containing a list of changes that occurred in the specified folder.
        Throws:
        Exception - the exception
      • beginSyncFolderItems

        public IAsyncResult beginSyncFolderItems​(AsyncCallback callback,
                                                 Object state,
                                                 FolderId syncFolderId,
                                                 PropertySet propertySet,
                                                 Iterable<ItemId> ignoredItemIds,
                                                 int maxChangesReturned,
                                                 SyncFolderItemsScope syncScope,
                                                 String syncState)
                                          throws Exception
        Begins an asynchronous request to synchronize the item of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate
        state - An object that contains state information for this request
        syncFolderId - The Id of the folder containing the item to synchronize with
        propertySet - The set of property to retrieve for synchronized item.
        ignoredItemIds - The optional list of item Ids that should be ignored.
        maxChangesReturned - The maximum number of changes that should be returned.
        syncScope - The sync scope identifying item to include in the ChangeCollection
        syncState - The optional sync state representing the point in time when to start the synchronization
        Returns:
        An IAsyncResult that references the asynchronous request.
        Throws:
        Exception
      • endSyncFolderItems

        public ChangeCollection<ItemChangeendSyncFolderItems​(IAsyncResult asyncResult)
                                                        throws Exception
        Ends an asynchronous request to synchronize the item of a specific folder.
        Parameters:
        asyncResult - An IAsyncResult that references the asynchronous request.
        Returns:
        A ChangeCollection containing a list of changes that occurred in the specified folder.
        Throws:
        Exception
      • syncFolderHierarchy

        public ChangeCollection<FolderChangesyncFolderHierarchy​(FolderId syncFolderId,
                                                                  PropertySet propertySet,
                                                                  String syncState)
                                                           throws Exception
        Synchronizes the sub-folder 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
      • beginSyncFolderHierarchy

        public IAsyncResult beginSyncFolderHierarchy​(AsyncCallback callback,
                                                     Object state,
                                                     FolderId syncFolderId,
                                                     PropertySet propertySet,
                                                     String syncState)
                                              throws Exception
        Begins an asynchronous request to synchronize the sub-folder of a specific folder. Calling this method results in a call to EWS.
        Parameters:
        callback - The AsyncCallback delegate
        state - An object that contains state information for this request.
        syncFolderId - The Id of the folder containing the item to synchronize with. A null value indicates the root folder of the mailbox.
        propertySet - The set of property to retrieve for synchronized item.
        syncState - The optional sync state representing the point in time when to start the synchronization.
        Returns:
        An IAsyncResult that references the asynchronous request
        Throws:
        Exception
      • syncFolderHierarchy

        public ChangeCollection<FolderChangesyncFolderHierarchy​(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 set of property to retrieve for synchronized item.
        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
      • endSyncFolderHierarchy

        public ChangeCollection<FolderChangeendSyncFolderHierarchy​(IAsyncResult asyncResult)
                                                              throws Exception
        Ends an asynchronous request to synchronize the specified folder hierarchy of the mailbox this Service is connected to.
        Parameters:
        asyncResult - An IAsyncResult that references the asynchronous request.
        Returns:
        A ChangeCollection containing a list of changes that occurred in the specified folder.
        Throws:
        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
      • getRooms

        public Collection<EmailAddressgetRooms​(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
      • enableAlwaysCategorizeItemsInConversations

        public ServiceResponseCollection<ServiceResponseenableAlwaysCategorizeItemsInConversations​(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 item in the conversation.
        processSynchronously - Indicates whether the method should return only once enabling this rule and stamping existing item in the conversation is completely done. If processSynchronously is false, the method returns immediately.
        Throws:
        Exception
      • disableAlwaysCategorizeItemsInConversations

        public ServiceResponseCollection<ServiceResponsedisableAlwaysCategorizeItemsInConversations​(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 item in the conversation is completely done. If processSynchronously is false, the method returns immediately.
        Throws:
        Exception
      • enableAlwaysDeleteItemsInConversations

        public ServiceResponseCollection<ServiceResponseenableAlwaysDeleteItemsInConversations​(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 item in the conversation is completely done. If processSynchronously is false, the method returns immediately.
        Throws:
        Exception
      • disableAlwaysDeleteItemsInConversations

        public ServiceResponseCollection<ServiceResponsedisableAlwaysDeleteItemsInConversations​(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 item in the conversation is completely done. If processSynchronously is false, the method returns immediately.
        Throws:
        Exception
      • enableAlwaysMoveItemsInConversations

        public ServiceResponseCollection<ServiceResponseenableAlwaysMoveItemsInConversations​(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 item should be moved.
        destinationFolderId - The Id of the destination folder.
        processSynchronously - Indicates whether the method should return only once enabling this rule and stamping existing item in the conversation is completely done. If processSynchronously is false, the method returns immediately.
        Throws:
        Exception
      • disableAlwaysMoveItemsInConversations

        public ServiceResponseCollection<ServiceResponsedisableAlwaysMoveItemsInConversations​(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<ServiceResponsemoveItemsInConversations​(Iterable<HashMap<ConversationId,​Date>> idLastSyncTimePairs,
                                                                                   FolderId contextFolderId,
                                                                                   FolderId destinationFolderId)
                                                                            throws Exception
        Moves the item 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 item should be moved and the dateTime conversation was last synced (Items received after that dateTime will not be moved).
        contextFolderId - The Id of the folder that contains the conversation.
        destinationFolderId - The Id of the destination folder.
        Throws:
        Exception
      • copyItemsInConversations

        public ServiceResponseCollection<ServiceResponsecopyItemsInConversations​(Iterable<HashMap<ConversationId,​Date>> idLastSyncTimePairs,
                                                                                   FolderId contextFolderId,
                                                                                   FolderId destinationFolderId)
                                                                            throws Exception
        Copies the item 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 item should be copied and the dateTime conversation was last synced (Items received after that dateTime will not be copied).
        contextFolderId - The context folder id.
        destinationFolderId - The destination folder id.
        Throws:
        Exception
      • deleteItemsInConversations

        public ServiceResponseCollection<ServiceResponsedeleteItemsInConversations​(Iterable<HashMap<ConversationId,​Date>> idLastSyncTimePairs,
                                                                                     FolderId contextFolderId,
                                                                                     DeleteMode deleteMode)
                                                                              throws Exception
        Deletes the item in the specified conversation. Calling this method results in a call to EWS.
        Parameters:
        idLastSyncTimePairs - The pairs of Id of conversation whose item should be deleted and the date and time conversation was last synced (Items received after that date will not be deleted). conversation was last synced (Items received after that dateTime will not be copied).
        contextFolderId - The Id of the folder that contains the conversation.
        deleteMode - The deletion mode
        Throws:
        Exception
      • setReadStateForItemsInConversations

        public ServiceResponseCollection<ServiceResponsesetReadStateForItemsInConversations​(Iterable<HashMap<ConversationId,​Date>> idLastSyncTimePairs,
                                                                                              FolderId contextFolderId,
                                                                                              boolean isRead)
                                                                                       throws Exception
        Sets the read state for item in conversation. Calling this mehtod would result in call to EWS.
        Parameters:
        idLastSyncTimePairs - The pairs of Id of conversation whose item should read state set and the date and time conversation was last synced (Items received after that date will not have their read state set). was last synced (Items received after that date will not be deleted). conversation was last synced (Items received after that dateTime will not be copied).
        contextFolderId - The Id of the folder that contains the conversation.
        isRead - if set to true, conversation item are marked as read; otherwise they are marked as unread.
        Throws:
        Exception
      • addDelegates

        public Collection<DelegateUserResponseaddDelegates​(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 request 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<DelegateUserResponseupdateDelegates​(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 request 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<DelegateUserResponseremoveDelegates​(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
      • 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
      • 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
      • 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.
      • setImpersonatedUserId

        public void setImpersonatedUserId​(ImpersonatedUserId impersonatedUserId)
        Sets the impersonated user id.
        Parameters:
        impersonatedUserId - the new impersonated user id
      • setPreferredCulture

        public void setPreferredCulture​(Locale preferredCulture)
        Sets the preferred culture.
        Parameters:
        preferredCulture - the new preferred culture
      • getDateTimePrecision

        public DateTimePrecision getDateTimePrecision()
        Gets the DateTime precision for DateTime values returned from Exchange Web Services.
        Returns:
        the DateTimePrecision
      • setPreferredCulture

        public void setPreferredCulture​(DateTimePrecision dateTimePrecision)
        Sets the DateTime precision for DateTime values returned from Exchange Web Services.
        Parameters:
        dateTimePrecision - the new DateTimePrecision
      • 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.
        Returns:
        enable scp lookup flag.
      • getExchange2007CompatibilityMode

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

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

        In order to support E12 servers, the exchange2007CompatibilityMode property, set to true, can be used to indicate that we should use "Exchange2007" as the server version String rather than Exchange2007_SP1.

        Parameters:
        value - true if the Exchange2007 compatibility mode is enabled.