借助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/ 目录下。

参考资料

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

相关推荐
掘金码甲哥8 小时前
新来的外包,限流算法用的这么6
后端
曾经的三心草8 小时前
springCloud二-SkyWalking3-性能剖析-⽇志上传-告警管理-接入飞书
后端·spring·spring cloud
申阳8 小时前
Day 2:我用了2小时,上线了一个还算凑合的博客站点
前端·后端·程序员
清心歌8 小时前
Spring AI Alibaba 【四】
java·后端
赵文宇8 小时前
构建内网离线的"github.com",完美解决内网Go开发依赖
github
老华带你飞8 小时前
动漫资讯|基于Springboot的动漫交流网站设计与实现(源码+数据库+文档)
java·数据库·spring boot·后端·论文·毕设·国产动漫网站
爱分享的鱼鱼8 小时前
Java实践之路(一):记账程序
前端·后端
有意义8 小时前
Spring Boot 项目中部门查询功能实现与依赖注入优化
后端·设计模式
说私域8 小时前
开源AI智能客服、AI智能名片与S2B2C商城小程序在营销运营中的应用与重要性研究
人工智能·小程序·开源