クイックスタート
送信ドメインを検証してから、SMTPまたはEmail APIでメール送信を導入します。
1. 導入前の準備
メール確認済みアカウント、DNSを管理できるドメイン、現在のパッケージ情報を準備します。ドメイン追加には有効なパッケージが必要です。上限は実際の設定を確認してください。このページでログイン、購入、送信は行いません。
2. ドメインの追加と検証
コンソールでASCIIドメインを追加し、dns_recordsのDKIMとSPFのTXT値を設定します。DNS反映後に検証し、all_passedと各checksを確認してください。HTTP 200だけでは検証完了ではありません。検証済みドメインのみ送信に使用できます。
curl -X POST "${SMTPDOG_API_ORIGIN}/domains" \
-H "Authorization: Bearer ${SMTPDOG_SESSION_TOKEN}" \
-H "Content-Type: application/json" \
--data '{"domain_name":"example.com"}'3. 送信認証情報の作成
API Key作成時に完全なkeyを安全に保存します。一覧ではメタデータのみ取得できます。ドメイン範囲の指定を推奨します。送信はAPI Key、管理はセッショントークンを使用し、混用しないでください。ブラウザーや公開リポジトリにKeyを置かないでください。
4. 接続方式を選ぶ
Email APIは標準HTTPでmessage_idを取得できます。SMTPはTLS対応の標準クライアントを使い、1通につき受信者は1名です。環境変数は文書用の仮名称であり、バックエンド設定キーではありません。確認済みの接続情報を設定してください。
curl -X POST "${SMTPDOG_API_ORIGIN}/v1/mail/send" \
-H "Authorization: Bearer ${SMTPDOG_API_KEY}" \
-H "Content-Type: application/json" \
--data '{
"from": "sender@example.com",
"to": "recipient@example.com",
"subject": "Welcome to your product",
"text": "Your message goes here."
}'5. 受付結果を理解する
HTTP 202とqueuedは受付とキュー登録のみを意味します。message_idで状態を照会するかWebhookを受信してください。sentも受信箱到達や開封を保証しません。送信の冪等性プロトコルはないため、タイムアウト時に無条件で再送しないでください。