Inbox

Read and manage inbound emails received via IMAP.

Requires an IMAP account configured in the dashboard. Messages are polled automatically and made available via API. Supports read/flag toggling, folder management, and attachment downloads.

Endpoints

Method	Description	Permission
GET	List inbox messages	email.inbox_read
GET	Get inbox message	email.inbox_read
PATCH	Toggle read status	email.inbox_read
DELETE	Delete inbox message	email.inbox_reply
PATCH	Toggle flagged status	email.inbox_read
PATCH	Move to IMAP folder	email.inbox_read
GET	Download attachment	email.inbox_read

List Inbox Messages

GET /api/v1/inbox

Request

Response

{
  "success": true,
  "data": [
    {
      "id": "inbox-uuid-1",
      "from": "client@example.com",
      "subject": "Re: Invoice #2024-001",
      "snippet": "Thank you for sending the invoice. I have a question about...",
      "isRead": false,
      "isFlagged": false,
      "folder": "INBOX",
      "hasAttachments": true,
      "received_at": "2026-03-18T09:45:00Z"
    },
    {
      "id": "inbox-uuid-2",
      "from": "support@vendor.com",
      "subject": "Your subscription has been renewed",
      "snippet": "Your annual subscription has been successfully renewed...",
      "isRead": false,
      "isFlagged": false,
      "folder": "INBOX",
      "hasAttachments": false,
      "received_at": "2026-03-18T08:30:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 20, "total": 87, "total_pages": 5 }
}

json

Mark as Read

PATCH /api/v1/inbox/:id/read

Request

Response

{
  "success": true,
  "data": {
    "id": "inbox-uuid-1",
    "isRead": true
  }
}

json