Partager via

Opération FindFolder

  • Article

L’opération FindFolder utilise les services Web Exchange pour rechercher les sous-dossiers d’un dossier identifié et retourne un ensemble de propriétés qui décrivent l’ensemble de sous-dossiers.

FindFolder 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.

Les requêtes de traversée approfondie ne peuvent pas être effectuées sur des dossiers publics.

Les restrictions sont autorisées et doivent utiliser uniquement les propriétés du dossier, et non les propriétés d’élément. La fonctionnalité de tri n’est pas disponible pour les réponses FindFolder . Les requêtes groupées ne sont pas disponibles pour les requêtes FindFolder .

[! REMARQUE} L’opération FindFolder est également utilisée pour rechercher des dossiers managés.

En-têtes SOAP

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

Header Élément Description
Emprunt d’identité ExchangeImpersonation Identifie l’utilisateur que l’application cliente emprunte l’identité.
MailboxCulture MailboxCulture Identifie la culture RFC3066 à utiliser pour accéder à la boîte aux lettres.
RequestVersion RequestServerVersion Identifie la version du schéma pour la demande d’opération.
ServerVersion ServerVersionInfo Identifie la version du serveur qui a répondu à la requête.
TimeZoneContext TimeZoneContext Identifie le fuseau horaire à utiliser pour toutes les réponses du serveur.

Exemple de requête FindFolder

L’exemple suivant de demande FindFolder montre comment former une demande pour rechercher tous les dossiers situés dans une boîte de réception.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
  <soap:Body>
    <FindFolder Traversal="Shallow" xmlns="http://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>

À l’aide de la valeur Default pour baseShape, la réponse renvoie le nom du dossier, l’ID de dossier, le nombre de sous-dossiers, le nombre de dossiers enfants trouvés dans le dossier et le nombre d’éléments non lus.

Éléments de requête FindFolder

Cette requête FindFolder comprend les éléments suivants :

Pour obtenir des éléments de requête FindFolder supplémentaires, consultez le schéma.

Exemple de réponse FindFolder

L’exemple de corps SOAP (Simple Object Access Protocol) suivant montre une réponse réussie à la requête FindFolder . La réponse contient les éléments qui sont retournés lorsque la valeur Par défaut de BaseShape est utilisée.

Remarque

L’ID de dossier et la clé de modification ont été raccourcis pour préserver la lisibilité.

<?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="http://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindFolderResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" 
                        xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" 
                        xmlns="http://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 de réponse FindFolder

Les propriétés retournées dans la réponse sont déterminées par baseShape et AdditionalProperties si elles sont utilisées. Une réponse FindFolder réussie inclut les éléments suivants :

Les réponses FindFolder à une requête avec la forme de réponse AllProperties ne retournent pas les éléments TotalCount et UnreadCount pour les recherches de dossiers publics.

Exemple de réponse d’erreur FindFolder

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 mal formé.

<?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="http://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <FindFolderResponse xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages" 
                          xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" 
                          xmlns="http://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’erreur FindFolder

La réponse d’erreur FindFolder inclut les éléments suivants :

Informations complémentaires

Voir aussi

Recherche de dossiers