GET api/2.0/mail/userfolders
Returns a list of user folders with the IDs specified in the request.
Name |
Description |
Type |
Example |
ids
sent in url
|
List of folder IDs
optional
|
System.Collections.Generic.List{System.UInt32}
|
|
parentId
sent in url
|
Parent folder ID (root level is equal to 0)
optional
|
number
|
1234
|
GET api/2.0/mail/userfolders?ids=%5b%0d%0a++1234%0d%0a%5d&parentId=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
application/json
{
"status": 0,
"response": [
{
"id": 1234,
"parent": 1234,
"name": "name",
"unread_count": 123,
"total_count": 123,
"unread_chain_count": 123,
"total_chain_count": 123,
"folder_count": 123
}
]
}
text/xml
<result>
<status>0</status>
<response>
<id>1234</id>
<parent>1234</parent>
<name>name</name>
<unread_count>123</unread_count>
<total_count>123</total_count>
<unread_chain_count>123</unread_chain_count>
<total_chain_count>123</total_chain_count>
<folder_count>123</folder_count>
</response>
</result>