APIドキュメント

アドレス発行 — 一時メールアドレスを生成します。ttl=0で常設（無期限）アドレスを作成できます。

パラメータ

レスポンス

{
  "data": {
    "id": 1,
    "address": "ax7k2m@acme.mailbrew.dev",
    "webhook_url": null,
    "expires_at": "2026-03-29T13:00:00+00:00",
    "is_permanent": false,
    "created_at": "2026-03-29T12:00:00+00:00"
  }
}

アドレス一覧 — このAPIキーと、同じ会社の受信で自動で作られたアドレスを返します。自動で作られたアドレスは、同じ会社のどのAPIキーからも読めます。

レスポンス

{
  "data": [
    {
      "id": 1,
      "address": "ax7k2m@acme.mailbrew.dev",
      "webhook_url": null,
      "expires_at": "2026-03-29T13:00:00+00:00",
      "is_permanent": false,
      "created_at": "2026-03-29T12:00:00+00:00"
    }
  ]
}

アドレス詳細 — アドレスの詳細を取得します。

レスポンス

{
  "data": {
    "id": 1,
    "address": "ax7k2m@acme.mailbrew.dev",
    "webhook_url": null,
    "expires_at": "2026-03-29T13:00:00+00:00",
    "is_permanent": false,
    "created_at": "2026-03-29T12:00:00+00:00"
  }
}

メール一覧 — 指定アドレスに届いたメールの一覧を取得します。受信メールは保存期間（全プラン 7 日。組織のセキュリティ設定で短くできます）を過ぎると削除されます。

レスポンス

{
  "data": [
    {
      "id": 1,
      "from_address": "noreply@example.com",
      "subject": "Your verification code",
      "text_body": "Your code is: 847291",
      "received_at": "2026-03-29T12:05:00+00:00"
    }
  ]
}

メール詳細 — 特定のメールの詳細を取得します。

レスポンス

{
  "data": {
    "id": 1,
    "from_address": "noreply@example.com",
    "subject": "Your verification code",
    "text_body": "Your code is: 847291",
    "html_body": "<p>Your code is: <b>847291</b></p>",
    "received_at": "2026-03-29T12:05:00+00:00"
  }
}

OTP抽出 — メール本文から認証コード（OTP）を自動抽出します。E2Eテストに最適。

パラメータ

レスポンス

{
  "data": {
    "code": "847291",
    "email_id": 1,
    "source": "text_body"
  }
}

リンク抽出 — メール本文からリンク（URL）を自動抽出します。招待リンクやパスワードリセットリンクの取得に最適。

パラメータ

レスポンス

{
  "data": {
    "links": [
      "https://example.com/verify?token=abc123",
      "https://example.com/unsubscribe"
    ],
    "email_id": 1,
    "source": "text_body"
  }
}

メールアサーション — メールの内容を検証します。件名、送信元、宛先、本文の部分一致など、複数条件を同時にチェック。

パラメータ

レスポンス

{
  "data": {
    "passed": true,
    "email_id": 1,
    "results": [
      { "field": "subject", "passed": true, "expected": "Welcome", "actual": "Welcome" },
      { "field": "body_contains", "passed": true, "expected": "verify" }
    ]
  }
}

メール転送 — 受信メールを会社の有効かつメール確認済みメンバーのアドレスにのみ転送します。

パラメータ

レスポンス

{
  "data": {
    "forwarded": true,
    "to": "dev@example.com"
  },
  "success": true
}

アドレス削除 — アドレスを削除します。

レスポンス

204 No Content

メール受信待機 — ロングポーリングでメール受信を待機します。

パラメータ

レスポンス

{ "data": [] }

メール順序の検証 — 条件に合うメールが順序どおり届くか検証します。

パラメータ

レスポンス

{ "data": { "passed": true, "steps": [] } }

メール差分 — 2通のメールの差分を取得します。

パラメータ

レスポンス

{ "data": { "email_id": 1, "against_id": 2, "fields": {} } }

配信性の解析 — SPF・DKIM・DMARCなどの配信性を解析します。

レスポンス

{ "data": { "score": 100, "checks": [], "recommendations": [] } }

外部宛メールの一覧 — SMTP認証で送った外部宛（gmail.comなど）のメールを、封筒の宛先（RCPT TO）で引きます。BCCの宛先でも引けます。MailBrewのアドレスを to に指定しても引けません（アドレスのAPIで取得）。1通ずつの取得・OTP・リンク抽出は /api/mailbrew/emails/{id}・/otp・/links で行えます。

パラメータ

レスポンス

{
  "data": [
    {
      "id": 1,
      "from_address": "noreply@example.com",
      "subject": "Your verification code",
      "text_body": "Your code is: 847291",
      "received_at": "2026-03-29T12:05:00+00:00"
    }
  ]
}

外部宛メールの受信待機 — 外部宛のメールが届くまでロングポーリングで待機します。パラメータはアドレスの受信待機と同じです。

パラメータ

レスポンス

{ "data": [] }

Webhook一覧 — グローバルWebhookの一覧を取得します。

レスポンス

{
  "data": [
    {
      "id": 1,
      "url": "https://example.com/hook",
      "events": ["email.received"],
      "is_active": true
    }
  ]
}

Webhook登録 — グローバルWebhookを登録します。全アドレスのメール受信を通知。

パラメータ

レスポンス

{
  "data": {
    "id": 1,
    "url": "https://example.com/hook",
    "secret": "abc123...",
    "events": ["email.received"],
    "is_active": true
  }
}

Webhook更新 — WebhookのURL・イベント・有効状態を更新します。

パラメータ

レスポンス

{ "data": { "id": 1, "url": "https://example.com/hook", "events": ["email.received"], "is_active": true } }

Webhook削除 — Webhookを削除します。

レスポンス

204 No Content

const { MailBrew } = require('@mailbrew/sdk');
const client = new MailBrew('mb_your_key_here');

// E2E test: create address, wait for email, extract OTP
const { address, waitAndExtract } = await client.captureOtp({ ttl: 120 });

// ... trigger email send to `address` ...

const { code, email } = await waitAndExtract();
console.log(code); // "847291"