SyncFolderItems 操作

[アーティクル]
08/13/2024

SyncFolderItems 操作は、Exchange サーバーとクライアントの間でアイテムを同期します。

注:

SyncFolderItems 操作は、Office 365 グループメールボックスまたはパブリックフォルダーに対して使用するためにサポートされていません。

注釈

SyncFolderItems 操作では、最大 512 個の変更が返されます。追加の変更を取得するには、後続の SyncFolderItems 要求を実行する必要があります。

SyncFolderItems は、Body や Attachments などのプロパティを返すことができないという点で、FindItem 操作に似ています。 SyncFolderItems 操作で必要なプロパティが返されない場合は、 GetItem 操作を使用して、SyncFolderItems によって返された各項目の特定のプロパティセットを取得できます。

SyncFolderItems 要求の例

説明

SyncFolderItems 要求の次の例は、フォルダー内の項目を同期する方法を示しています。この例では、送信済みアイテムフォルダーに対して発生した最初の同期ではないフォルダーアイテムの同期を示します。 SyncState 要素は、クライアントを Exchange サーバーと同期する最初の試行の要求には含まれません。フォルダー階層内のアイテムを同期する最初の試行では、 Ignore 要素で識別されるアイテムを除き、メールボックス内のすべてのアイテムが返されます。この SyncFolderItems 要求は、最後の同期以降にフォルダー項目に対するすべての変更を同期しようとします。この要求は、Ignore 要素で識別される 1 つの項目の同期試行を無視します。

コード

<?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>
    <SyncFolderItems xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
      <ItemShape>
        <t:BaseShape>Default</t:BaseShape>
      </ItemShape>
      <SyncFolderId>
        <t:DistinguishedFolderId Id="sentitems"/>
      </SyncFolderId>
      <SyncState>AEbJ94eMOAAA=</SyncState>
      <Ignore>
        <t:ItemId Id="AQApAHRAA==" ChangeKey="CQAAABY"/>
      </Ignore>
      <MaxChangesReturned>100</MaxChangesReturned>
    </SyncFolderItems>
  </soap:Body>
</soap:Envelope>

注釈

読みやすさを維持するために、 SyncState 要素 base64 でエンコードされたデータと ItemId 要素 Id 属性が短縮されました。

要求要素

要求では、次の要素が使用されます。

SyncFolderItems 応答の成功

説明

次の例は、SyncFolderItems 要求に対する正常な応答を示しています。この例では、会議出席依頼が [送信済みアイテム] フォルダーから同期されます。

コード

<?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="628" MinorBuildNumber="0" 
      xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <SyncFolderItemsResponse 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:SyncFolderItemsResponseMessage ResponseClass="Success">
          <m:ResponseCode>NoError</m:ResponseCode>
          <m:SyncState>H4sIAAAAA=</m:SyncState>
          <m:IncludesLastItemInRange>true</m:IncludesLastItemInRange>
          <m:Changes>
            <t:Create>
              <t:MeetingRequest>
                <t:ItemId Id="AQApAHRwA==" ChangeKey="CwAAABYA" />
                <t:Subject>Budget Q3</t:Subject>
                <t:Sensitivity>Normal</t:Sensitivity>
                <t:IsOutOfDate>false</t:IsOutOfDate>
                <t:HasBeenProcessed>true</t:HasBeenProcessed>
                <t:ResponseType>NoResponseReceived</t:ResponseType>
                <t:IntendedFreeBusyStatus>Busy</t:IntendedFreeBusyStatus>
                <t:Start>2006-08-02T17:30:00Z</t:Start>
                <t:End>2006-08-02T19:30:00Z</t:End>
                <t:Location>Conference Room 2</t:Location>
                <t:Organizer>
                  <t:Mailbox>
                    <t:Name>Dan Park</t:Name>
                    <t:EmailAddress>dpark@example.com</t:EmailAddress>
                    <t:RoutingType>SMTP</t:RoutingType>
                  </t:Mailbox>
                </t:Organizer>
              </t:MeetingRequest>
            </t:Create>
          </m:Changes>
        </m:SyncFolderItemsResponseMessage>
      </m:ResponseMessages>
    </SyncFolderItemsResponse>
  </soap:Body>
</soap:Envelope>

注釈

読みやすさを維持するために、 SyncState 要素 base64 でエンコードされたデータと ItemId 要素 Id 属性が短縮されました。

成功した応答要素

応答では、次の要素が使用されます。

SyncFolderItems エラー応答

説明

次の例は、SyncFolderItems 要求に対するエラー応答を示しています。このエラーは、無効な SyncState が原因で発生しました。

コード

<?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="628" MinorBuildNumber="0" 
                         xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <SyncFolderItemsResponse 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:SyncFolderItemsResponseMessage ResponseClass="Error">
          <m:MessageText>Synchronization state data is corrupt or otherwise invalid.</m:MessageText>
          <m:ResponseCode>ErrorInvalidSyncStateData</m:ResponseCode>
          <m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
          <m:SyncState />
          <m:IncludesLastItemInRange>true</m:IncludesLastItemInRange>
        </m:SyncFolderItemsResponseMessage>
      </m:ResponseMessages>
    </SyncFolderItemsResponse>
  </soap:Body>
</soap:Envelope>

エラー応答要素

エラー応答では、次の要素が使用されます。

次の方法で共有