Get Message List - ELink Open API

Request

Body Params multipart/form-dataRequired

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://localhost:18321/v1/message/list' \
--form 'token="{{token}}"' \
--form 'mail_id="mail_demo_001"' \
--form 'folder_path="INBOX"' \
--form 'limit="20"' \
--form 'offset="eyJwYWdlX3Rva2VuIjoiMiJ9"' \
--form 'keyword="invoice"' \
--form 'subject="Verify Code"' \
--form 'body="verification"' \
--form 'from="[email protected]"' \
--form 'to="[email protected]"' \
--form 'flagged="0"' \
--form 'seen="0"'

Responses

🟢200

application/json

Success

Body

Example

{
    "code": 200,
    "msg": "ok",
    "data": {
        "list": [
            {
                "message_id": "uid:10001",
                "header_message_id": "<[email protected]>",
                "mail_id": "mail_demo_001",
                "folder_id": "user_demo_001_mail_demo_001_INBOX",
                "folder_type": "inbox",
                "subject": "Welcome to the product demo",
                "from": {
                    "name": "Demo Sender",
                    "address": "[email protected]"
                },
                "sender": null,
                "to": [
                    {
                        "name": "Demo User",
                        "address": "de***@example.com"
                    }
                ],
                "cc": [],
                "bcc": [],
                "date": "2026-04-10T09:30:00.000Z",
                "preview_text": "This is a masked preview for API documentation.",
                "is_read": -1,
                "is_flagged": -1,
                "is_important": -1,
                "has_attachment": -1,
                "message_detail_download_status": 1,
                "size": 0,
                "in_reply_to": "",
                "references": [],
                "receive_protocol_type": "imap",
                "remote_thread_id": "",
                "provider_meta": {
                    "uid": 10001,
                    "sequenceId": 1501,
                    "threadSequenceText": null,
                    "threadSequenceIsUid": null
                }
            }
        ],
        "has_more": 1,
        "next_offset": "eyJwYWdlX3Rva2VuIjoiMiJ9",
        "total_count": 1501
    }
}