EWS operations in Exchange 2013
Published: July 16, 2012
Find information about the EWS operations that are available in Exchange.
Applies to: Exchange 2013 | Exchange Online | Exchange Server 2007 | Exchange Server 2010
In this article
Overview of the EWS SOAP operations
eDiscovery operations
Exchange mailbox data operations
Availability operations
Bulk transfer operations
Delegate management operations
Inbox rules operations
Mail app management operations
Mail tips operation
Message tracking operations
Notification operations
Persona operations
Retention policy operation
Service configuration operation
Sharing operations
Synchronization operations
Time zone operation
Unified Messaging operations
Unified Contact Store operations
User configuration operations
Additional resources
Exchange Web Services (EWS) provides many operations that enable you to access information from the Exchange store. The articles in this section provide information about the overall structure of the requests, responses, and error response messages for EWS operations, as well as XML examples for each operation. They provide an overview of the message structures that are sent between the client and the server. You can use this information to debug message structures and to find information about what you can do in an EWS request. For more information about what the XML structure represents, see EWS XML elements in Exchange 2013.
All EWS functionality is associated with a version of the schema. New EWS schema versions are introduced in new releases of Exchange Server or Exchange Online. The RequestServerVersion element contains a Version attribute that maps the server version to the schema version. This article provides information about when each operation was introduced. Specific functionality within an operation might require a later version of the service. The versioned schemas are implemented so that clients that are designed against an older version of EWS will work with a newer version of EWS.
These operations can target the EWS endpoint that services your mailbox. You can browse to the EWS endpoint by using a URL that is similar in structure to http://<clientaccessserver>.com/ews/exchange.asmx, where <clientaccessserver> is the Exchange Client Access server that services your mailbox. You can use Autodiscover to get the URL to the Client Access server that services your mailbox. For more information about Autodiscover, see Autodiscover for Exchange 2013.
The eDiscovery operations provide search operations for legal holds and identify mailbox data that cannot be indexed and returned in discovery search results.
The following table lists the eDiscovery operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange Server 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
The Exchange mailbox data operations enable clients to handle and organize items, folders, and attachments, as well as ambiguous name resolution and distribution list expansion. Exchange mailbox data operations include item, folder, attachment, and utilities operations.
The following table lists the Exchange mailbox data operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2013 |
|
|
Exchange Server 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2013 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
The following table lists the Exchange mailbox data folder operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2007 |
|
|
Exchange 2013 |
|
|
Exchange 2007. This functionality has been deemphasized in versions of Exchange starting with Exchange Server 2010. For more information about how to migrate to using retention tags and policies for messaging records management, see Migrate from Managed Folders. |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2010 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
The following table lists the Exchange mailbox data attachment operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2007 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
The following table lists the Exchange mailbox data conversation operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 Service Pack 1 (SP1) |
|
|
Exchange 2010 SP1 |
|
|
Exchange 2013 |
The following table lists the Exchange mailbox data utilities operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2007 Service Pack 1 |
|
|
Exchange 2007 |
|
|
Exchange 2013. This operation has both a REST and a SOAP implementation. |
|
|
Exchange 2013 |
|
|
Exchange 2007 |
|
|
Exchange 2010 SP1 |
The availability operations improve the calendar and free/busy sharing experience by providing more secure, up-to-date, and rich free/busy information. Free/busy data is a critical component of scheduling meetings. The availability operations provide a reliable foundation for effective scheduling.
The following table lists the availability operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2007 |
|
|
Exchange 2010 |
|
|
Exchange 2010 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
The bulk transfer operations enable clients to stream items into and out of a mailbox.
The following table lists the bulk transfer operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 SP1 |
|
|
Exchange 2010 SP1 |
The delegate management operations enable clients to add, get, update, and remove delegates from their mailboxes.
The following table lists the delegate management operations.
|
Operation name |
Introduced in with: |
|---|---|
|
Exchange 2007 Service Pack 1 (SP1) |
|
|
Exchange 2007 SP1 |
|
|
Exchange 2007 SP1 |
|
|
Exchange 2007 SP1 |
The Inbox rules operations enable clients to get Inbox rules and update them for messages on the server. Inbox rules are sets of conditions and associated actions that enable clients to automatically organize, categorize, and act on messages as the messages are delivered to a folder.
The following table lists the Inbox rules operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 SP1 |
|
|
Exchange 2010 SP1 |
The mail app management operations enable you to manage mail apps for Outlook. You can use these operations to install, uninstall, disable, and get information about mail apps that are available for Outlook Web App and Outlook 2013.
The following table lists the mail app management operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
The mail tips operation enables clients to request information from the server about recipient mailboxes when an author is composing a message. The following table lists the mail tips operation.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 |
The message tracking operations enable clients to find messages that meet specified criteria and to get detailed tracking information about each message in a message tracking report.
The following table lists the message tracking operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 |
|
|
Exchange 2010 |
The notification operations notify the client application of events that are associated with items and folders a specified mailbox. The subscription model can be push-based, pull-based, or streaming-based.
The following table lists the notification operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2007 |
|
|
Exchange 2010 SP1 |
|
|
Exchange 2007 |
|
|
Exchange 2007 |
The persona operations provide an interface to find and get information about a linked contact. The following table lists the persona operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2013 |
|
|
Exchange 2013 |
The retention policy operation provides a list of all the retention tags that are linked to a user's retention policy.
The following table lists the retention policy operation.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2013 |
The service configuration operation enables clients to get configuration information for the Unified Messaging, Protection Rules, Policy Tips, and Mail Tips services.
The following table lists the service configuration operation.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 |
The sharing operations enable clients to share calendar data and contacts data.
The following table lists the sharing operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010. Although the CreateItem operation is applicable to all versions of EWS, the AcceptSharingInvitation response object is only applicable to EWS in versions of Exchange starting with Exchange 2010. |
|
|
Exchange 2010 |
|
|
Exchange 2010 |
|
|
Exchange 2010 |
The synchronization operations provide a one-way synchronized cached copy of a user's folders and items.
The following table lists the synchronization operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2007 |
|
|
Exchange 2007 |
The time zone operation enables clients to get a list of time zone definitions that are supported by the server.
The following table lists the time zone operation.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 |
The Unified Messaging operations enable clients to read information about Unified Messaging properties and to play voice mail messages over the phone.
The following table lists the Unified Messaging operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 |
|
|
Exchange 2010 |
|
|
Exchange 2010 |
Use the GetServiceConfiguration operation to get the Unified Messaging configuration information for a mailbox. Use the Unified Messaging web service for Unified Messaging applications that target Exchange 2007. For more information, see Unified Messaging web service reference for Exchange 2013.
The Unified Contact Store provides a consistent contact experience across Office products and acts as an integration point for third-party applications to use the same contact store. It enables users and applications to store, manage, and access contact information and make it available globally among Lync, Exchange 2013, Outlook, Outlook Web App, and any other application that implements access to the Unified Contact Store. Exchange is the content store for the Unified Contact Store experience.
The following table lists the Unified Contact Store operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
|
|
Exchange 2013 |
The user configuration operations enable clients to create, delete, get, and update user configuration information.
The following table lists the user configuration operations.
|
Operation name |
Introduced in |
|---|---|
|
Exchange 2010 |
|
|
Exchange 2010 |
|
|
Exchange 2010 |
|
|
Exchange 2010 |
