REST API ドキュメント

GET/api/email/{domain}/{user}/

ユーザーのメールのページ分割されたリストを取得します。リスト応答にはメタデータのみが含まれます (メタデータは含まれません)。 body / html_body).

パラメータ	位置	説明
domain	パス	電子メールのドメイン、例: example.com
user	パス	ユーザー名、例: testuser
page	クエリ、オプション	ページ番号 (デフォルトは 1)
limit	クエリ、オプション	ページあたりのアイテム数 (デフォルトは 20、最大 100)

curl -X GET "https://BASE_URL/api/email/example.com/testuser/?page=1&limit=20"

{
  "emails": [
    {
      "id": 123,
      "subject": "Welcome",
      "sender": "[email protected]",
      "date": "2026-09-30T10:30:00.000Z",
      "has_attachments": false,
      "size": 1234
    }
  ],
  "total": 5,
  "page": 1,
  "limit": 20,
  "has_more": false
}

GET/api/email/{domain}/{user}/{email_id}

電子メールの完全な詳細を取得します。

curl -X GET "https://BASE_URL/api/email/example.com/testuser/123"

DELETE/api/email/{domain}/{user}/{email_id}

特定のメールを削除します。

curl -X DELETE "https://BASE_URL/api/email/example.com/testuser/123"

{ "status": "deleted" }

POST/api/add-domain/{domain}

新しいドメインを追加するか、既存のドメインのオンライン ステータスを更新します。ドメインが受け入れられるには、システムのホスト名を指す MX レコードが必要です (ステータス added, is_online: true).

curl -X POST "https://BASE_URL/api/add-domain/newdomain.com"

// 正常に追加されました
{ "status": "added", "domain": "newdomain.com", "is_online": true }

// 既存のドメイン: ステータスを更新します
{ "status": "updated", "domain": "newdomain.com", "is_online": false }

GET/api/all-domains/ & /api/random-domains/

すべてのオンライン ドメイン (プライベート、トークンが必要):

curl -X GET "https://BASE_URL/api/all-domains/" \
  -H "X-Domain-Token: YOUR_TOKEN"

ランダムなオンライン ドメイン (パブリック):

curl -X GET "https://BASE_URL/api/random-domains/?limit=10"

{ "domains": ["domain1.com", "domain2.com"], "total": 2 }

GET/api/check-mx/{domain}

ドメインにシステムを指す有効な MX レコードがあるかどうかを確認します。

curl -X GET "https://BASE_URL/api/check-mx/example.com"

{ "result": "online" }   // または "offline"

エラー処理

コード	意味
200	成功
400	無効なリクエスト (例: 不正な形式のドメイン/電子メール)
401	プライベート エンドポイントのトークンが見つからないか無効です
404	メールが見つかりません
429	レート制限を超えました

{ "detail": "Domain not found" }

重要な注意事項

• 電子メール アドレスには次の形式を使用する必要があります [email protected]
• 有効な MX レコードを持つドメインのみが「オンライン」ステータスになります
• 電子メールと非アクティブなドメインは、次の後に自動的に削除されます。 3日間
• サービスのみ 受け取ります 電子メール — 送信と SMTP リレーはサポートされていません
• API は IP ごとのレート制限を適用します
• ライブ サービスには 3 日間の保存期間が適用されます。バックアップではコピーがより長く保持される場合があります。現時点では、すべてのコピーからの完全な削除は保証されません。
• カスタム ドメインの受信トレイは公開されたままとなり、サードパーティのサービスによってブロックされる可能性があります。受領および配達は保証されません。