Операция GetSearchableMailboxes

Статья
03/29/2023

Важно!

С 1 апреля 2020 г. операция GetSearchableMailboxes больше не будет доступна в Exchange Online. Эта операция не будет затронута в локальных версиях Exchange Server. Дополнительные сведения см. в статье Прекращение использования устаревших средств обнаружения электронных данных в Exchange Online.

Найдите сведения об операции GetSearchableMailboxes EWS.

Операция GetSearchableMailboxes получает набор почтовых ящиков с заданной областью для поиска обнаружения. Область доступных для поиска почтовых ящиков, возвращаемых в ответе, определяется фильтром поиска и расширением членства в группе рассылки.

Примечание.

Эта операция предназначена для использования с фильтром поиска и получения только первых нескольких тысяч; он не предназначен для получения исчерпывающих данных.

Эта операция появилась в Exchange Server 2013.

Использование операции GetSearchableMailboxes

Операция GetSearchableMailboxes получает сведения о почтовых ящиках с возможностью поиска. В запросе можно передать следующие аргументы:

SearchFilter — принимает один псевдоним электронной почты в качестве аргумента.
ExpandGroupMembership — указывает, расширено ли членство в группе рассылки в результатах, возвращенных в ответе.

Если псевдоним электронной почты, заданный в фильтре поиска, является группой рассылки и членство в группе рассылки не расширено, ответ будет содержать сведения о почтовом ящике для группы рассылки. Если псевдоним электронной почты, заданный в фильтре поиска, является группой рассылки и членство в группе рассылки расширено, ответ будет содержать сведения о почтовом ящике для каждого почтового ящика, который является членом группы рассылки. Если фильтр поиска содержит псевдоним одного пользователя, ответ будет содержать сведения о почтовом ящике для одного пользователя. Если элемент GetSearchableMailboxes пуст, ответ будет содержать все почтовые ящики с возможностью поиска. Это то же самое, что пустой элемент SearchFilter , а элемент ExpandGroupMembership имеет значение false.

Заголовки SOAP операции GetSearchableMailboxes

Операция 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.