createCursorRequest

Creates a server-side cursor resource for retrieving large amounts of container data in small chunks and allows you to read containers (such as a mailbox folder or an address book). If a createCursorRequest is successful, destroy the server-side cursor resource by calling destroyCursorRequest. For more information please see Getting Items.

Request

<createCursorRequest>
   <container/>
   <view/>
   <filter/>
</createCursorRequest>

Response

<createCursorResponse>
   <cursor/>
   <status/>
</createCursorResponse>

Elements

container

Specifies the container's ID. If the container is empty, the cursor reads all folders in the user’s database (with the exception of the shared folders shared with the user, the query folders and the Trash folder).

view

Specifies the elements that are returned for each item. The view reduces the amount of data returned. If a view is not specified, all elements are returned.

filter

Specifies restrictions on the items to read.

cursor

Specifies the server-side cursor resource. The cursor ID can be used with other cursor methods such as positionCursorRequest, readCursorRequest, and destroyCursorRequest.

code

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

status

Returns the success or failure of the method.

Example

<createCursorRequest> 
   <container>19.domain1.po1.100.0.1.0.1@30</container> 
   <view>id messageId subject message recipients</view> 
   <filter>
      <element type="FilterEntry">
         <op>gt</op> 
         <field>created</field> 
         <value>2012-08-15T00:00:00Z</value> 
      </element>
   </filter>
</createCursorRequest>

<createCursorResponse> 
   <cursor>1195551863</cursor> 
   <status> 
      <code>0</code> 
   </status> 
</createCursorResponse>