TempMail

Tài liệu API

Tham khảo TempMail API v1

URL cơ sở

https://mail.taohuaxin.top

Xác thực

Tất cả các điểm cuối trừ /config đều yêu cầu xác thực.

Thêm tiêu đề sau vào tất cả các yêu cầu:

x-api-key: tm_your_token_here

Lấy token của bạn tại: Bảng điều khiển → Cài đặt → Khóa API

Điểm cuối

Phương thứcĐường dẫnMô tả
GET/api/v1/configCấu hình máy chủ (công khai — không cần xác thực)
GET/api/v1/meLấy email từ tất cả hộp thư của bạn (long-poll)
GET/api/v1/inbox/:addressLấy email cho một hộp thư (long-poll)
DELETE/api/v1/inbox/:addressXóa tất cả email trong hộp thư
GET/api/v1/email/:idLấy email đã phân tích đầy đủ (văn bản + html + tệp đính kèm)
GET/api/v1/email/:id/renderedLấy nội dung email đã kết xuất
GET/api/v1/email/:id/attachments/:attachmentIdTải xuống một tệp đính kèm theo ID
DELETE/api/v1/email/:idXóa một email
GET/api/v1/domainsLiệt kê tên miền tùy chỉnh của bạn
POST/api/v1/domainsThêm tên miền tùy chỉnh
DELETE/api/v1/domains/:idXóa tên miền tùy chỉnh

docs.examples

GET/api/v1/config

Cấu hình máy chủ (công khai — không cần xác thực)

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

Lấy email từ tất cả hộp thư của bạn (long-poll)

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

Lấy email cho một hộp thư (long-poll)

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

Xóa tất cả email trong hộp thư

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

Lấy email đã phân tích đầy đủ (văn bản + html + tệp đính kèm)

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

Lấy nội dung email đã kết xuất

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

Tải xuống một tệp đính kèm theo 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

Xóa một email

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

Liệt kê tên miền tùy chỉnh của bạn

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

Thêm tên miền tùy chỉnh

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

Xóa tên miền tùy chỉnh

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

docs.response

{ "success": true }

Long Poll

Các điểm cuối hộp thư hỗ trợ long-polling. Gọi một lần và máy chủ sẽ chờ đến khi có thư (tối đa 25 giây). Trả về 204 nếu không có thư trước khi hết thời gian chờ.

Tham số truy vấn

Tham sốMô tả
sinceCon trỏ từ phản hồi trước; chỉ trả về thư sau thời điểm này
countTrả về khi có N email mới đến (mặc định 1, tối đa 50)
limitSố email tối đa mỗi phản hồi (mặc định 20, tối đa 50)
fromLọc — chỉ trả về thư có trường Từ chứa chuỗi con này
subjectLọc — chỉ trả về thư có trường Chủ đề chứa chuỗi con này

Hành vi xóa

Tất cả các thao tác DELETE đều là xóa mềm: các mục đã xóa bị ẩn khỏi người dùng nhưng vẫn có thể được quản trị viên truy cập cho mục đích kiểm toán.