使用 Mailgun 邮件服务设置电子邮件验证
Logto 的 Mailgun 邮件服务官方连接器。
提示:
在本指南中,我们假设你对 Logto 连接器 (Connectors) 有基本的了解。如果没有,请查看 配置连接器 指南以开始了解。
前提条件
- 一个 Mailgun 账户
- 你的 Mailgun 账户中的一个 API 密钥,需要发送消息(电子邮件)的权限。有关更多信息,请参阅 Where Can I Find My API Key and SMTP Credentials?。
基本配置
- 当你使用不同的 Mailgun API 端点时,请填写
endpoint
字段,例如,EU 区域应为https://api.eu.mailgun.net
。默认值为https://api.mailgun.net
。 - 使用你在 Mailgun 账户中注册的域填写
domain
字段。此值可以在 Mailgun 仪表板的 Domains 部分找到。域应为example.com
格式,不带https://
或http://
前缀。 - 使用你在 Mailgun 账户中生成的 API 密钥填写
apiKey
字段。 - 使用你想要发送电子邮件的电子邮件地址填写
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 邮件连接器
你可以输入一个电子邮件地址并点击“发送”以查看设置是否可以在“保存并完成”之前工作。
就是这样。别忘了 在登录体验中启用连接器