アーカイブアイテムの操作ArchiveItem operation

アーカイブアイテムEWS 操作に関する情報を検索します。Find information about the ArchiveItem EWS operation.

アーカイブアイテムの操作によって、アイテムがメールボックスユーザーのアーカイブメールボックスに移動されます。The ArchiveItem operation moves an item into the mailbox user's archive mailbox.

この操作は Exchange Server 2013 で導入されました。This operation was introduced in Exchange Server 2013.

アーカイブアイテム操作の使用Using the ArchiveItem operation

アーカイブアイテム操作は、アーカイブメールボックスに移動するアイテムとそれらのアイテムの宛先フォルダーに移動するアイテムを識別する2つの引数を要求で受け取ります。The ArchiveItem operation takes two arguments in the request that identify the items to move to the archive mailbox and the destination folder for those items. この操作を動作させるには、アーカイブメールボックスを有効にする必要があります。An archive mailbox must be enabled in order for this operation to work. アーカイブメールボックスを有効にする方法については、「インプレースアーカイブを管理する」を参照してください。For information about how to enable an archive mailbox, see Manage In-Place Archives.

アーカイブアイテム操作 SOAP ヘッダーArchiveItem operation SOAP headers

アーカイブアイテム操作では、次の表に示す SOAP ヘッダーを使用できます。The ArchiveItem operation can use the SOAP headers that are listed in the following table.

ヘッダー名Header name 要素Element 説明Description
偽装Impersonation
ExchangeImpersonationExchangeImpersonation
クライアントアプリケーションが偽装しているユーザーを識別します。Identifies the user whom the client application is impersonating. このヘッダーは、要求に適用されます。This header is applicable to a request.
MailboxCultureMailboxCulture
MailboxCultureMailboxCulture
RFC 3066 で定義されているように、メールボックスへのアクセスに使用される言語の識別用のタグを識別します。Identifies the culture, as defined in RFC 3066, Tags for the Identification of Languages, to be used to access the mailbox. このヘッダーは、要求に適用されます。This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
操作要求のスキーマバージョンを識別します。Identifies the schema version for the operation request. このヘッダーは、要求に適用されます。This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
要求に応答したサーバーのバージョンを識別します。Identifies the version of the server that responded to the request. このヘッダーは応答に適用されます。This header is applicable to a response.

アーカイブアイテム操作の要求例: アイテムをアーカイブ受信トレイフォルダーに移動します。ArchiveItem operation request example: Move an item to the archive inbox folder

次のアーカイブアイテム操作要求の例は、アイテムをアーカイブ受信トレイフォルダーに移動する方法を示しています。The following example of an ArchiveItem operation request shows how to move an item to the archive Inbox folder.

注意

この記事のすべてのアイテム識別子と変更キーは、読みやすくするために短縮されています。All item identifiers and change keys in this article have been shortened to preserve readability.

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
   <soap:Header>
      <t:RequestServerVersion Version="Exchange2013"/>
   </soap:Header>
   <soap:Body>
      <m:ArchiveItem>
         <m:ArchiveSourceFolderId>
            <t:DistinguishedFolderId Id="inbox"/>
         </m:ArchiveSourceFolderId>
         <m:ItemIds>
            <t:ItemId Id="AQMkG5BBwrQAAAxoAAAA=" ChangeKey="CQAAAHCtAAAAAAB7"/>
         </m:ItemIds>
      </m:ArchiveItem>
   </soap:Body>
</soap:Envelope>

要求 SOAP 本文には、次の要素が含まれています。The request SOAP body contains the following elements:

アーカイブアイテム操作の応答が正常に行われるSuccessful ArchiveItem operation response

次の例は、アーカイブメールボックスにアイテムを移動するための、アーカイブアイテム操作要求に対する正常な応答を示しています。The following example shows a successful response to an ArchiveItem operation request to move an item to an archive mailbox.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:ServerVersionInfo MajorVersion="15" 
                           MinorVersion="0" 
                           MajorBuildNumber="526" 
                           MinorBuildNumber="0" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <m:ArchiveItemResponse xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages" 
                             xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
         <m:ResponseMessages>
            <m:ArchiveItemResponseMessage ResponseClass="Success">
               <m:ResponseCode>NoError</m:ResponseCode>
               <m:Items/>
            </m:ArchiveItemResponseMessage>
         </m:ResponseMessages>
      </m:ArchiveItemResponse>
   </s:Body>
</s:Envelope>

応答 SOAP 本文には、次の要素が含まれています。The response SOAP body contains the following elements:

アーカイブアイテムの操作エラー応答ArchiveItem operation error response

次の例は、アーカイブアイテム操作要求へのエラー応答を示しています。The following example shows an error response to an ArchiveItem operation request. これは、アーカイブメールボックスがユーザーに対して有効になっていない場合にアイテムをアーカイブするための有効な要求に対する応答です。This is a response to a valid request to archive an item when an archive mailbox is not enabled for a user.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:ServerVersionInfo MajorVersion="15" 
                           MinorVersion="0" 
                           MajorBuildNumber="556" 
                           MinorBuildNumber="8" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <m:ArchiveItemResponse xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages" 
                             xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
         <m:ResponseMessages>
            <m:ArchiveItemResponseMessage ResponseClass="Error">
               <m:MessageText>Archive mailbox is not enabled for this user.</m:MessageText>
               <m:ResponseCode>ErrorInvalidOperation</m:ResponseCode>
               <m:DescriptiveLinkKey>0</m:DescriptiveLinkKey>
               <m:Items/>
            </m:ArchiveItemResponseMessage>
         </m:ResponseMessages>
      </m:ArchiveItemResponse>
   </s:Body>
</s:Envelope>

エラー応答 SOAP 本文には、次の要素が含まれています。The error response SOAP body contains the following elements:

EWS で汎用的でこの操作に固有の追加のエラーコードについては、「応答」を参照してください。For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.

関連項目See also