Операция UpdateFolderUpdateFolder operation

Операция операцию UpdateFolder используется для изменения свойств существующего элемента в хранилище Exchange.The UpdateFolder operation is used to modify properties of an existing item in the Exchange store. Каждая операция операцию UpdateFolder состоит из следующих элементов:Each UpdateFolder operation consists of the following:

  • Элемент FolderId , указывающий папку, которую требуется обновить.A FolderId element that specifies a folder to update.

  • Внутренний путь к элементу в папке, как указано в фигуре папки, в которой задаются данные для обновления.An internal path of an element in the folder, as specified by the folder shape, which specifies the data to update.

  • Папка, содержащая новое значение обновленного поля, если обновление не является удалением.A folder that contains the new value of the updated field, if the update is not a deletion.

ПримечанияRemarks

Для элемента можно выполнить три основных действия обновления.Three basic update actions can be performed on an item. Эти действия перечислены в приведенной ниже таблице.These actions are listed in the following table.

ДействиеAction ОписаниеDescription
ErrorAppend
Действие Append добавляет данные к существующему свойству.The append action adds data to an existing property. Они сохраняют текущие данные.It preserves the data that is currently there. Append не применимо ко всем свойствам.Append is not applicable to all properties.
SetSet
Действие Set замещает данные для свойства, если оно содержит данные, или создает свойство и задает его значение, если оно не существует.The set action replaces data for a property if it contains data, or creates the property and sets its value if it does not exist. Действие Set применяется только к записываемым свойствам.The set action is only applicable to writable properties.
УдалениеDelete
Действие DELETE удаляет свойство из папки.The delete action removes a property from a folder. Это отличается от присвоения пустого значения.This is different than setting it to an empty value. По завершении свойство для папки не существует.When complete, the property does not exist for the folder. DELETE применяется только к записываемым свойствам.Delete is only applicable to writable properties.

Пример запроса операцию UpdateFolderUpdateFolder request example

DescriptionDescription

В приведенном ниже примере запроса операцию UpdateFolder показано, как обновить отображаемое имя папки.The following example of an UpdateFolder request shows how to update a folder display name.

Код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

В этом примере показано изменение отображаемого имени папки на Невфолдернаме.This example changes the display name of the folder to NewFolderName.

Примечание

Значения атрибутов ID и чанжекэй элемента FolderId сокращены для удобочитаемости.The values of the Id and ChangeKey attributes of the FolderId element have been shortened for readability.

Элементы RequestRequest elements

В запросе используются следующие элементы:The following elements are used in the request:

В схеме представлены дополнительные элементы, которые можно использовать для формирования запроса операцию UpdateFolder.See the schema for additional elements that you can use to form an UpdateFolder request.

Примечание

Расположение схемы по умолчанию находится в виртуальном каталоге EWS на компьютере, на котором установлена роль сервера клиентского доступа.The default location of the schema is in the EWS virtual directory on the computer that has the Client Access server role installed.

Пример отклика операцию UpdateFolderUpdateFolder response example

DescriptionDescription

В следующем примере показан успешный ответ на запрос операцию UpdateFolder.The following example shows a successful response to the UpdateFolder request. В этом примере возвращается новый ключ изменения, который отражает обновленное состояние папки.In this example, the new change key is returned to reflect the updated status of the folder.

Код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

Примечание

Идентификатор папки и ключ изменения были сокращены, чтобы сохранить удобочитаемость.The folder ID and the change key have been shortened to preserve readability.

Идентификатор папки, возвращаемой в ответе, представляет обновленную папку.The folder ID that is returned in the response represents the updated folder.

Элементы успешного ответаSuccessful response elements

В отклике используются следующие элементы:The following elements are used in the response:

Пример ответа на сообщение об ошибке операцию UpdateFolderUpdateFolder Error response example

DescriptionDescription

В следующем примере показан ответ об ошибке для запроса операцию UpdateFolder.The following example shows an error response to an UpdateFolder request.

Код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

В этом примере показан ответ об ошибке, вызванный недопустимым атрибутом чанжекэй в запросе.This example shows an error response that is caused by an invalid ChangeKey attribute in the request.

Элементы ошибочного ответаError response elements

В ответе на сообщение об ошибке используются следующие элементы:The following elements are used in the error response:

См. такжеSee also