Get a folder by mail ID

GET /api/2.0/mail/userfolders/bymail

Request

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

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json.
Content-Typeenum of string: Can be one of: application/json.

Body

mailIdinteger: Mail ID

Examples

GET /api/2.0/mail/userfolders/bymail HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/mail/userfolders/bymail \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

User folder

Idintegerformat: uint32
ParentIdintegerformat: uint32
Namestring
UnreadCountintegerformat: int32
TotalCountintegerformat: int32
UnreadChainCountintegerformat: int32
TotalChainCountintegerformat: int32
FolderCountintegerformat: int32

401

Unauthorized

Get Help

If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).