Docs
邮件配置

邮件配置

如何配置项目中的邮件服务

English

简体中文

此模块配置在 v1.1.5 版本之后经历了较大改变,注意修改对应配置。

  • 移除了 RESEND_API_KEY,替换为 BREVO_API_KEY (在较早版本仅默认使用 Resend 服务,由于官方账号被Resend封禁,不得不切换服务商所以做出此次变动)
  • 默认使用 Resend 发送系统通知邮件替换为了 Brevo
  • RESEND_FROM_EMAIL 替换为 EMAIL_FROM, 新增 EMAIL_FROM_NAME 环境变量

本项目的邮件服务模块具备接收和发送邮件的能力,本篇将介绍如何配置项目中的邮件发送服务。

如果你需要配置接收邮件功能,请参考文档 cloudflare-email-worker

目前支持的发件服务商:

  • Resend (免费额度:每天最多发送 100 封,支持绑定 1 个域名)
  • Brevo (免费额度:每天最多发送 300 封,支持绑定多个域名)

后续会根据需求接入其他发件方式。

环境变量

BREVO_API_KEY=your-brevo-api-key
EMAIL_FROM=support@your-domain.com
EMAIL_FROM_NAME=WR.DO

注册并登录 Brevo 控制台 app.brevo.com/settings/keys/api 页面创建一个密钥,将其复制并粘贴到环境变量中。

注意,在此处配置的 BREVO_API_KEY 默认用于子域名申请通知功能,不会用于发送邮件。也可将此key填入下方的域名配置中作为邮件服务模块的发件者。

Brevo

在本项目中,有以下几处会使用到 Brevo 发送邮件:

  • 邮件服务模块(/email
  • 子域名申请通知(在系统设置中,默认关闭此功能)
  • 邮箱验证功能(开发中 /dashboard/settings

同样在Brevo 控制台创建 API 密钥,然后回到系统的 localhost:3000/admin/system 页面, 在域名管理项中点击添加域名,并在子项邮件服务商中填写对应的 API 密钥保存即可:

之后,你可以在 Brevo 控制台的 Domain 页面绑定域名,根据提示添加解析记录完成配置即可:

最后在本系统依次添加域名,配置完成如下所示:

Resend

在本项目中,仅在邮件服务模块会使用 Resend 发送邮件。

创建 API 密钥

登录 Resend 后,它会提示你创建第一个 API 密钥。

将其复制并粘贴,后续步骤与 Brevo 类似,需要先绑定域名并配置解析记录。