diff --git a/CHANGELOG.md b/CHANGELOG.md index 484c015b..b00775c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,11 @@ # CHANGE LOG -## main(v0.7.2) +## v0.7.2 - fix: worker 增加 `NO_LIMIT_SEND_ROLE` 配置, 加载失败的问题 -- feat: worker 增加 `# ADDRESS_REGEX = "[^a-z.0-9]"` 配置, 用于配置地址的正则表达式 +- feat: worker 增加 `# ADDRESS_REGEX = "[^a-z.0-9]"` 配置, 用于配置地址的正则表达式，如果不设置，默认为 [^a-z0-9], 需谨慎使用, 有些符号可能导致无法收件 +- feat: worker 优化 webhook 逻辑, 支持 admin 配置全局 webhook, 添加 `message pusher` 集成示例 ## v0.7.1 diff --git a/vitepress-docs/docs/.vitepress/zh.ts b/vitepress-docs/docs/.vitepress/zh.ts index 156bf505..f9998937 100644 --- a/vitepress-docs/docs/.vitepress/zh.ts +++ b/vitepress-docs/docs/.vitepress/zh.ts @@ -135,6 +135,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] { { text: '配置 Telegram Bot', link: 'feature/telegram' }, { text: '配置 S3 附件', link: 'feature/s3-attachment' }, { text: '配置 worker 使用 wasm 解析邮件', link: 'feature/mail_parser_wasm_worker' }, + { text: '配置 webhook', link: 'feature/webhook' }, { text: '新建邮箱地址 API', link: 'feature/new-address-api' }, ] }, diff --git a/vitepress-docs/docs/public/feature/address-webhook.png b/vitepress-docs/docs/public/feature/address-webhook.png new file mode 100644 index 00000000..2a8092cb Binary files /dev/null and b/vitepress-docs/docs/public/feature/address-webhook.png differ diff --git a/vitepress-docs/docs/public/feature/admin-mail-webhook.png b/vitepress-docs/docs/public/feature/admin-mail-webhook.png new file mode 100644 index 00000000..d2cb1c40 Binary files /dev/null and b/vitepress-docs/docs/public/feature/admin-mail-webhook.png differ diff --git a/vitepress-docs/docs/public/feature/admin-webhook-settings.png b/vitepress-docs/docs/public/feature/admin-webhook-settings.png new file mode 100644 index 00000000..8b1c6c40 Binary files /dev/null and b/vitepress-docs/docs/public/feature/admin-webhook-settings.png differ diff --git a/vitepress-docs/docs/zh/guide/cli/worker.md b/vitepress-docs/docs/zh/guide/cli/worker.md index 2903b3d9..395a5ed2 100644 --- a/vitepress-docs/docs/zh/guide/cli/worker.md +++ b/vitepress-docs/docs/zh/guide/cli/worker.md @@ -46,7 +46,7 @@ node_compat = true PREFIX = "tmp" # 要处理的邮箱名称前缀，不需要后缀可配置为空字符串 # (min, max) adderss的长度，如果不设置，默认为(1, 30) # ANNOUNCEMENT = "Custom Announcement" # 自定义公告 -# address name 的正则表达式，如果不设置，默认为 [^a-z0-9] +# address name 的正则表达式，如果不设置，默认为 [^a-z0-9], 需谨慎使用, 有些符号可能导致无法收件 # ADDRESS_REGEX = "[^a-z0-9]" # MIN_ADDRESS_LEN = 1 # MAX_ADDRESS_LEN = 30 diff --git a/vitepress-docs/docs/zh/guide/feature/telegram.md b/vitepress-docs/docs/zh/guide/feature/telegram.md index c7dbd11e..85a1a566 100644 --- a/vitepress-docs/docs/zh/guide/feature/telegram.md +++ b/vitepress-docs/docs/zh/guide/feature/telegram.md @@ -1,10 +1,12 @@ # 配置 Telegram Bot -## Telegram Bot 配置 - > [!NOTE] +> 如果要使用 Telegram Bot, 请先绑定 `KV` +> > 如果不需要 Telegram Bot, 可跳过此步骤 +## Telegram Bot 配置 + 请先创建一个 Telegram Bot，然后获取 `token`，然后执行下面的命令，将 `token` 添加到 secrets 中 你也可以在 Cloudflare 的 UI 界面中添加 `secrets` diff --git a/vitepress-docs/docs/zh/guide/feature/webhook.md b/vitepress-docs/docs/zh/guide/feature/webhook.md new file mode 100644 index 00000000..308b1e1c --- /dev/null +++ b/vitepress-docs/docs/zh/guide/feature/webhook.md @@ -0,0 +1,27 @@ +# 配置 webhook + +> [!NOTE] +> 如果要使用 webhook，请先绑定 `KV` +> +> 如果你想 webhook 的解析邮件能力更强，参考 [配置 worker 使用 wasm 解析邮件](feature/mail_parser_wasm_worker) + +## 前提条件 + +你需要自建一个 `webhook 服务` 或者 使用 `第三方平台`，这个服务需要能够接收 `POST` 请求，并且能够解析 `json` 数据。 + +本项目使用了 [songquanpeng/message-pusher](https://github.com/songquanpeng/message-pusher) 示例作为 webhook 服务。 + +- 可以使用 [msgpusher.com](https://msgpusher.com) 提供的服务 +- 也可以自建 `message-pusher` 服务，参考 [songquanpeng/message-pusher](https://github.com/songquanpeng/message-pusher) + +## admin 配置全局 webhook + +![telegram](/feature/admin-mail-webhook.png) + +## admin 允许邮箱使用 webhook + +![telegram](/feature/admin-webhook-settings.png) + +## 某个邮箱配置 webhook + +![telegram](/feature/address-webhook.png)