Archives multiple items in a single call to EWS.
The Ids of the items to move.
The Id of the folder in primary corresponding to which items are being archived to.
A ServiceResponseCollection providing copy results for each of the specified item Ids :Promise.
Initializes the Url property to the Exchange Web Services URL for the specified e-mail address by calling the Autodiscover service.
The email address to use.
Initializes the Url property to the Exchange Web Services URL for the specified e-mail address by calling the Autodiscover service.
The email address to use.
The callback used to validate redirection URL.
The folder id.
The property set.
Folder object :Promise.
The folder id.
Type to Cast - pass Folder or subclass itself, not an instance
Folder object :Promise.
Binds to multiple items in a single call to EWS.
The Ids of the items to bind to.
The set of properties to load.
The SmtpAddress of mailbox that hosts all items we need to bind to
A ServiceResponseCollection providing results for each of the specified item Ids :Promise.
The item id.
The property set.
Item :Promise.
The item id.
The property set.
Item type class ex: Item, EmailMessage etc..
Item :Promise.
Binds to multiple items in a single call to EWS.
The Ids of the items to bind to.
The set of properties to load.
A ServiceResponseCollection providing results for each of the specified item Ids :Promise.
Copies multiple items in a single call to EWS.
The Ids of the items to copy.
The Id of the folder to copy the items to.
A ServiceResponseCollection providing copy results for each of the specified item Ids :Promise.
Copies multiple items in a single call to EWS.
The Ids of the items to copy.
The Id of the folder to copy the items to.
Flag indicating whether service should return new ItemIds or not.
A ServiceResponseCollection providing copy results for each of the specified item Ids :Promise.
The parent item id.
The attachments.
Service response collection :Promise.
The item to create.
The Id of the folder in which to place the newly created item. If null, the item is created in its default folders.
Indicates the disposition mode for items of type EmailMessage. Required if item is an EmailMessage instance.
Indicates if and how invitations should be sent for item of type Appointment. Required if item is an Appointment instance.
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.
The items to create.
The Id of the folder in which to place the newly created items. If null, items are created in their default folders.
Indicates the disposition mode for items of type EmailMessage. Required if items contains at least one EmailMessage instance.
Indicates if and how invitations should be sent for items of type Appointment. Required if items contains at least one Appointment instance.
A ServiceResponseCollection providing creation results for each of the specified items :Promise.
Default implementation of AutodiscoverRedirectionUrlValidationCallback. Always returns true indicating that the URL can be used.
The redirection URL.
Returns true.
The attachments.
Service response collection :Promise.
The folder id.
The delete mode.
The Id of the item to delete.
The deletion mode.
Indicates whether cancellation messages should be sent. Required if the item Id represents an Appointment.
Indicates which instance of a recurring task should be deleted. Required if item Id represents a Task.
The Id of the item to delete.
The deletion mode.
Indicates whether cancellation messages should be sent. Required if the item Id represents an Appointment.
Indicates which instance of a recurring task should be deleted. Required if item Id represents a Task.
Whether to suppress read receipts
Deletes multiple items in a single call to EWS.
The Ids of the items to delete.
The deletion mode.
Indicates whether cancellation messages should be sent. Required if the item Id represents an Appointment.
Indicates which instance of a recurring task should be deleted. Required if item Id represents a Task.
A ServiceResponseCollection providing deletion results for each of the specified item Ids :Promise.
Deletes multiple items in a single call to EWS.
The Ids of the items to delete.
The deletion mode.
Indicates whether cancellation messages should be sent. Required if the item Id represents an Appointment.
Indicates which instance of a recurring task should be deleted. Required if item Id represents a Task.
A ServiceResponseCollection providing deletion results for each of the specified item Ids :Promise.
The folder id.
The delete mode.
if set to true empty folder should also delete sub folders.
Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.
The Id of the group to expand.
An ExpandGroupResults containing the members of the group :Promise.
Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.
The SMTP address of the group to expand.
An ExpandGroupResults containing the members of the group :Promise.
Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.
The e-mail address of the group.
An ExpandGroupResults containing the members of the group :Promise.
Expands a group by retrieving a list of its members. Calling this method results in a call to EWS.
The SMTP address of the group to expand.
The routing type of the address of the group to expand.
An ExpandGroupResults containing the members of the group :Promise.
Obtains a list of appointments by searching the contents of a specific folder. Calling this method results in a call to EWS.
The name of the calendar folder in which to search for items.
The calendar view controlling the number of appointments returned.
A collection of appointments representing the contents of the specified folder :Promise.
Obtains a list of appointments by searching the contents of a specific folder. Calling this method results in a call to EWS.
The id of the calendar folder in which to search for items.
The calendar view controlling the number of appointments returned.
A collection of appointments representing the contents of the specified folder :Promise.
Obtains a list of folders by searching the sub-folders of the specified folder.
The Id of the folder in which to search for folders.
The view controlling the number of folders returned.
An object representing the results of the search operation :Promise.
Obtains a list of folders by searching the sub-folders of the specified folder.
The name of the folder in which to search for folders.
The view controlling the number of folders returned.
An object representing the results of the search operation :Promise.
Obtains a list of folders by searching the sub-folders of the specified folder.
The Id of the folder in which to search for folders.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
The view controlling the number of folders returned.
An object representing the results of the search operation :Promise.
Obtains a list of folders by searching the sub-folders of the specified folder.
The name of the folder in which to search for folders.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
The view controlling the number of folders returned.
An object representing the results of the search operation :Promise.
Obtains a list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The name of the folder in which to search for items.
The view controlling the number of items returned.
An object representing the results of the search operation :Promise.
Obtains a list of items by searching the contents of a specific folder. Along with conversations, a list of highlight terms are returned. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
The view controlling the number of items returned.
An object representing the results of the search operation :Promise.
Obtains a grouped list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
The view controlling the number of items returned.
The group by clause.
A collection of grouped items representing the contents of the specified :Promise.
Obtains a list of items by searching the contents of a specific folder. Along with conversations, a list of highlight terms are returned. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
The search string to be used for indexed search, if any.
The view controlling the number of items returned.
An object representing the results of the search operation :Promise.
Obtains a list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The name of the folder in which to search for items.
The search string to be used for indexed search, if any.
The view controlling the number of items returned.
An object representing the results of the search operation :Promise.
Obtains a list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The name of the folder in which to search for items.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
The view controlling the number of items returned.
An object representing the results of the search operation :Promise.
Obtains a list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
The view controlling the number of items returned.
An object representing the results of the search operation :Promise.
Obtains a grouped list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
The view controlling the number of items returned.
The group by clause.
A collection of grouped items representing the contents of the specified :Promise.
Obtains a grouped list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
The search string to be used for indexed search, if any.
The view controlling the number of items returned.
The group by clause.
A collection of grouped items representing the contents of the specified :Promise.
Obtains a grouped list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The name of the folder in which to search for items.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
The view controlling the number of items returned.
The group by clause.
A collection of grouped items representing the contents of the specified :Promise.
Obtains a grouped list of items by searching the contents of a specific folder. Calling this method results in a call to EWS.
The name of the folder in which to search for items.
The search string to be used for indexed search, if any.
The view controlling the number of items returned.
The group by clause.
A collection of grouped items representing the contents of the specified :Promise.
Obtains a list of items by searching the contents of a specific folder. Along with conversations, a list of highlight terms are returned. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
the search string to be used for indexed search, if any.
Flag indicating if highlight terms should be returned in the response
The view controlling the number of items returned.
An object representing the results of the search operation :Promise.
Obtains a list of items by searching the contents of a specific folder. Along with conversations, a list of highlight terms are returned. Calling this method results in a call to EWS.
The Id of the folder in which to search for items.
the search string to be used for indexed search, if any.
Flag indicating if highlight terms should be returned in the response
The view controlling the number of items returned.
The group by clause.
An object representing the results of the search operation :Promise.
The parent folder ids.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
query string to be used for indexed search.
The view controlling the number of items returned.
The group by.
Indicates the type of error handling should be done.
Service response collection :Promise.
The attachment.
Type of the body.
The additional properties.
Gets attachments.
The attachments.
Type of the body.
The additional properties.
Service response collection :Promise.
Gets attachments.
The attachment ids.
Type of the body.
The additional properties.
Service response collection :Promise.
Gets the EWS URL from Autodiscover.
The email address.
Exchange version.
The validate redirection URL callback.
Ews URL :Promise.
Gets the EWS URL from Autodiscover GetUserSettings response.
The response.
If true, Autodiscover call was made externally.
EWS URL.
Gets detailed information about the availability of a set of users, rooms, and resources within a specified time window.
The attendees for which to retrieve availability information.
The time window in which to retrieve user availability information.
The requested data (free/busy and/or suggestions).
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 :Promise.
Gets detailed information about the availability of a set of users, rooms, and resources within a specified time window.
The attendees for which to retrieve availability information.
The time window in which to retrieve user availability information.
The requested data (free/busy and/or suggestions).
The options controlling the information returned.
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 :Promise.
Binds to multiple items in a single call to EWS.
The Ids of the items to bind to.
The set of properties to load.
The SmtpAddress of mailbox that hosts all items we need to bind to
Type of error handling to perform.
A ServiceResponseCollection providing results for each of the specified item Ids :Promise.
Copies multiple items in a single call to EWS.
The Ids of the items to bind to.
The Id of the folder to copy the items to.
Flag indicating whether service should return new ItemIds or not.
What type of error handling should be performed.
A ServiceResponseCollection providing copy results for each of the specified item Ids :Promise.
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.
The items to create.
The Id of the folder in which to place the newly created items. If null, items are created in their default folders.
Indicates the disposition mode for items of type EmailMessage. Required if items contains at least one EmailMessage instance.
Indicates if and how invitations should be sent for items of type Appointment. Required if items contains at least one Appointment instance.
What type of error handling should be performed.
A ServiceResponseCollection providing creation results for each of the specified items :Promise.
The response object.
The parent folder id.
The message disposition.
The list of items created or modified as a result of the "creation" of the response object :Promise.
Deletes multiple items in a single call to EWS.
The Ids of the items to delete.
The deletion mode.
Indicates whether cancellation messages should be sent. Required if any of the item Ids represents an Appointment.
Indicates which instance of a recurring task should be deleted. Required if any of the item Ids represents a Task.
Type of error handling to perform.
Whether to suppress read receipts
A ServiceResponseCollection providing deletion results for each of the specified item Ids :Promise.
Finds folders.
The parent folder ids.
The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection
The view controlling the number of folders returned.
Indicates the type of error handling should be done.
Collection of service responses :Promise.
Gets attachments.
Type of the body.
The additional properties.
Service response collection :Promise.
The items to load the properties of.
The set of properties to load.
Indicates the type of error handling should be done.
A ServiceResponseCollection providing results for each of the specified items :Promise.
Moves multiple items in a single call to EWS.
The Ids of the items to move.
The Id of the folder to move the items to.
Flag indicating whether service should return new ItemIds or not.
What type of error handling should be performed.
A ServiceResponseCollection providing copy results for each of the specified item Ids :Promise.
Updates multiple items in a single EWS call. UpdateItems does not support items that have unsaved attachments.
The items to update.
The folder in which to save sent messages, meeting invitations or cancellations. If null, the messages, meeting invitation or cancellations are saved in the Sent Items folder.
The conflict resolution mode.
Indicates the disposition mode for items of type EmailMessage. Required if items contains at least one EmailMessage instance.
Indicates if and how invitations and/or cancellations should be sent for items of type Appointment. Required if items contains at least one Appointment instance.
What type of error handling should be performed.
Whether to suppress read receipts
A ServiceResponseCollection providing update results for each of the specified items :Promise.
The folder.
The property set.
Loads the properties of multiple items in a single call to EWS. Unstable for Extended Properties
The items to load the properties of.
The set of properties to load.
A ServiceResponseCollection providing results for each of the specified items :Promise.
Mark items as junk.
ItemIds for the items to mark
Whether the items are junk. If true, senders are add to blocked sender list. If false, senders are removed.
Whether to move the item. Items are moved to junk folder if isJunk is true, inbox if isJunk is false.
A ServiceResponseCollection providing itemIds for each of the moved items :Promise.
Moves multiple items in a single call to EWS.
The Ids of the items to move.
The Id of the folder to move the items to.
A ServiceResponseCollection providing copy results for each of the specified item Ids :Promise.
Moves multiple items in a single call to EWS.
The Ids of the items to move.
The Id of the folder to move the items to.
Flag indicating whether service should return new ItemIds or not.
A ServiceResponseCollection providing copy results for each of the specified item Ids :Promise.
Name of the method.
An instance of IXHROptions to call web service with.
Finds contacts in the Global Address List and/or in specific contact folders that have names that match the one passed as a parameter. Calling this method results in a call to EWS.
The name to resolve.
A collection of name resolutions whose names match the one passed as a parameter :Promise.
Finds contacts in the Global Address List and/or in specific contact folders that have names that match the one passed as a parameter. Calling this method results in a call to EWS.
The name to resolve.
The scope of the search.
Indicates whether full contact information should be returned for each of the found contacts.
A collection of name resolutions whose names match the one passed as a parameter :Promise.
Finds contacts in the Global Address List and/or in specific contact folders that have names that match the one passed as a parameter. Calling this method results in a call to EWS.
The name to resolve.
The scope of the search.
Indicates whether full contact information should be returned for each of the found contacts.
The property set for the contct details
A collection of name resolutions whose names match the one passed as a parameter :Promise.
Finds contacts in the Global Address List and/or in specific contact folders that have names that match the one passed as a parameter. Calling this method results in a call to EWS.
The name to resolve.
The Ids of the contact folders in which to look for matching contacts.
The scope of the search.
Indicates whether full contact information should be returned for each of the found contacts.
A collection of name resolutions whose names match the one passed as a parameter :Promise.
Finds contacts in the Global Address List and/or in specific contact folders that have names that match the one passed as a parameter. Calling this method results in a call to EWS.
The name to resolve.
The Ids of the contact folders in which to look for matching contacts.
The scope of the search.
Indicates whether full contact information should be returned for each of the found contacts.
The property set for the contct details
A collection of name resolutions whose names match the one passed as a parameter :Promise.
Sets the type of the content.
The request.
The item to update.
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.
The conflict resolution mode.
Indicates the disposition mode for an item of type EmailMessage. Required if item is an EmailMessage instance.
Indicates if and how invitations and/or cancellations should be sent for ian tem of type Appointment. Required if item is an Appointment instance.
Updated item : Promise.
The item to update.
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.
The conflict resolution mode.
Indicates the disposition mode for an item of type EmailMessage. Required if item is an EmailMessage instance.
Indicates if and how invitations and/or cancellations should be sent for ian tem of type Appointment. Required if item is an Appointment instance.
Whether to suppress read receipts
Updated item : Promise.
Updates multiple items in a single EWS call. UpdateItems does not support items that have unsaved attachments.
The items to update.
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.
The conflict resolution mode.
Indicates the disposition mode for an item of type EmailMessage. Required if item is an EmailMessage instance.
Indicates if and how invitations and/or cancellations should be sent for ian tem of type Appointment. Required if item is an Appointment instance.
A ServiceResponseCollection providing update results for each of the specified items : Promise.
Updates multiple items in a single EWS call. UpdateItems does not support items that have unsaved attachments.
The items to update.
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.
The conflict resolution mode.
Indicates the disposition mode for an item of type EmailMessage. Required if item is an EmailMessage instance.
Indicates if and how invitations and/or cancellations should be sent for ian tem of type Appointment. Required if item is an Appointment instance.
Whether to suppress read receipts
A ServiceResponseCollection providing update results for each of the specified items : Promise.
the version string
Generated using TypeDoc
Represents a binding to the Exchange Web Services.