getFolderListRequest

Returns the list of folders.

Request

<getFolderListRequest>
   <parent type="types:uid"/>
   <view type="string"/>
   <recurse type="boolean"/>
   <imap type="boolean"/>
   <nntp type="boolean"/>
</getFolderListRequest>

Response

<getFolderListResponse>
   <folders type="types:FolderList/>
   <status type="types:Status/>
</getFolderListResponse>

Elements

parent

Specifies the ID of the folder from which to get the list of folders. If the value of the parent property is the string folders, the root folder is searched.

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.

recurse

Specifies whether subfolders beneath the parent folder are returned.

imap

Specifies if IMAP folders are returned.

nntp

Specifies if NNTP folders are returned.

folders

Returns the list of folders.

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

<getFolderListRequest> 
   <parent>folders</parent> 
   <view/> 
   <recurse>true</recurse> 
   <imap>false</imap> 
   <nntp>false</nntp> 
</getFolderListRequest>

<getFolderListResponse> 
   <folders> 
      <folder type="SystemFolder">
         <id>6.domain1.po1.100.0.1.0.1@15</id> 
         <name>u1</name> 
         <modified>2005-06-29T23:28:26Z</modified> 
         <count>1</count> 
         <hasUnread>1</hasUnread> 
         <unreadCount>1</unreadCount> 
         <sequence>0</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Root</folderType> 
      </folder>
      <folder type="SystemFolder">
         <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>2</count> 
         <sequence>5</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Mailbox</folderType> 
         <acl> 
            <entry> 
               <displayName>u2</displayName> 
               <email>u2.po1.domain1</email> 
               <uuid>42F9A600-175B-0000-890F-6E00D5004E00</uuid> 
               <rights> 
                  <read>1</read> 
                  <add>1</add> 
                  <edit>1</edit> 
                  <delete>1</delete> 
               </rights> 
            </entry> 
         </acl> 
         <isSharedByMe>1</isSharedByMe> 
      </folder> 
      <folder type="SystemFolder">
         <id>19.domain1.po1.100.0.1.0.1@30</id> 
         <name>Sent Items</name> 
         <modified>2012-09-05T20:43:47Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <sequence>6</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>SentItems</folderType> 
      </folder> 
      <folder type="SystemFolder">
         <id>A.domain1.po1.100.0.1.0.1@19</id> 
         <name>Calendar</name> 
         <modified>2012-09-06T23:08:05Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <count>7</count> 
         <sequence>7</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Calendar</folderType> 
         <acl> 
            <entry> 
               <displayName>u2</displayName> 
               <email>u2.po1.domain1</email> 
               <uuid>42F9A600-175B-0000-890F-6E00D5004E00</uuid> 
               <rights>
                  <read>1</read> 
                  <add>1</add> 
               </rights> 
            </entry> 
         </acl> 
         <isSharedByMe>1</isSharedByMe> 
      </folder> 
      <folder type="SharedFolder"> 
         <id>44FF0075.domain1.po1.100.16E3837.1.FB4.1@35</id> 
         <name>u1 Personal Calendar</name> 
         <modified>2012-09-06T23:10:37Z</modified> 
         <parent>A.domain1.po1.100.0.1.0.1@19</parent> 
         <count>1</count> 
         <sequence>0</sequence> 
         <calendarAttribute> 
            <flags>ShowInList</flags> 
         </calendarAttribute> 
         <acl> 
            <entry> 
               <displayName>u2</displayName> 
               <email>u2.po1.domain1@phantom.com</email> 
               <uuid>42F9A600-175B-0000-890F-6E00D5004E00</uuid> 
               <rights> 
                  <read>1</read> 
                  <add>1</add> 
                  <edit>1</edit> 
                  <delete>1</delete> 
               </rights> 
               <status>accepted</status> 
            </entry> 
         </acl> 
         <isSharedByMe>1</isSharedByMe> 
      </folder> 
      <folder type="ContactFolder"> 
         <id>1B.domain1.po1.100.0.1.0.1@32</id> 
         <name>Contacts</name> 
         <modified>2012-08-25T17:38:39Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <sequence>8</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Contacts</folderType> 
         <addressBook>42C510EA.domain1.po1.104.16E3837.1.1.1@53
              </addressBook> 
      </folder>
      <folder type="SystemFolder"> 
         <id>10.domain1.po1.100.0.1.0.1@23</id> 
         <name>Documents</name> 
         <modified>2012-08-25T17:38:39Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <sequence>9</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Documents</folderType> 
      </folder> 
      <folder type="QueryFolder"> 
         <id>11.domain1.po1.100.0.1.0.1@14</id> 
         <name>Authored</name> 
         <modified>2005-06-29T23:28:15Z</modified> 
         <parent>10.domain1.po1.100.0.1.0.1@23</parent> 
         <sequence>0</sequence> 
         <folderType>Query</folderType> 
      </folder>
      <folder type="SystemFolder">
         <id>1A.domain1.po1.100.0.1.0.1@31</id> 
         <name>Checklist</name> 
         <modified>2012-08-25T17:38:39Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <sequence>10</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Checklist</folderType> 
      </folder>
      <folder type="SystemFolder">
         <id>D.domain1.po1.100.0.1.0.1@22</id> 
         <name>Work In Progress</name> 
         <modified>2012-08-25T17:38:39Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <sequence>11</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Draft</folderType> 
      </folder> 
      <folder type="SystemFolder">
         <id>C.domain1.po1.100.0.1.0.1@21</id> 
         <name>Cabinet</name> 
         <modified>2012-08-25T17:38:39Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <count>3</count> 
         <hasUnread>1</hasUnread> 
         <unreadCount>3</unreadCount> 
         <sequence>12</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Cabinet</folderType> 
      </folder> 
      <folder type="SystemFolder">
         <id>1C.domain1.po1.100.0.1.0.1@33</id> 
         <name>Junk Mail</name> 
         <modified>2012-08-25T17:38:39Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <sequence>13</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>JunkMail</folderType> 
      </folder> 
      <folder type="SystemFolder">
         <id>9.domain1.po1.100.0.1.0.1@18</id> 
         <name>Trash</name> 
         <modified>2012-08-25T17:38:39Z</modified> 
         <parent>6.domain1.po1.100.0.1.0.1@15</parent> 
         <count>20</count> 
         <hasUnread>1</hasUnread> 
         <unreadCount>21</unreadCount> 
         <sequence>14</sequence> 
         <isSystemFolder>1</isSystemFolder> 
         <folderType>Trash</folderType> 
      </folder> 
   </folders> 
   <status> 
      <code>0</code> 
   </status> 
</getFolderListResponse>