Opération FindItemFindItem operation

Trouvez des informations sur l’opération EWS FindItem .Find information about the FindItem EWS operation.

L’opération FindItem recherche les éléments qui se trouvent dans la boîte aux lettres d’un utilisateur.The FindItem operation searches for items that are located in a user's mailbox. Cette opération offre plusieurs façons de filtrer et de mettre en forme le mode de renvoi des résultats de la recherche à l’appelant.This operation provides many ways to filter and format how search results are returned to the caller.

Utilisation de l’opération FindItemUsing the FindItem operation

La demande d’opération FindItem vous permet d’effectuer des recherches dans une boîte aux lettres et de mettre en forme les données renvoyées dans une réponse de plusieurs façons.The FindItem operation request provides many ways for you to search a mailbox and format how the data is returned in a response. Vous pouvez spécifier ce qui suit dans une requête FindItem :You can specify the following in a FindItem request:

  • Indique si la recherche est une traversée partielle ou supprimée de manière récupérable.Whether the search is a shallow or soft-deleted traversal. Cette spécification est requise.Specifying this is required. Notez qu’une traversée supprimée de manière récupérable combinée à une restriction de recherche entraîne zéro élément renvoyé, même si des éléments correspondent aux critères de recherche.Note that a soft-deleted traversal combined with a search restriction will result in zero items returned, even if there are items that match the search criteria.

  • Forme de la réponse des éléments.The response shape of items. Cela identifie les propriétés qui sont renvoyées dans la réponse.This identifies the properties that are returned in the response. Cette spécification est requise.Specifying this is required.

  • Dossiers à partir desquels effectuer la recherche.The folders from which to perform the search. Cette spécification est requise.Specifying this is required.

  • Le mécanisme de pagination et les types d’affichage pour retourner les données d’affichage dans les pages.The paging mechanism and view types for returning view data in pages. Cette spécification est facultative.Specifying this is optional.

  • Options de regroupement et de tri des éléments qui sont renvoyés.Options for grouping and sorting the items that are returned. Cette spécification est facultative.Specifying this is optional.

  • Restrictions de recherche ou chaînes de syntaxe de requête avancée (AQS) pour le filtrage des éléments qui sont renvoyés.Search restrictions or Advanced Query Syntax (AQS) strings for filtering the items that are returned. Pour plus d’informations sur l’utilisation de AQS pour les recherches d’index de contenu, voir QueryString (String).For more information about using AQS for content index searches, see QueryString (String). Cette spécification est facultative.Specifying this is optional.

  • Ordre de tri des éléments renvoyés dans la réponse.The sort order for items returned in the response. Cette spécification est facultative.Specifying this is optional.

L’opération FindItem renvoie uniquement les premiers 512 octets de toutes les propriétés transmises en continu.The FindItem operation returns only the first 512 bytes of any streamable property. Pour Unicode, elle renvoie les premiers caractères 255 à l’aide d’une chaîne Unicode terminée par un caractère null.For Unicode, it returns the first 255 characters by using a null-terminated Unicode string. Il ne renvoie aucun des formats de corps de message ou des listes de destinataires.It does not return any of the message body formats or the recipient lists. FindItem renverra un résumé des destinataires.FindItem will return a recipient summary. Vous pouvez utiliser l' opération GetItem pour obtenir les détails d’un élément.You can use the GetItem operation to get the details of an item.

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 :FindItem returns only the Name (EmailAddressType) element and does not return the EmailAddress (NonEmptyStringType) element in the Mailbox element for the following fields:

Notes

L’opération FindItem peut renvoyer des résultats dans un élément CalendarView .The FindItem operation can return results in a CalendarView element. L’élément CalendarView renvoie des éléments de calendrier uniques et toutes les occurrences de réunions périodiques.The CalendarView element returns single calendar items and all occurrences of recurring meetings. Si un élément CalendarView n’est pas utilisé, les éléments de calendrier uniques et les éléments de calendrier maître périodiques sont renvoyés.If a CalendarView element is not used, single calendar items and recurring master calendar items are returned. Les occurrences doivent être étendues à partir de la forme de base périodique si aucun élément CalendarView n’est utilisé.The occurrences must be expanded from the recurring master if a CalendarView element is not used.

L’opération FindItem peut utiliser les en-têtes SOAP répertoriés dans le tableau suivant.The FindItem operation can use the SOAP headers that are listed in the following table.

Tableau 1. En-têtes SOAP d’opération FindItemTable 1. FindItem operation SOAP headers

HeaderHeader ÉlémentElement DescriptionDescription
DateTimePrecisionDateTimePrecision
DateTimePrecisionDateTimePrecision
Spécifie la résolution des valeurs de données/temps dans les réponses du serveur, soit en secondes, soit en millisecondes.Specifies the resolution of data/time values in responses from the server, either in seconds or in milliseconds. Ceci s’applique à une demande.This is applicable to a request.
Emprunt d’identitéImpersonation
ExchangeImpersonationExchangeImpersonation
Identifie l’utilisateur qui emprunte l’identité de l’application cliente.Identifies the user whom the client application is impersonating. Ceci s’applique à une demande.This is applicable to a request.
MailboxCultureMailboxCulture
MailboxCultureMailboxCulture
Identifie la culture RFC3066 à utiliser pour accéder à la boîte aux lettres.Identifies the RFC3066 culture to be used to access the mailbox. Ceci s’applique à une demande.This is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifie la version de schéma de la demande d’opération.Identifies the schema version for the operation request. Ceci s’applique à une demande.This is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifie la version du serveur qui a répondu à la demande.Identifies the version of the server that responded to the request. Ceci s’applique à une réponse.This is applicable to a response.
TimeZoneContextTimeZoneContext
TimeZoneContextTimeZoneContext
Identifie le fuseau horaire à utiliser pour toutes les réponses du serveur.Identifies the time zone to be used for all responses from the server. Ceci s’applique à une demande.This is applicable to a request.

Exemple de requête d’opération FindItemFindItem operation request example

L’exemple de requête FindItem suivant 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.The following example of a FindItem request shows how to obtain the item identifier that is defined by the IdOnly enumeration of the BaseShape element for items that are found in the Deleted Items folder.

<?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 :The following elements are used in the request:

Pour plus d’options pour un message de demande FindItem , explorez la hiérarchie de schéma.For more options for a FindItem request message, explore the schema hierarchy. Commencez par l’élément FindItem .Start at the FindItem element.

Réponse de l’opération FindItem réussieSuccessful FindItem operation response

L’exemple suivant montre une réponse réussie à la demande FindItem .The following example shows a successful response to the FindItem request.

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.Message elements represent email messages and all other items that are not strongly typed by the EWS schema. Des éléments tels que IPM. Le partage et IPM. InfoPath sont renvoyés en tant qu’éléments message .Items such as IPM.Sharing and IPM.InfoPath are returned as Message elements. Exchange ne retourne pas l’élément élément de base dans les réponses.Exchange does not return the base Item element in responses.

<?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 :The following elements are used in the response:

Pour plus d’options pour un message de réponse FindItem , explorez la hiérarchie de schéma.For more options for a FindItem response message, explore the schema hierarchy. Commencez par l’élément FindItemResponse .Start at the FindItemResponse element.

Réponse d’erreur d’opération FindItemFindItem operation error response

L’exemple suivant montre une réponse d’erreur à une requête FindItem .The following example shows an error response to a FindItem request.

<?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 :The following elements are used in the error response:

Pour plus d’options pour un message de réponse d’erreur FindItem , explorez la hiérarchie de schéma.For more options for a FindItem error response message, explore the schema hierarchy. Commencez par l’élément FindItemResponse .Start at the FindItemResponse element.

Différences entre les versionsVersion differences

Les versions d’Exchange commençant par la version principale 15 et se terminant par Build 15.0.898.11 renvoient 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.Versions of Exchange starting with major version 15 and ending with build 15.0.898.11 return an ErrorInvalidOperation value in the ResponseCode element when the FindItem operation is used to search multiple folders in an archive mailbox.

Voir aussiSee also