SetHoldOnMailboxes operation
Important
Starting on April 1, 2020, the SetHoldOnMailboxes operation will no longer be available in Exchange Online. This operation won't be affected in on-premises versions of Exchange Server. For more information, see Retirement of legacy eDiscovery tools in Exchange Online.
Find information about the SetHoldOnMailboxes EWS operation.
The SetHoldOnMailboxes operation sets a mailbox hold policy on mailboxes.
This operation was introduced in Exchange Server 2013.
Using the SetHoldOnMailboxes operation
The SetHoldOnMailboxes operation sets a mailbox hold on to one or more mailboxes.
SetHoldOnMailboxes operation SOAP headers
The SetHoldOnMailboxes operation can use the SOAP headers that are listed in the following table.
| Header name | Element | Description |
|---|---|---|
| ManagementRole |
ManagementRole |
Identifies the server roles that are necessary in order for the caller to make the request. This header is applicable to a request. |
| RequestVersion |
RequestServerVersion |
Identifies the schema version for the operation request. This header is applicable to a request. |
| ServerVersion |
ServerVersionInfo |
Identifies the version of the server that responded to the request. This header is applicable to a response. |
SetHoldOnMailboxes operation request example: Apply a hold on a mailbox
The following example of a SetHoldOnMailboxes operation request shows how to apply a hold on two mailboxes. The mailbox hold was created by using the New-MailboxSearch command.
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
</soap:Header>
<soap:Body >
<m:SetHoldOnMailboxes>
<m:ActionType>Create</m:ActionType>
<m:HoldId>HoldId2</m:HoldId>
<m:Query>test</m:Query>
<m:Mailboxes>
<t:String>/o=First/ou=Exchange(DLT)/cn=Recipients/cn=1fa441ff5e4749ba43ecc0fd94c21adf-Willi</t:String>
<t:String>/o=First/ou=Exchange(DLT)/cn=Recipients/cn=aed2346adaa34ffc9f0f339917e8de95-Micha</t:String>
</m:Mailboxes>
<m:Language>English</m:Language>
<m:IncludeNonIndexableItems>false</m:IncludeNonIndexableItems>
<m:Deduplication>true</m:Deduplication>
</m:SetHoldOnMailboxes>
</soap:Body>
</soap:Envelope>
The request SOAP body contains the following elements:
Successful SetHoldOnMailboxes operation response
The following example shows a successful response to a SetHoldOnMailboxes operation request to put two mailboxes on hold.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="526"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SetHoldOnMailboxesResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<MailboxHoldResult>
<HoldId xmlns="http://schemas.microsoft.com/exchange/services/2006/types">HoldId2</HoldId>
<Query xmlns="http://schemas.microsoft.com/exchange/services/2006/types">test</Query>
<MailboxHoldStatuses xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<MailboxHoldStatus>
<Mailbox>o=First/ou=Exchange(DLT)/cn=Recipients/cn=1fa441ff5e4749ba43ecc0fd94c21adf-Willi</Mailbox>
<Status>Pending</Status>
<AdditionalInfo/>
</MailboxHoldStatus>
<MailboxHoldStatus>
<Mailbox>/o=First/ou=Exchange(DLT)/cn=Recipients/cn=aed2346adaa34ffc9f0f339917e8de95-Micha</Mailbox>
<Status>Pending</Status>
<AdditionalInfo/>
</MailboxHoldStatus>
</MailboxHoldStatuses>
</MailboxHoldResult>
</SetHoldOnMailboxesResponse>
</s:Body>
</s:Envelope>
The response SOAP body contains the following elements:
SetHoldOnMailboxes operation error response
The following example shows an error response to a SetHoldOnMailboxes operation request. This is a response to a request that contains an incorrectly specified mailbox identifier.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="526"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SetHoldOnMailboxesResponse ResponseClass="Error"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<MessageText>No mailbox is specified for hold operation. If specified in the request, then it could be the object does not exist in AD or is a Distribution Group.</MessageText>
<ResponseCode>ErrorInvalidOperation</ResponseCode>
<DescriptiveLinkKey>0</DescriptiveLinkKey>
</SetHoldOnMailboxesResponse>
</s:Body>
</s:Envelope>
The error response SOAP body contains the following elements:
For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.