发送邮件

本文档介绍如何配置邮件发送者的信息。配置文件可以位于以下两个位置之一:

  1. 在配置目录的根目录中,并以 email.yaml 命名。
- configs/
  |-- email.yaml
  1. 在任意其他目录中,以自定义名称命名,然后通过 -e--email-config-file 选项进行指定。

配置示例

---
sender: oredge@openresty.com
password: SENDER_PASSWORD
smtp_server: smtp-mail.outlook.com
smtp_port: 587
new_user_email_template:
  subject: 'Your OpenResty Edge account is ready!'
  content: |
    Your OpenResty Edge account is ready!

    Please login to https://oredge.admin.com

    Username: {{ username }}(ID: {{ user_id }})
    Password: {{ password }}
    User Group: {{ user_group }}(ID: {{ user_group_id }})

    If you have any questions, please contact oredge@openresty.com

配置文件中各字段的含义如下:

  • sender:发送者的邮箱地址。
  • password:登录发送者邮箱的密码。如果启用了两步验证,您可能需要创建并使用应用专用密码。例如,您可以在 Microsoft 账号安全页面Google 账号安全页面 中创建应用专用密码。
  • smtp_server:SMTP 服务器地址。常见的 SMTP 服务器包括 Google 的 smtp.gmail.com 和 Microsoft 的 smtp-mail.outlook.com。
  • smtp_port:SMTP 服务器端口,通常为 587。
  • new_user_email_template:新建用户时发送邮件通知的邮件模板。
    • subject:邮件主题。
    • content:邮件正文。可以使用以下模板变量:
      • {{ username }}:新创建的用户名。
      • {{ user_id }}:新创建的用户在 Edge Admin 系统中的 ID。
      • {{ password }}:该用户的密码。
      • {{ user_group }}:该用户所属的用户组名称。
      • {{ user_group_id }}:该用户所属用户组在 Edge Admin 系统中的 ID。