GetHoldOnMailboxes 操作

项目
03/29/2023

重要

从 2020 年 4 月 1 日开始，GetHoldOnMailboxes 操作将不再在 Exchange Online 中可用。在本地版本的 Exchange Server 中，此操作不会受到影响。有关详细信息，请参阅停用 Exchange Online 中的旧版电子数据展示工具。

查找有关 GetHoldOnMailboxes EWS 操作的信息。

GetHoldOnMailboxes 操作获取特定保留下的邮箱和关联的保留查询。

Exchange Server 2013 中引入了此操作。

使用 GetHoldOnMailboxes 操作

GetHoldOnMailboxes 操作向客户端提供有关哪些邮箱置于特定保留下的信息、有关与每个保留关联的保留查询的信息（如果适用）以及有关每个邮箱的保留状态的信息。有关邮箱保留（包括基于查询的保留）的详细信息，请参阅 TechNet 上的就地保留。

GetHoldOnMailboxes 操作 SOAP 标头

GetHoldOnMailboxes 操作可以使用下表中列出的 SOAP 标头。

标头名称	元素	说明
ManagementRole	ManagementRole	标识调用方发出请求所需的服务器角色。此标头适用于请求。
RequestVersion	RequestServerVersion	标识操作请求的架构版本。此标头适用于请求。
ServerVersion	ServerVersionInfo	标识响应请求的服务器版本。此标头适用于响应。

GetHoldOnMailboxes 操作请求示例：获取邮箱保留信息

下面的 GetHoldOnMailboxes 操作请求示例演示如何获取 HoldId2 邮箱保留的邮箱保留信息。

<?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:GetHoldOnMailboxes>
         <m:HoldId>HoldId2</m:HoldId>
      </m:GetHoldOnMailboxes>
   </soap:Body>
</soap:Envelope>

请求 SOAP 正文包含以下元素：

成功的 GetHoldOnMailboxes 操作响应

以下示例演示对 GetHoldOnMailboxes 操作请求的成功响应，请求获取 HoldId2 邮箱保留的邮箱保留信息。

<?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">
      <GetHoldOnMailboxesResponse 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 Organization/ou=Exchange Administrative Group (FYDIBPDLT)/cn=Recipients/cn=ecc0fd98c2cadf-Willi</Mailbox>
                  <Status>OnHold</Status>
                  <AdditionalInfo/>
               </MailboxHoldStatus>
               <MailboxHoldStatus>
                  <Mailbox>/o=First Organization/ou=Exchange Administrative Group (FYDIBPDLT)/cn=Recipients/cn=dasdat341q8de95-Micha</Mailbox>
                  <Status>OnHold</Status>
                  <AdditionalInfo/>
               </MailboxHoldStatus>
            </MailboxHoldStatuses>
         </MailboxHoldResult>
      </GetHoldOnMailboxesResponse>
   </s:Body>
</s:Envelope>

响应 SOAP 正文包含以下元素：

GetHoldOnMailboxes 操作错误响应

以下示例显示了 对 GetHoldOnMailboxes 操作请求的错误响应。这是对请求获取已删除的保留的响应。

<?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">
      <GetHoldOnMailboxesResponse ResponseClass="Error" 
                                  xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
         <MessageText>The specific query-based hold is not found.</MessageText>
         <ResponseCode>ErrorMailboxHoldNotFound</ResponseCode>
         <DescriptiveLinkKey>0</DescriptiveLinkKey>
      </GetHoldOnMailboxesResponse>
   </s:Body>
</s:Envelope>

错误响应 SOAP 正文包含以下元素：

有关 EWS 通用且特定于此操作的其他错误代码，请参阅 ResponseCode。

通过