返回首頁

SMTPDog 開發者串接文件

清晰透明的串接規範:網域驗證、SMTP 與 Email API、API Key、Webhook 驗簽與常見問題排查。

01 · quickstart

快速開始

先驗證寄件網域,再透過 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,管理使用工作階段 Token,不可混用,也不要將 Key 放入瀏覽器或公開儲存庫。

4. 選擇串接方式

Email API 使用標準 HTTP 並回傳 message_id。SMTP 使用支援 TLS 的標準用戶端,每封郵件只接受一位收件者。範例環境變數為文件佔位命名,並非後端設定鍵,須填入確認過的串接資訊。

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 不保證進入收件匣或已讀取。發送逾時後勿盲目重送,目前沒有用戶端發送冪等協定。