Opération UpdateFolder

  • Article

L’opération UpdateFolder est utilisée pour modifier les propriétés d’un élément existant dans le magasin Exchange. Chaque opération UpdateFolder se compose des éléments suivants :

  • Élément FolderId qui spécifie un dossier à mettre à jour.

  • Chemin d’accès interne d’un élément dans le dossier, tel que spécifié par la forme de dossier, qui spécifie les données à mettre à jour.

  • Dossier qui contient la nouvelle valeur du champ mis à jour, si la mise à jour n’est pas une suppression.

Remarques

Trois actions de mise à jour de base peuvent être effectuées sur un élément. Ces actions sont répertoriées dans le tableau suivant.

Action Description
Ajout
 L’action d’ajout ajoute des données à une propriété existante. Il conserve les données qui se trouvent actuellement. Append ne s’applique pas à toutes les propriétés.
Set
 L’action set remplace les données d’une propriété si elle contient des données, ou crée la propriété et définit sa valeur si elle n’existe pas. L’action set s’applique uniquement aux propriétés accessibles en écriture.
Supprimer
 L’action de suppression supprime une propriété d’un dossier. Cela diffère de la définition d’une valeur vide. Lorsque vous avez terminé, la propriété n’existe pas pour le dossier. La suppression s’applique uniquement aux propriétés accessibles en écriture.

Exemple de requête UpdateFolder

Description

L’exemple suivant de requête UpdateFolder montre comment mettre à jour un nom d’affichage de dossier.

Code

<?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>
    <UpdateFolder xmlns="https://schemas.microsoft.com/exchange/services/2006/messages"
                  xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
      <FolderChanges>
        <t:FolderChange>
          <t:FolderId Id="AScA" ChangeKey="GO3u/"/>
          <t:Updates>
            <t:SetFolderField>
              <t:FieldURI FieldURI="folder:DisplayName"/>
              <t:Folder>
                <t:DisplayName>NewFolderName</t:DisplayName>
              </t:Folder>
            </t:SetFolderField>
          </t:Updates>
        </t:FolderChange>
      </FolderChanges>
    </UpdateFolder>
  </soap:Body>
</soap:Envelope>

Comments

Cet exemple montre comment modifier le nom complet du dossier en NewFolderName.

Remarque

Les valeurs des attributs Id et ChangeKey de l’élément FolderId ont été raccourcies pour plus de lisibilité.

Éléments de requête

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

Consultez le schéma pour obtenir des éléments supplémentaires que vous pouvez utiliser pour former une requête UpdateFolder.

Remarque

L’emplacement par défaut du schéma se trouve dans le répertoire virtuel EWS sur l’ordinateur sur lequel le rôle serveur d’accès au client est installé.

Exemple de réponse UpdateFolder

Description

L’exemple suivant montre une réponse réussie à la requête UpdateFolder. Dans cet exemple, la nouvelle clé de modification est retournée pour refléter l’état mis à jour du dossier.

Code

<?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="685" MinorBuildNumber="8" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <UpdateFolderResponse 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:UpdateFolderResponseMessage ResponseClass="Success">
          <m:ResponseCode>NoError</m:ResponseCode>
          <m:Folders>
            <t:Folder>
              <t:FolderId Id="AAAlAFVz" ChangeKey="AQAAAB" />
            </t:Folder>
          </m:Folders>
        </m:UpdateFolderResponseMessage>
      </m:ResponseMessages>
    </UpdateFolderResponse>
  </soap:Body>
</soap:Envelope>

Comments

Remarque

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

L’ID de dossier retourné dans la réponse représente le dossier mis à jour.

Éléments de réponse réussis

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

Exemple de réponse d’erreur UpdateFolder

Description

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

Code

<?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="685" MinorBuildNumber="8" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <UpdateFolderResponse 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:UpdateFolderResponseMessage ResponseClass="Error">
          <m:MessageText>The change key is invalid.</m:MessageText>
          <m:ResponseCode>ErrorInvalidChangeKey</m:ResponseCode>
          <m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
          <m:Folders />
        </m:UpdateFolderResponseMessage>
      </m:ResponseMessages>
    </UpdateFolderResponse>
  </soap:Body>
</soap:Envelope>

Comments

Cet exemple montre une réponse d’erreur provoquée par un attribut ChangeKey non valide dans la requête.

Éléments de réponse d’erreur

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

Voir aussi