Opération FindItem

Article
03/29/2023

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

L’opération FindItem recherche les éléments qui se trouvent dans la boîte aux lettres d’un utilisateur. Cette opération offre de nombreuses façons de filtrer et de mettre en forme la façon dont les résultats de la recherche sont retournés à l’appelant.

Utilisation de l’opération FindItem

La demande d’opération FindItem vous permet de rechercher dans une boîte aux lettres et de mettre en forme la façon dont les données sont retournées dans une réponse. Vous pouvez spécifier les éléments suivants dans une requête FindItem :

Indique si la recherche est une traversée superficielle ou supprimée de manière réversible. Cette spécification est obligatoire. Notez qu’une traversée supprimée de manière réversible combinée à une restriction de recherche entraîne le renvoi de zéro élément, même s’il existe des éléments qui correspondent aux critères de recherche.
Forme de réponse des éléments. Identifie les propriétés retournées dans la réponse. Cette spécification est obligatoire.
Dossiers à partir desquels effectuer la recherche. Cette spécification est obligatoire.
Le mécanisme de pagination et les types d’affichage pour retourner des données d’affichage dans les pages. Cette spécification est facultative.
Options de regroupement et de tri des éléments retournés. Cette spécification est facultative.
Restrictions de recherche ou chaînes de syntaxe de requête avancée (AQS) pour filtrer les éléments retournés. Pour plus d’informations sur l’utilisation d’AQS pour les recherches d’index de contenu, consultez QueryString (String). Cette spécification est facultative.
Ordre de tri des éléments retournés dans la réponse. Cette spécification est facultative.

L’opération FindItem retourne uniquement les 512 premiers octets d’une propriété pouvant être diffusée en continu. Pour Unicode, il retourne les 255 premiers caractères à l’aide d’une chaîne Unicode terminée par null. Il ne retourne aucun des formats de corps de message ou des listes de destinataires. FindItem renvoie un résumé du destinataire. Vous pouvez utiliser l’opération GetItem pour obtenir les détails d’un élément.

FindItem renvoie uniquement l’élément Name (EmailAddressType) et ne renvoie pas l’élément EmailAddress (NonEmptyStringType) dans l’élément Mailbox pour les champs suivants :

Champ De pour les messages
Champ Expéditeur pour les messages
Champ Organisateur pour les éléments de calendrier

Remarque

L’opération FindItem peut retourner des résultats dans un élément CalendarView. L’élément CalendarView renvoie des éléments de calendrier uniques et toutes les occurrences de réunions périodiques. Si aucun élément CalendarView n’est utilisé, des éléments de calendrier uniques et des éléments de calendrier principal récurrents sont retournés. Les occurrences doivent être développées à partir du maître périodique si aucun élément CalendarView n’est utilisé.

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

Tableau 1. En-têtes SOAP de l’opération FindItem

Header	Élément	Description
DateTimePrecision	DateTimePrecision	Spécifie la résolution des valeurs de données/temps dans les réponses du serveur, en secondes ou en millisecondes. Cela s’applique à une demande.
Imitation	ExchangeImpersonation	Identifie l’utilisateur que l’application cliente emprunte l’identité. Cela s’applique à une demande.
MailboxCulture	MailboxCulture	Identifie la culture RFC3066 à utiliser pour accéder à la boîte aux lettres. Cela s’applique à une demande.
RequestVersion	RequestServerVersion	Identifie la version du schéma pour la demande d’opération. Cela s’applique à une demande.
ServerVersion	ServerVersionInfo	Identifie la version du serveur qui a répondu à la requête. Cela s’applique à une réponse.
TimeZoneContext	TimeZoneContext	Identifie le fuseau horaire à utiliser pour toutes les réponses du serveur. Cela s’applique à une demande.

Exemple de demande d’opération FindItem

L’exemple suivant de requête FindItem montre comment obtenir l’identificateur d’élément défini par l’énumération IdOnly de l’élément BaseShape pour les éléments qui se trouvent dans le dossier Éléments supprimés.

<?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">
  <soap:Body>
    <FindItem xmlns="https://schemas.microsoft.com/exchange/services/2006/messages"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
              Traversal="Shallow">
      <ItemShape>
        <t:BaseShape>IdOnly</t:BaseShape>
      </ItemShape>
      <ParentFolderIds>
        <t:DistinguishedFolderId Id="deleteditems"/>
      </ParentFolderIds>
    </FindItem>
  </soap:Body>
</soap:Envelope>

Les éléments suivants sont utilisés dans la demande :

Pour plus d’options pour un message de demande FindItem , explorez la hiérarchie de schéma. Commencez par l’élément FindItem .

Réponse de l’opération FindItem réussie

L’exemple suivant montre une réponse réussie à la requête FindItem .

Les éléments de message représentent les messages électroniques et tous les autres éléments qui ne sont pas fortement typés par le schéma EWS. Éléments tels que IPM. Partage et IPM. InfoPath est retourné en tant qu’éléments Message . Exchange ne retourne pas l’élément Item de base dans les réponses.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <t:ServerVersionInfo MajorVersion="8" MinorVersion="0" MajorBuildNumber="595" MinorBuildNumber="0" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindItemResponse xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages" 
                      xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" 
                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <m:ResponseMessages>
        <m:FindItemResponseMessage ResponseClass="Success">
          <m:ResponseCode>NoError</m:ResponseCode>
          <m:RootFolder TotalItemsInView="10" IncludesLastItemInRange="true">
            <t:Items>
              <t:Message>
                <t:ItemId Id="AS4AUn=" ChangeKey="fsVU4==" />
              </t:Message>
              <t:Message>
                <t:ItemId Id="AS4AUM=" ChangeKey="fsVUA==" />
              </t:Message>
            </t:Items>
          </m:RootFolder>
        </m:FindItemResponseMessage>
      </m:ResponseMessages>
    </FindItemResponse>
  </soap:Body>
</soap:Envelope>

Les éléments suivants sont utilisés dans la réponse :

Pour plus d’options pour un message de réponse FindItem , explorez la hiérarchie de schéma. Commencez par l’élément FindItemResponse .

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

L’exemple suivant montre une réponse d’erreur à une requête FindItem .

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <t:ServerVersionInfo MajorVersion="8" MinorVersion="0" MajorBuildNumber="595" MinorBuildNumber="0" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindItemResponse xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages" 
                      xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" 
                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <m:ResponseMessages>
        <m:FindItemResponseMessage ResponseClass="Error">
          <m:MessageText>Id is malformed.</m:MessageText>
          <m:ResponseCode>ErrorInvalidIdMalformed</m:ResponseCode>
          <m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
        </m:FindItemResponseMessage>
      </m:ResponseMessages>
    </FindItemResponse>
  </soap:Body>
</soap:Envelope>

Les éléments suivants sont utilisés dans la réponse d'erreur :

Pour plus d’options pour un message de réponse d’erreur FindItem , explorez la hiérarchie de schéma. Commencez par l’élément FindItemResponse .

Différences entre les versions

Les versions d’Exchange commençant par la version principale 15 et se terminant par la build 15.0.898.11 retournent une valeur ErrorInvalidOperation dans l’élément ResponseCode lorsque l’opération FindItem est utilisée pour rechercher plusieurs dossiers dans une boîte aux lettres d’archivage.