燕メール ドキュメント
サイトの問い合わせを受け取って、メールで通知するサービスです。 送信元は問いません。ここでは繋ぎ方と、送るデータの形を説明します。
仕組み
受信口を1つ作り、そこに問い合わせを送ります。届いた内容は 登録した宛先にメールで通知され、問い合わせた本人には自動返信を返せます。 受け取ったあとの処理(値の取り出し・通知・自動返信・受信ログ)は どの経路でも共通です。
サイトの問い合わせ
└─→ 受信口(4経路のどれか1つ)
├─ 通知メール → 登録した宛先すべて
├─ 自動返信 → 問い合わせた本人(任意)
└─ 受信ログ → 管理画面で内容を確認4つの経路から1つ選ぶ
受信口ごとに入口を1つ決めます。選んでいない入口宛のリクエストは 403 で拒否します(使わない入口を開けっ放しにしないため)。 受け取り方はあとから変更できます。
| 経路 | こんなときに | 認証 |
|---|---|---|
| webhook | CMS やフォームサービスが webhook を飛ばせる | 受信URL+任意の共有シークレット |
| API | 自分のサーバーのコードから送る | APIキー(Bearer) |
| サイトのフォーム | 静的サイトで、サーバーを持たない | 許可ドメイン+Turnstile |
| メール転送 | webhook も API も無いが通知メールは出せる | 専用の受信アドレス |
迷ったら webhook です。CMS やフォームサービスの多くが対応していて、 設定画面に受信URLを貼るだけで繋がります。
はじめかた
- アカウントを作り、受信口を1つ作る(受け取り方をここで選ぶ)
- 設定 →「接続方法」に出る接続情報を、送信元に設定する
- 通知先(To)を登録する ── ここが空だと、受信しても誰にも届きません
- テストで1件送り、「受信ログ」タブで届いた内容を確認する
自社ドメインから送りたい場合は独自ドメイン送信、 受付メールを返したい場合は自動返信へ。
共通の仕様
本文の上限
1件あたり 256KB までです。超えると 413 を返します。
受信ログ
届いた内容と処理結果(通知した宛先数・自動返信の有無・エラー)が残ります。 取り出せた項目もそのまま保存されるので、どのキーが使えるかはここで確認できます。
認証に失敗したとき
受信口を特定する前に弾いたリクエストはログに残りません。 共有シークレットの不一致だけは、受信口が判明しているので記録されます。