APIリファレンス

メール送信

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

概要

エンドポイントhttps://api.unbox.im/v1/email
メソッドPOST
Content-Typeapplication/json
スコープカスタムドメインごとに1つのAPIキー

DNS検証完了後、アカウント → ドメイン → あなたのドメイン → APIでキーを生成してください。秘密鍵は一度だけ表示されますので、安全に保管してください。同じドメインパネルにあるオプションのSMTP認証情報も、同じトランザクションメールのみのルールに従います。

トランザクションメールのみ

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

許可される使用

  • アカウント確認、パスワードリセット、セキュリティアラート
  • 注文確認、領収書、配送通知、支払い通知
  • 特定のユーザーまたはシステムイベントによってトリガーされる通知
  • チームおよびワークスペースメッセージ(招待、割り当て、内部アラート)

禁止される使用

  • ニュースレター、プロモーションキャンペーン、一斉配信マーケティング
  • 購入、スクレイピング、または同意のないリストへのコールドアウトリーチやメール送信
  • アフィリエイトスパム、フィッシング、または欺瞞的なコンテンツ
  • 受信者上限、レート制限、またはプラン枠を回避する試み

レートと受信者制限

受信者と配信可能性を保護するため、アウトバウンドAPIおよびSMTPトラフィックには、プランの月間送信枠に加えて以下の制限が適用されます。制限はWebコンポーザー、HTTP API、SMTP送信に適用されています。Webコンポーザーでは、1メッセージあたり25人を超える受信者に対して警告が表示され、50人を超える送信はブロックされます。

制限
1メッセージあたりの受信者数最大50(To + Cc + Bccの合計)
1日あたりのユニーク受信者数ワークスペースあたり最大1,000
送信リクエストレートドメインあたり1分間最大10件のAPIまたはSMTP送信
プランのアウトバウンド枠サブスクリプションの月間送信制限が引き続き適用されます

これらのルールは、当社の利用規約の一部です。自動的な適用はWebコンポーザー、HTTP API、SMTP送信で有効です。マーケティングメールや大量メールを送信したり、送信インフラを悪用するアカウントは、制限、停止、または削除される可能性があります。

配信品質のシグナルを監視しています。持続的なバウンス率が3%を超える、または苦情率が0.1%を超える場合、一時的な送信停止または手動レビューが発生する可能性があります。

詳細については、利用規約プライバシーポリシーGDPRに関する声明をご覧ください。

認証

リクエストごとにドメインのAPIキーを送信してください:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

または、X-Api-Key: ubk_live_…を使用します。キーはハッシュ化されて保存されます。ドメインダッシュボードから失効またはローテーションできます。

リクエストボディ

フィールド名はPascalCase(FromToなど)のJSONです。camelCaseのエイリアスも受け付けられます。

フィールド必須説明
From必須送信者 — キーのドメイン上の個人メールボックス(プライマリまたはエイリアス)。共有キューは有効な送信者ではありません。
To必須受信者 — 文字列、カンマ区切りの文字列、または配列
Subject必須件名
TextBodyTextBody / HtmlBodyのいずれかプレーンテキスト本文
HtmlBodyTextBody / HtmlBodyのいずれかHTML本文
Cc任意CC受信者
Bcc任意BCC受信者
ReplyTo任意返信先アドレス
Tagいいえオプションのメタデータタグ(送信時に保存されます)

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

成功レスポンス

HTTP 200 とJSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

エラーレスポンス

エラーは 4xx(予期しない障害の場合は 500)とJSONを返します:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
エラーコード意味
0成功
10APIキーが見つかりません
11無効または失効したキー、またはドメインが送信確認されていません
300バリデーションエラー(フィールド不足、無効なJSONなど)
403送信元アドレスが許可されていません — キーのドメイン上の個人メールボックスである必要があります
406SESがメッセージを拒否しました

you@yourdomain.com をドメイン上の個人メールボックスに置き換え、ご自身のAPIキーを使用してください。

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

はじめに

  1. Unboxアカウントを作成し、カスタムドメインを追加します。
  2. 「ドメイン」ですべてのDNS確認手順を完了します。
  3. 「ドメイン」→ 対象ドメイン → 「API」を開き、ドメインキーを生成します。
  4. 上記の例を使用して最初のメッセージを送信します。
Unbox — APIドキュメント | Unbox.im