Opération GetSearchableMailboxes

Article
03/29/2023

Importante

À compter du 1er avril 2020, l’opération GetSearchableMailboxes ne sera plus disponible dans Exchange Online. Cette opération n’est pas affectée dans les versions locales de Exchange Server. Pour plus d’informations, consultez Retrait des outils eDiscovery hérités dans Exchange Online.

Recherchez des informations sur l’opération GetSearchableMailboxes EWS.

L’opération GetSearchableMailboxes obtient un ensemble étendu de boîtes aux lettres pouvant faire l’objet d’une recherche pour les recherches de découverte. L’étendue des boîtes aux lettres pouvant faire l’objet d’une recherche renvoyées dans la réponse est déterminée par le filtre de recherche et si l’appartenance au groupe de distribution est développée.

Remarque

Cette opération est destinée à être utilisée avec le filtre de recherche et à récupérer uniquement les premiers milliers ; il n’est pas destiné à une récupération exhaustive.

Cette opération est une nouveauté d’Exchange Server 2013.

Utilisation de l’opération GetSearchableMailboxes

L’opération GetSearchableMailboxes obtient des informations sur les boîtes aux lettres pouvant faire l’objet d’une recherche. Les arguments suivants peuvent être passés dans la requête :

SearchFilter : accepte un alias d’e-mail unique en tant qu’argument.
ExpandGroupMembership : indique si l’appartenance au groupe de distribution est développée dans les résultats retournés dans la réponse.

Si l’alias de messagerie défini dans le filtre de recherche est un groupe de distribution et que l’appartenance au groupe de distribution n’est pas développée, la réponse contient les informations de boîte aux lettres pour le groupe de distribution. Si l’alias de messagerie défini dans le filtre de recherche est un groupe de distribution et que l’appartenance au groupe de distribution est développée, la réponse contient les informations de boîte aux lettres pour chaque boîte aux lettres membre du groupe de distribution. Si le filtre de recherche contient l’alias d’un seul utilisateur, la réponse contient les informations de boîte aux lettres pour l’utilisateur unique. La réponse contient toutes les boîtes aux lettres pouvant faire l’objet d’une recherche si l’élément GetSearchableMailboxes est vide. Cela équivaut à avoir un élément SearchFilter vide et l’élément ExpandGroupMembership défini sur false.

En-têtes SOAP de l’opération GetSearchableMailboxes

L’opération GetSearchableMailboxes peut utiliser les en-têtes SOAP répertoriés dans le tableau suivant.

Nom de l’en-tête	Élément	Description
Managementrole	Managementrole	Identifie les rôles de serveur nécessaires pour que l’appelant effectue la demande. Cet en-tête s’applique à une requête.
RequestVersion	RequestServerVersion	Identifie la version du schéma pour la demande d’opération. Cet en-tête s’applique à une requête.
ServerVersion	ServerVersionInfo	Identifie la version du serveur qui a répondu à la requête. Cet en-tête s’applique à une réponse.

Exemple de demande d’opération GetSearchableMailboxes : Demander des informations sur un groupe de distribution

L’exemple suivant de demande d’opération GetSearchableMailboxes montre comment obtenir les informations de boîte aux lettres pour le groupe de distribution 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>

Le corps SOAP de la demande contient les éléments suivants :

Réponse de l’opération GetSearchableMailboxes réussie : obtenir des informations sur un groupe de distribution

L’exemple suivant montre une réponse réussie à une demande d’opération GetSearchableMailboxes pour obtenir les informations de découverte pour le groupe de distribution 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>

Le corps SOAP de la réponse contient les éléments suivants :

Réponse de l’opération GetSearchableMailboxes réussie : obtenir des informations sur un groupe de distribution développé

L’exemple suivant montre une réponse réussie à une demande d’opération GetSearchableMailboxes pour obtenir les informations de découverte sur les membres du groupe de distribution lolgroup développé.

<?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>

Le corps SOAP de la réponse contient les éléments suivants :

Réponse d’erreur de l’opération GetSearchableMailboxes

L’exemple suivant montre une réponse d’erreur à une demande d’opération GetSearchableMailboxes . Il s’agit d’une réponse à une demande d’obtention de toutes les boîtes aux lettres pouvant faire l’objet d’une recherche lorsque l’argument ExpandGroupMembership a la valeur 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>

Le corps SOAP de la réponse d’erreur contient les éléments suivants :

Pour obtenir des codes d’erreur supplémentaires génériques pour EWS et spécifiques à cette opération, consultez ResponseCode.