getFolderContentEx

This method is used to retrieve a set number of items from a folder. The method is an extension of getFolderContent and was implemented to help large volume users who wish to break up their response sizes into more manageable chunks.

Request Parameters

Parameter Type Requirement Description
username xsd:string mandatory – cannot be null or empty The username of the registered user who sent the package
password xsd:string mandatory – cannot be null or empty The password of the registered user who sent the package
encodedPassword xsd:boolean optional – can be null (indicates false) Indicates whether the password parameter is MD5 encoded
folderType xsd:int mandatory – cannot be null or empty An integer representing the required folder type. The possible values are:
  • 0 – inbox
  • 1 – sent items
  • 2 – archived items
  • 3 – deleted items
startPosition xsd:int mandatory – cannot be null or empty An integer representing the starting position within the folder
count xsd:int mandatory – cannot be null or empty An integer representing the maximum number of items to return
bOldestFirst xsd:boolean optional – can be null (indicates false) Indicates whether the starting position means oldest item.
  • False will return newest
  • True will return oldest

Response

  • Type: xsd:string
    Possible return values: An xml string – will take the form of
    <Folder>
 <Package>
 <PackageDetail>
 <Id></Id>
 <Sender></Sender>
 <Recipient></Recipient>
 <Subject></Subject>
 <metadatafield></metadatafield>
 …
 …
 <metadatafield></metadatafield>

 <NumberOfAttachments></NumberOfAttachments>
 <Attachments>
		<Attachment>
 <Name></Name>
 <Number></Number>
 </Attachment>
 </Attachments>

 <TrackingNumber></TrackingNumber> 
 <PackageDetail>
 </Package>
</Folder>

    The contents of the <Id> element will take the form digits-R if the package is a received package or digits-S if the package is a sent package.

    The metadatafield items will be all those defined within your skin but with whitespace removed, for example:
    <accountname></accountname>
<transactionid></transactionid>
<paperout></paperout>

    The <subject></subject> entry may not always exist as this can be suppressed by skin settings

  • “ERROR” - an error occurred. This will be followed by a description of the error (e.g. ERROR : Invalid folderType)
WKFS