跳至主要內容

使用 Mailgun 電子郵件服務設定電子郵件驗證

官方 Logto Mailgun 電子郵件服務連接器。

提示:

本指南假設你已對 Logto 連接器 (Connectors) 有基本了解。若不熟悉，請參閱 連接器 (Connectors) 指南以開始使用。

先決條件​

基本設定​

  • 若你使用不同的 Mailgun API endpoint，請填寫 endpoint 欄位，例如，歐盟區域應為 https://api.eu.mailgun.net。預設值為 https://api.mailgun.net。
  • 在 domain 欄位填入你於 Mailgun 帳號註冊的網域。此值可於 Mailgun 控制台的 Domains 區段找到。網域格式應為 example.com，不需加上 https:// 或 http:// 前綴。
  • 在 apiKey 欄位填入你於 Mailgun 帳號產生的 API 金鑰。
  • 在 from 欄位填入你欲作為寄件人的電子郵件地址。此電子郵件地址必須已在 Mailgun 帳號註冊。格式應為 Sender Name <sender@example.com>。

郵件內容設定（Deliveries）​

設定物件（Config object）​

「Deliveries」區段允許你針對不同情境設定要發送的電子郵件內容。這是一個 JSON 鍵值對映，key 為使用情境（usage type），value 為包含郵件內容設定的物件。

{
  "<usage-type>": {
    // ...
  }
}

使用情境（Usage types）​

支援以下使用情境：

  • Register：使用者註冊時發送的郵件。
  • SignIn：使用者登入時發送的郵件。
  • ForgotPassword：使用者重設密碼時發送的郵件。
  • Generic：使用者執行一般操作（如測試郵件連接器）時發送的郵件。
備註:

若 deliveries 設定中未指定使用情境，將發送 generic 郵件。若未指定 generic 郵件，連接器將回傳錯誤。

內容設定（Content config）​

此連接器同時支援直接 HTML 內容與 Mailgun 範本。每個使用情境可擇一使用。

在主旨與內容中，你可使用 {{code}} 佔位符插入驗證碼。

若使用直接 HTML 內容，請填寫以下欄位：

  • subject：郵件主旨。
  • replyTo：回覆郵件地址。
  • html：（必填）郵件的 HTML 內容。
  • text：郵件的純文字版本。

若使用 Mailgun 範本，請填寫以下欄位：

  • subject：郵件主旨。
  • replyTo：回覆郵件地址。
  • template：（必填）要使用的 Mailgun 範本名稱。
  • variables：傳遞給 Mailgun 範本的變數。需為 JSON 鍵值對映，因為發送前會被字串化。注意無需包含 code 變數，連接器會自動加入。

範例​

以下為 deliveries 設定範例：

{
  "Register": {
    "subject": "{{code}} 是你的驗證碼",
    "replyTo": "Foo <foo@bar.com>",
    "html": "<h1>歡迎加入 Logto</h1><p>你的驗證碼是 {{code}}。</p>",
    "text": "歡迎加入 Logto。你的驗證碼是 {{code}}。"
  },
  "SignIn": {
    "subject": "歡迎回來 Logto",
    "replyTo": "Foo <foo@bar.com>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

測試 Mailgun 電子郵件連接器​

你可以輸入一個電子郵件地址並點擊「發送」來測試設定是否可用，確認無誤後再點選「儲存並完成」。

就是這麼簡單。別忘了 在註冊與登入流程啟用連接器。