借助Github Action实现通过 HTTP 请求触发邮件通知

Github仓库:Send Mail

Send Mail

通过 HTTP 请求触发 Github Actions 自动发送邮件的 workflow。可用于各种通知场景,如 IP 变更通知、任务完成提醒等。只要可以发起 HTTP 请求的地方,都可以使用此功能发送邮件通知。

如何使用

  • fork 本仓库到你的 Github 账号下。

  • 在你的仓库中,进入 Settings -> Secrets and variables -> Actions,添加以下 Secrets:

    • MAIL_USERNAME:SMTP 服务器用户名(通常是你的邮箱地址)

    • MAIL_PASSWORD:SMTP 服务器密码(通常是授权码)

      名称 必填
      MAIL_USERNAME SMTP 服务器用户名(通常是你的邮箱地址)
      MAIL_PASSWORD SMTP 服务器密码(通常是授权码)
  • 发送http请求触发邮件发送

    • 请求格式如下:

      bash 复制代码
      curl --request POST \
       --url https://api.github.com/repos/<owner>/<repo>/dispatches \
       --header 'Accept: application/vnd.github+json' \
       --header 'Authorization: <YOUR_GITHUB_TOKEN>' \
       --header 'Content-Type: application/json' \
       --data '{
                 "event_type": "send_mail",
                 "client_payload": {
                     "to": "example@163.com",
                     "subject": "📧 外部触发邮件通知",
                     "template": "ip_update_template.html",
                     "variables": {
                       "xx": "xx",
                       "ipv4Result": "成功",
                       "ipv4Domains": "example.com,api.example.com",
                       "ipv6Addr": "fe80::abcd",
                       "ipv6Result": "未改变",
                       "ipv6Domains": "v6.example.com",
                       "message": "来自Webhook的提醒111"
                     }
                 }
               }'

      其中:

      • <owner>:你的 Github 用户名或组织名

      • <repo>:你的仓库名

      • <YOUR_GITHUB_TOKEN>:你的 Github 个人访问令牌(需要有 repo 权限)

        变量名 说明
        <owner> 你的 Github 用户名或组织名
        <repo> 你的仓库名
        <YOUR_GITHUB_TOKEN> 你的 Github 个人访问令牌(需要有 repo 权限)
    • 示例请求:

      bash 复制代码
      curl --request POST \
      --url https://api.github.com/repos/vains-Sofia/send-mail/dispatches \
      --header 'Accept: application/vnd.github+json' \
      --header 'Authorization: <YOUR_GITHUB_TOKEN>' \
      --header 'Content-Type: application/json' \
      --data '{
                "event_type": "send_mail",
                "client_payload": {
                  "to": "example@163.com",
                  "subject": "📧 外部触发邮件通知",
                  "template": "ip_update_template.html",
                  "variables": {
                    "ipv4Addr": "192.168.0.2",
                    "ipv4Result": "成功",
                    "ipv4Domains": "example.com,api.example.com",
                    "ipv6Addr": "fe80::abcd",
                    "ipv6Result": "未改变",
                    "ipv6Domains": "v6.example.com",
                    "message": "来自Webhook的提醒111"
                    }
                  }
              }'
    • 入参说明:

      • event_type:固定值,必须为 send_mail
      • client_payload:包含邮件相关信息的对象,包含以下字段:
        • to:收件人邮箱地址

        • subject:邮件主题

        • template:邮件模板文件名(需预先在仓库中准备好对应的 HTML 模板文件,位于 mail-templates/ 目录下)

        • variables:模板变量的键值对,根据模板中的占位符进行替换

          变量名 说明
          event_type 固定值,必须为 send_mail
          client_payload 包含邮件相关信息的对象
          to 收件人邮箱地址
          subject 邮件主题
          template 邮件模板文件名(位于 mail-templates/ 目录下)
          variables 模板变量的键值对,根据模板中的占位符进行替

邮件模板示例

模板示例效果

注意事项

  • 确保用户名和密码(授权码)有效。
  • 确保你的 Github 个人访问令牌具有足够的权限来触发仓库的 repository_dispatch 事件。
  • 邮件模板文件需预先在仓库中准备好,位于 mail-templates/ 目录下。

参考资料

欢迎大家提供反馈和建议!

相关推荐
用户85996816776910 小时前
UE5虚幻引擎汽车HMI设计高级研修课
后端
用户85996816776911 小时前
鸿蒙HarmonyOS多线程编程实战:AI语音
后端
开心猴爷11 小时前
iOS 应用发布流程中常被忽视的关键环节
后端
用户219916797039111 小时前
使用Agent Framework进行多Agent工作流编排
后端
serendipity_hky11 小时前
【go语言 | 第5篇】channel——多个goroutine之间通信
开发语言·后端·golang
zhaorong11 小时前
RabbitMQ发布订阅模式同一消费者多个实例如何防止重复消费?
后端
开心猴爷11 小时前
提升 iOS 应用安全审核通过率的一种思路,把容易被拒的点先处理
后端
我家领养了个白胖胖11 小时前
Prompt、格式化输出、持久化ChatMemory
java·后端·ai编程
全栈老石11 小时前
别再折腾端口转发了:使用 Cloudflare Tunnel 优雅地分享你的 localhost
前端·后端·全栈
Java编程爱好者11 小时前
是猫踩键盘还是乱码?不,这是你刚写的正则表达式
后端