Get Started
API backend
API system
More information

GET api/2.0/mail/userfolders/bymail This function requires authentication

Description

Returns a user folder by the mail ID specified in the request.

Parameters
Name Description Type Example
mailId
sent in url
Mail ID number 1234
Example
GET api/2.0/mail/userfolders/bymail?mailId=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

User folder

Example Response

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>