TempMail

Документація API

Довідник TempMail API v1

Базовий URL

https://mail.taohuaxin.top

Автентифікація

Усі кінцеві точки, крім /config, потребують автентифікації.

Додайте наступний заголовок до всіх запитів:

x-api-key: tm_your_token_here

Отримайте токен у: Панель → Налаштування → Ключі API

Кінцеві точки

МетодШляхОпис
GET/api/v1/configКонфігурація сервера (публічна — автентифікація не потрібна)
GET/api/v1/meОтримати листи з усіх поштових скриньок (довгий опит)
GET/api/v1/inbox/:addressОтримати листи для однієї поштової скриньки (довгий опит)
DELETE/api/v1/inbox/:addressОчистити всі листи в поштовій скриньці
GET/api/v1/email/:idОтримати повний розібраний лист (текст + html + вкладення)
GET/api/v1/email/:id/renderedОтримати відрендерений текст листа
GET/api/v1/email/:id/attachments/:attachmentIdЗавантажити одне вкладення за ID
DELETE/api/v1/email/:idВидалити один лист
GET/api/v1/domainsПерелік ваших користувацьких доменів
POST/api/v1/domainsДодати користувацький домен
DELETE/api/v1/domains/:idВидалити користувацький домен

docs.examples

GET/api/v1/config

Конфігурація сервера (публічна — автентифікація не потрібна)

curl https://mail.taohuaxin.top/api/v1/config

docs.response

{
  "domains": ["taohuaxin.top"],
  "smtpPort": 25,
  "smtpsPort": 465,
  "mxPort": 25,
  "version": "1.0.0"
}
GET/api/v1/me

Отримати листи з усіх поштових скриньок (довгий опит)

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/me?count=1&limit=20"

docs.response

{
  "emails": [
    {
      "id": "cmcg2a1b40001xyz",
      "fromAddress": "[email protected]",
      "subject": "Your verification code",
      "isRead": false,
      "receivedAt": "2026-07-10T08:30:00.000Z",
      "mailbox": { "address": "alice", "domain": "taohuaxin.top" }
    }
  ],
  "nextSince": "cmcg2a1b40001xyz"
}
GET/api/v1/inbox/:address

Отримати листи для однієї поштової скриньки (довгий опит)

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/inbox/[email protected]?since=cmcg2a1b40001xyz&count=1"

docs.response

{
  "emails": [
    {
      "id": "cmcg9f2c80002abc",
      "fromAddress": "[email protected]",
      "subject": "Welcome!",
      "isRead": false,
      "receivedAt": "2026-07-10T09:00:00.000Z"
    }
  ],
  "nextSince": "cmcg9f2c80002abc"
}
DELETE/api/v1/inbox/:address

Очистити всі листи в поштовій скриньці

curl -X DELETE -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/inbox/[email protected]"

docs.response

{ "success": true }
GET/api/v1/email/:id

Отримати повний розібраний лист (текст + html + вкладення)

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz"

docs.response

{
  "id": "cmcg2a1b40001xyz",
  "fromAddress": "[email protected]",
  "toAddress": "[email protected]",
  "subject": "Your verification code",
  "bodyHtml": "<p>Your code is <b>123456</b></p>",
  "bodyText": "Your code is 123456",
  "isRead": true,
  "receivedAt": "2026-07-10T08:30:00.000Z",
  "attachments": [
    { "id": "att_01", "filename": "invoice.pdf", "mimeType": "application/pdf", "size": 24580 }
  ]
}
GET/api/v1/email/:id/rendered

Отримати відрендерений текст листа

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz/rendered"

docs.response

From: [email protected]
To: [email protected]
Subject: Your verification code
Date: Fri, 10 Jul 2026 08:30:00 GMT

<p>Your code is <b>123456</b></p>
GET/api/v1/email/:id/attachments/:attachmentId

Завантажити одне вкладення за ID

curl -OJ -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz/attachments/att_01"

docs.response

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="invoice.pdf"
Content-Length: 24580

<binary file stream>
DELETE/api/v1/email/:id

Видалити один лист

curl -X DELETE -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/email/cmcg2a1b40001xyz"

docs.response

{ "success": true }
GET/api/v1/domains

Перелік ваших користувацьких доменів

curl -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/domains"

docs.response

[
  {
    "id": "dom_01",
    "domain": "mail.example.com",
    "verified": true,
    "receiveMode": "inherit",
    "createdAt": "2026-07-01T00:00:00.000Z"
  }
]
POST/api/v1/domains

Додати користувацький домен

curl -X POST -H "x-api-key: tm_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{"domain":"mail.example.com","receiveMode":"inherit"}' \
  "https://mail.taohuaxin.top/api/v1/domains"

docs.response

{
  "id": "dom_02",
  "domain": "mail.example.com",
  "verified": false,
  "receiveMode": "inherit",
  "createdAt": "2026-07-10T10:00:00.000Z"
}
DELETE/api/v1/domains/:id

Видалити користувацький домен

curl -X DELETE -H "x-api-key: tm_your_token_here" \
  "https://mail.taohuaxin.top/api/v1/domains/dom_02"

docs.response

{ "success": true }

Довгий опит

Кінцеві точки поштових скриньок підтримують довгий опит. Викличте один раз, і сервер чекатиме надходження листа (до 25 с). Повертає 204, якщо лист не надійшов до тайм-ауту.

Параметри запиту

ПараметрОпис
sinceКурсор із попередньої відповіді; повертаються лише листи після цього моменту
countПовернути після надходження N нових листів (за замовчуванням 1, макс. 50)
limitМаксимум листів у тілі відповіді (за замовчуванням 20, макс. 50)
fromФільтр — повертати лише листи, у яких Від містить цей підрядок
subjectФільтр — повертати лише листи, у яких Тема містить цей підрядок

Поведінка видалення

Усі операції DELETE є м'яким видаленням: видалені елементи приховані від користувачів, але залишаються доступними для адміністраторів з метою аудиту.