Opération FindFolderFindFolder operation

L’opération FindFolder utilise les services Web Exchange pour rechercher des sous-dossiers d’un dossier identifié et renvoie un ensemble de propriétés qui décrivent le jeu de sous-dossiers.The FindFolder operation uses Exchange Web Services to find subfolders of an identified folder and returns a set of properties that describe the set of subfolders.

RemarquesRemarks

FindFolder renvoie uniquement les premiers 512 octets de toutes les propriétés transmises en continu.FindFolder 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.

Les requêtes de parcours approfondi ne peuvent pas être exécutées sur les dossiers publics.Deep traversal queries cannot be performed on public folders.

Les restrictions sont autorisées et doivent utiliser uniquement les propriétés du dossier, pas les propriétés de l’élément.Restrictions are permitted and should use only the folder properties, not the item properties. La fonctionnalité de tri n’est pas disponible pour les réponses FindFolder .Sorting functionality is not available for FindFolder responses. Les requêtes regroupées ne sont pas disponibles pour les requêtes FindFolder .Grouped queries are not available for FindFolder queries.

Note L’opération FindFolder est également utilisée pour rechercher des dossiers gérés.Note The FindFolder operation is also used to find managed folders.

En-têtes SOAPSOAP Headers

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

HeaderHeader ÉlémentElement DescriptionDescription
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.
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.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifie la version de schéma de la demande d’opération.Identifies the schema version for the operation 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.
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.

Exemple de requête FindFolderFindFolder request example

DescriptionDescription

L’exemple de requête FindFolder suivant montre comment créer une requête pour rechercher tous les dossiers situés dans une boîte de réception.The following example of a FindFolder request shows how to form a request to find all the folders located in an Inbox.

CodeCode

<?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>
    <FindFolder Traversal="Shallow" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <FolderShape>
        <t:BaseShape>Default</t:BaseShape>
      </FolderShape>
      <ParentFolderIds>
        <t:DistinguishedFolderId Id="inbox"/>
      </ParentFolderIds>
    </FindFolder>
  </soap:Body>
</soap:Envelope>

CommentairesComments

À l’aide de la valeur par défaut de l' BaseShape, la réponse renvoie le nom du dossier, l’ID du dossier, le nombre de sous-dossiers, le nombre de dossiers enfants trouvés dans le dossier et le nombre d’éléments non lus.Using the Default value for the BaseShape, the response returns the folder name, the folder ID, the number of subfolders, the number of child folders found in the folder, and the count of unread items.

Demander des élémentsRequest elements

Cette requête FindFolder inclut les éléments suivants :This FindFolder request includes the following elements:

Pour d’autres éléments de requête FindFolder , voir le schéma.For additional FindFolder request elements, see the schema.

Exemple de réponse FindFolderFindFolder response example

DescriptionDescription

L’exemple de corps SOAP (Simple Object Access Protocol) suivant montre une réponse réussie à la demande FindFolder .The following Simple Object Access Protocol (SOAP) body example shows a successful response to the FindFolder request. La réponse contient les éléments qui sont renvoyés lorsque la valeur par défaut de l' BaseShape est utilisée.The response contains the elements that are returned when the Default value for the BaseShape is used.

Notes

L’ID de dossier et la clé de modification ont été raccourcies afin de préserver la lisibilité.The folder ID and the change key have been shortened to preserve readability.

CodeCode

<?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="652" MinorBuildNumber="0" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindFolderResponse 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:FindFolderResponseMessage ResponseClass="Success">
          <m:ResponseCode>NoError</m:ResponseCode>
          <m:RootFolder TotalItemsInView="1" IncludesLastItemInRange="true">
            <t:Folders>
              <t:Folder>
                <t:FolderId Id="AQAnAH" ChangeKey="AQAAABY" />
                <t:DisplayName>TestFolder</t:DisplayName>
                <t:TotalCount>0</t:TotalCount>
                <t:ChildFolderCount>0</t:ChildFolderCount>
                <t:UnreadCount>0</t:UnreadCount>
              </t:Folder>
            </t:Folders>
          </m:RootFolder>
        </m:FindFolderResponseMessage>
      </m:ResponseMessages>
    </FindFolderResponse>
  </soap:Body>
</soap:Envelope>

Éléments ResponseResponse elements

Les propriétés qui sont renvoyées dans la réponse sont déterminées par le BaseShape et le AdditionalProperties s’ils sont utilisés.The properties that are returned in the response are determined by the BaseShape and the AdditionalProperties if they are used. Une réponse FindFolder réussie inclut les éléments suivants :A successful FindFolder response includes the following elements:

CommentairesComments

FindFolder les réponses à une requête avec la forme de réponse AllProperties ne renvoient pas les éléments totalCount et UnreadCount pour les recherches de dossiers publics.FindFolder responses to a request with the AllProperties response shape will not return the TotalCount and UnreadCount elements for public folder searches.

Exemple de réponse d’erreur FindFolderFindFolder Error response example

DescriptionDescription

L’exemple de corps SOAP suivant montre une réponse d’erreur qui se produit lorsque vous recherchez un dossier identifié par un identificateur de dossier incorrect.The following SOAP body example shows an error response that occurs when you search for a folder that is identified by a malformed folder identifier.

CodeCode

<?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="652" MinorBuildNumber="0" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindFolderResponse 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:FindFolderResponseMessage ResponseClass="Error">
          <m:MessageText>Id is malformed.</m:MessageText>
          <m:ResponseCode>ErrorInvalidIdMalformed</m:ResponseCode>
          <m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
        </m:FindFolderResponseMessage>
      </m:ResponseMessages>
    </FindFolderResponse>
  </soap:Body>
</soap:Envelope>

Éléments de réponse d’erreurError response elements

La réponse d’erreur FindFolder comprend les éléments suivants :The FindFolder error response includes the following elements:

Informations complémentairesAdditional Information

  • L’élément Folder DisplayName (String) est toujours inclus dans la forme par défaut.The folder DisplayName (string) element is always included in the default shape.

  • L’élément UnreadCount est inclus dans les dossiers tâches et notes.The UnreadCount element is included in Tasks and Notes folders.

  • Utilisez la valeur PropertyTag de 0x672D avec une propriété de type Integer pour identifier un dossier géré à l’aide de l’élément ExtendedFieldURI .Use the PropertyTag value of 0x672D with a property type of Integer to identify a managed folder by using the ExtendedFieldURI element.

Voir aussiSee also

Recherche de dossiersFinding Folders