archiveRequest

Archives item(s) to an archive database. The archive path needs to be a path that the POA has access to (or can reach).

Request

<archiveRequest>
  <items/>
  <path/>
</archiveRequest>

Response

<archiveResponse>
  <path/>
  <status/>
</archiveResponse>

Elements

items

Specifies the items to archive.

path

On input, specifies the path to use to create the archive directory. If a path is not specified, the POA oftemp directory is used.

On output, returns the path to the archive directory is used.

code

Returns the error number related to the request. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

Example

<archiveRequest>
  <items>
    <item>4D37DDE2.domain.PO3.100.16A7363.1.23E.1@1:
                 7.domain.PO3.100.0.1.0.1@16</item>
  </items>
  <path>/shr/archive</path>
 </archiveRequest>

<archiveResponse>
  <path>/shr/archive/ofrawarc</path>
  <status>
    <code>0</code>
  </status>
</archiveResponse>

<getArchiveItemsRequest>
  <container>folders</container>
  <count>0</count>
  <path>/shr/archive/</path>
</getArchiveItemsRequest>

<getArchiveItemsResponse>
  <items>
    <item type="Mail">
      <id>4D37DE41.domain.PO3.100.16A7363.1.17.1@1:7.domain.PO3.100.0.1.0.1@16</id>
      <sid>23</sid>
      <version>3</version>
      <modified>2011-01-20T14:03:29Z</modified>
      <container>7.domain.PO3.100.0.1.0.1@16</container>
      <created>2011-01-20T14:01:54Z</created>
      <status>
        <opened>1</opened>
        <read>1</read>
      </status>
      <msgId>4D37DE41.domain.PO3.200.2000000.1.3.1</msgId>
      <clientMessageId>4D384052.CD9 : 4 : 31797</clientMessageId>
      <source>received</source>
      <delivered>2011-01-20T14:01:54Z</delivered>
      <security>Normal</security>
      <subject>to archive</subject>
      <distribution>
        <from>
          <displayName>Layne Izatt</displayName>
          <email>lizatt@prestons.provo.novell.com</email>
          <uuid>FBC97000-100A-0000-90B7-0659E3122263</uuid>
        </from>
        <to>Layne Izatt</to>
        <sendoptions>
          <statusTracking>None</statusTracking>
        </sendoptions>
      </distribution>
      <options>
        <priority>Standard</priority>
      </options>
      <size>936</size>
      <threading>
<id>4D37DDE2.domain.PO3.200.2000004.1.5D.1:
      4D37DE41.domain.PO3.200.2000000.1.3.1</id>
        <parent>4D37DDE2.domain.PO3.200.2000004.1.5D.1</parent>
      </threading>
      <retentionModified>2011-01-20T14:03:29Z</retentionModified>
    </item>
  </items>
  <status>
    <code>0</code>
  </status>
</getArchiveItemsResponse>

<unarchiveRequest>
  <items>
    <item>4D37DE41.domain.PO3.100.16A7363.1.17.1@1:
                 7.domain.PO3.100.0.1.0.1@16</item>
  <items>
  <path>/shr/archive</path>
</unarchiveRequest>

<unarchiveResponse>
  <path>/shr/archive/ofrawarc</path>
  <status>
    <code>0</code>
  </status>
</unarchiveResponse>