chobitmail
ドキュメントAPI Docslogin

はじめに

chobitmail(ちょびっとメール) は、E2E テスト向けのワンタイムメール受信 APIです。テストごとに使い捨てアドレスを発行し、届いたメールの OTP や確認リンクを JSON で受け取れます。

このページでは、サインアップから最初の受信確認までのやり方を紹介します。

1. アカウントと API キー

  1. GitHub でログインする(クレジットカード不要)
  2. ダッシュボードで API キーを発行する
  3. 表示されたキー(cbm_live_... 形式)をその場でコピーする

APIキーはチーム単位です。クォータ(同時アクティブ受信箱・日次作成数・日次受信数)もチーム単位です。

環境変数に置いておくと便利です。ただし秘匿情報なので取り扱いには注意してください。

export CHOBITMAIL_API_KEY=cbm_live_...

2. ワンタイムアドレスを作る

curl -s -X POST https://chobitmail.com/api/inboxes \
  -H "Authorization: Bearer $CHOBITMAIL_API_KEY"

レスポンス例:

{
  "id": "v56m2aq5ly17piq3",
  "address": "v56m2aq5ly17piq3@chobitmail.com",
  "createdAt": "2026-07-17T07:30:00.000Z",
  "expiresAt": "2026-07-17T07:40:00.000Z"
}
  • address : テスト対象アプリのフォームに入れるメールアドレス
  • id : 以降の API で使う受信箱 ID
  • expiresAt : この時刻を過ぎるとアドレスとメールは自動削除される

3. アプリからメールを送る

/api/inboxes で作成したワンタイムアドレスにメールを送信してください。

4. 届くまで待つ

/api/inboxes/<メールのID>/messages/wait APIでメールを受信するまで待機できます。

curl -s "https://chobitmail.com/api/inboxes/v56m2aq5ly17piq3/messages/wait" \
  -H "Authorization: Bearer $CHOBITMAIL_API_KEY"

レスポンス例:

{
  "message": {
    "id": "k2x9m4p7q1w8e5r3",
    "from": "noreply@myapp.example",
    "subject": "【MyApp】認証コードのお知らせ",
    "text": "あなたの認証コードは 482913 です。",
    "html": "<p>あなたの認証コードは <b>482913</b> です。</p>",
    "links": ["https://myapp.example/verify?token=abc123"],
    "codes": ["482913"],
    "attachments": [],
    "receivedAt": "2026-07-17T07:30:00.000Z"
  }
}

OTP 入力テストなら message.codes[0] を、リンク確認なら message.links[0] がそのまま使えます。

5. ワンタイムアドレスの削除

無料枠では同時に使える受信箱数が限られます。テスト終了後に削除すると枠をすぐ再利用できます。

curl -s -X DELETE https://chobitmail.com/api/inboxes/v56m2aq5ly17piq3 \
  -H "Authorization: Bearer $CHOBITMAIL_API_KEY"

TTL 切れでも自動削除されます。公式の Playwright fixture はテストごとに自動 DELETE します。

次のステップ

やりたいこと ドキュメント
エンドポイントの全体像・エラー・Message の形 API 利用ガイド
試せる OpenAPI UI /api/docs(英語)
Playwright で数行のテスト Playwright
無料枠を広げたい 送信元ドメイン検証