跳至主要內容

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

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

提示:

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

先決條件​

基本配置​

  • 當你使用不同的 Mailgun API endpoint 時，填寫 endpoint 欄位，例如，EU 區域應為 https://api.eu.mailgun.net。預設值為 https://api.mailgun.net。
  • 在 domain 欄位填入你在 Mailgun 帳戶中註冊的網域。此值可在 Mailgun 儀表板的 Domains 部分找到。網域格式應為 example.com，不含 https:// 或 http:// 前綴。
  • 在 apiKey 欄位填入你在 Mailgun 帳戶中生成的 API key。
  • 在 from 欄位填入你想要用來發送電子郵件的電子郵件地址。此電子郵件地址必須在你的 Mailgun 帳戶中註冊。電子郵件地址格式應為 Sender Name \<[email protected]>。

傳遞​

配置物件​

「傳遞」部分允許你配置在不同情境下要發送的電子郵件內容。這是一個 JSON 鍵值對映，其中鍵是使用類型，值是一個包含要發送的電子郵件內容配置的物件。

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

使用類型​

支援以下使用類型：

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

如果在傳遞配置中未指定使用類型，將發送一般電子郵件。如果未指定一般電子郵件，連接器將返回錯誤。

內容配置​

連接器支援直接的 HTML 內容和 Mailgun 模板。你可以為每個使用類型選擇其中一種。

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

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

  • subject：要發送的電子郵件主題。
  • replyTo：用作回覆地址的電子郵件地址。
  • html：（必填）要發送的電子郵件的 HTML 內容。
  • text：要發送的電子郵件的純文字版本。

要使用 Mailgun 模板，填寫以下欄位：

  • subject：要發送的電子郵件主題。
  • replyTo：用作回覆地址的電子郵件地址。
  • template：（必填）要使用的 Mailgun 模板名稱。
  • variables：要傳遞給 Mailgun 模板的變數。應為 JSON 鍵值對映，因為在發送給 Mailgun 前會被字串化。注意不需要包含 code 變數，因為連接器會自動添加。

範例​

以下是傳遞配置的範例：

{
  "Register": {
    "subject": "{{code}} 是你的驗證碼",
    "replyTo": "Foo <[email protected]>",
    "html": "<h1>歡迎來到 Logto</h1><p>你的驗證碼是 {{code}}。</p>",
    "text": "歡迎來到 Logto。你的驗證碼是 {{code}}。"
  },
  "SignIn": {
    "subject": "歡迎回到 Logto",
    "replyTo": "Foo <[email protected]>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

測試 Mailgun 電子郵件連接器​

你可以輸入一個電子郵件地址並點擊「發送」來檢查設定是否有效，然後再「儲存並完成」。

就是這樣。別忘了 在登入體驗中啟用連接器。