GetSearchableMailboxes 操作

项目
03/29/2023

重要

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

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

GetSearchableMailboxes 操作获取一组限定范围的可搜索邮箱，用于发现搜索。响应中返回的可搜索邮箱的范围由搜索筛选器以及是否扩展通讯组成员身份确定。

注意

此操作旨在与搜索筛选器一起使用，并且仅检索前几千个;它不用于详尽检索。

Exchange Server 2013 中引入了此操作。

使用 GetSearchableMailboxes 操作

GetSearchableMailboxes 操作获取有关可搜索邮箱的信息。可以在请求中传递以下参数：

SearchFilter - 接受单个电子邮件别名作为参数。
ExpandGroupMembership - 指示是否在响应中返回的结果中展开通讯组成员身份。

如果在搜索筛选器中设置的电子邮件别名是通讯组，并且通讯组成员身份未展开，则响应将包含通讯组的邮箱信息。如果在搜索筛选器中设置的电子邮件别名是通讯组，并且通讯组成员身份已展开，则响应将包含通讯组成员的每个邮箱的邮箱信息。如果搜索筛选器包含单个用户的别名，则响应将包含单个用户的邮箱信息。如果 GetSearchableMailboxes 元素为空，响应将包含所有可搜索邮箱。这与将一个空的 SearchFilter 元素和 ExpandGroupMembership 元素设置为 false 相同。

GetSearchableMailboxes 操作 SOAP 标头

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

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

GetSearchableMailboxes 操作请求示例：请求有关通讯组的信息

下面的 GetSearchableMailboxes 操作请求示例演示如何获取 lolgroup 通讯组的邮箱信息。

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
   <soap:Header>
      <t:RequestServerVersion Version="Exchange2013" />
   </soap:Header>
   <soap:Body >
      <m:GetSearchableMailboxes>
         <m:SearchFilter>lolgroup</m:SearchFilter>
         <m:ExpandGroupMembership>false</m:ExpandGroupMembership>
      </m:GetSearchableMailboxes>
   </soap:Body>
</soap:Envelope>

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

成功的 GetSearchableMailboxes 操作响应：获取有关通讯组的信息

以下示例演示对 GetSearchableMailboxes 操作请求的成功响应，以获取 lolgroup 通讯组的发现信息。

<?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="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://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">
      <GetSearchableMailboxesResponse ResponseClass="Success" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <ResponseCode>NoError</ResponseCode>
         <SearchableMailboxes>
            <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <Guid>33a408fe-2574-4e3b-49f5-5e1e000a3035</Guid>
               <PrimarySmtpAddress>LOLgroup@contoso.com</PrimarySmtpAddress>
               <IsExternalMailbox>false</IsExternalMailbox>
               <ExternalEmailAddress/>
               <DisplayName>LOLgroup</DisplayName>
               <IsMembershipGroup>true</IsMembershipGroup>
               <ReferenceId>/o=First/ou=Exchange(FYLT)/cn=Recipients/cn=81213b958a0b5295b13b3f02b812bf1bc-LOLgroup</ReferenceId>
            </SearchableMailbox>
         </SearchableMailboxes>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

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

成功的 GetSearchableMailboxes 操作响应：获取有关扩展的通讯组的信息

以下示例显示了对 GetSearchableMailboxes 操作请求的成功响应，以获取有关展开的 lolgroup 通讯组成员的发现信息。

<?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="https://schemas.microsoft.com/exchange/services/2006/types" xmlns="https://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">
    <GetSearchableMailboxesResponse ResponseClass="Success" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <SearchableMailboxes>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>e2d42cdf-a227-1ec3-486b-6fa0ebaadb9f5</Guid>
          <PrimarySmtpAddress>JSmith@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Julia Smith</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=0a1fc86f883846152405d60956dd02e7-Julia</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>45d0fff1-6541-459a-a343-52453b30e12ca</Guid>
          <PrimarySmtpAddress>LMoore@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Laura Moore</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=2910d8f8316f4378bbf9338d8f9d714b-Laura</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>3c620d04-8b33-435a-95be-5b939375576</Guid>
          <PrimarySmtpAddress>SBrown@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Steven Brown</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=90312341a742f0e47e392c80a60d13ecf-Steve</ReferenceId>
        </SearchableMailbox>
      </SearchableMailboxes>
    </GetSearchableMailboxesResponse>
  </s:Body>
</s:Envelope>

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

GetSearchableMailboxes 操作错误响应

以下示例显示了 对 GetSearchableMailboxes 操作请求的错误响应。这是对 当 ExpandGroupMembership 参数设置为 true 时获取所有可搜索邮箱的请求的响应。

<?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="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://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">
      <GetSearchableMailboxesResponse ResponseClass="Error" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <MessageText>Cannot use wildcard or empty query when auto group expansion is enabled.</MessageText>
         <ResponseCode>ErrorInvalidArgument</ResponseCode>
         <DescriptiveLinkKey>0</DescriptiveLinkKey>
         <SearchableMailboxes/>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

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

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