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で添付ファイルを1つダウンロード |
| 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/configdocs.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/:attachmentIdIDで添付ファイルを1つダウンロード
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 | フィルター — Fromにこの文字列を含むメールのみを返す |
| subject | フィルター — Subjectにこの文字列を含むメールのみを返す |
削除の挙動
すべてのDELETE操作はソフトデリートです:削除されたアイテムはユーザーには表示されませんが、管理者は監査目的で引き続きアクセスできます。