getFolderRequest

Returns the specified folder. The folder can be specified by passing in the folder ID that was returned from getFolderListRequest or by passing the folder type.

Request

<getFolderRequest>
   <id type="types:uid"/>
   <folderType type="types:FolderType"/>
   <types type="string"/>
   <source type="string"/>
   <view type="string"/>
</getFolderRequest>

Response

<getFolderResponse>
   <folder type="types:Folder">
   <status type="types:Status">
</getFolderResponse>

Elements

id

Specifies the ID of the folder.

folderType

Specifies an alternative way to specify the folder. The Junk Mail folder cannot be selected by folderType. It must be selected with the folder ID.

types

Specifies the type of items to return. The types element is used to narrow the count or unreadCount on a folder. For example, if you want the count or unreadCount for appointments and tasks, types should equal “appointments tasks.”

source

Specifies the source of items to return. The source element is used to narrow the count or unreadCount on a folder. For example, if you want the count or unreadCount for received and draft items, source should equal “received draft.”

view

Specifies the elements returned for each item. The view reduces the amount of data returned. If a view is not specified, all item elements are returned. Valid views are as follows:

count	Retrieves the count of items in a folder. The count is available only on mailbox, personal, and draft folders. Hidden items in a folder are not part of the count.
unreadCount	Retrieves the count of unread items in a folder.
default	Retrieves other folder fields.

folder

Specifies the selected folder details.

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

<getFolderRequest>
   <folderType>Mailbox</folderType> 
   <view>default count unreadCount</view> 
</getFolderRequest>

<getFolderResponse>
   <folder>
     <id>7.domain1.po1.100.0.1.0.1@16</id> 
      <name>Mailbox</name> 
      <modified>2012-08-25T17:38:39Z</modified> 
      <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
      <count>5</count> 
      <hasUnread>1</hasUnread> 
      <unreadCount>3</unreadCount> 
      <sequence>5</sequence> 
      <isSystemFolder>1</isSystemFolder> 
      <folderType>Mailbox</folderType> 
   </folder>
   <status>
      <code>0</code> 
   </status>
</getFolderResponse>