Get Message Folder List

POST

http://localhost:18321/v1/message/folder/list

Read the folder list from the remote mail server in real time. For subsequent message APIs, prefer using the returned path value as folder_path.

Request

Body Params multipart/form-dataRequired

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:18321/v1/message/folder/list' \
--form 'token="{{token}}"' \
--form 'mail_id="mail_demo_001"'

Responses

🟢200

application/json

Success

Body

Example

{
    "code": 200,
    "msg": "ok",
    "data": {
        "list": [
            {
                "folder_id": "user_demo_001_mail_demo_001_INBOX",
                "mail_id": "mail_demo_001",
                "user_id": "user_demo_001",
                "name": "INBOX",
                "path": "INBOX",
                "type": "inbox",
                "is_system": 1,
                "is_aggregate": -1,
                "unread_count": 12,
                "total_count": 200,
                "remote_folder_id": "INBOX",
                "folder_kind": "inbox"
            },
            {
                "folder_id": "user_demo_001_mail_demo_001_ttt",
                "mail_id": "mail_demo_001",
                "user_id": "user_demo_001",
                "name": "ttt",
                "path": "ttt",
                "type": "folder",
                "is_system": -1,
                "is_aggregate": -1,
                "unread_count": 0,
                "total_count": 0,
                "remote_folder_id": "ttt",
                "folder_kind": "custom"
            }
        ]
    }
}

Modified at 2026-04-10 06:29:30

Delete Proxy

Get Message List