docs: add webhook preset templates and Telegram per-user push docs (#769) Add Telegram Bot, WeChat Work, Discord webhook preset templates to frontend and documentation. Add per-user mail push and global push documentation for Telegram Bot. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
4.0 KiB
配置 Telegram Bot
试用地址:@cf_temp_mail_bot
::: warning 注意
worker 默认的 worker.dev 域名的证书是不被 telegram 支持的,配置 Telegram Bot 请使用自定义域名
:::
Note
如果要使用 Telegram Bot, 请先绑定
KV如果不需要 Telegram Bot, 可跳过此步骤
如果你想 Telegram 的解析邮件能力更强,参考 配置 worker 使用 wasm 解析邮件
Telegram Bot 配置
请先创建一个 Telegram Bot,然后获取 token,然后执行下面的命令,将 token 添加到 secrets 中
Note
如果你觉得麻烦,也可以直接明文放在
wrangler.toml中[vars]下面,但是不推荐这样做
如果你是通过 UI 部署的,可以在 Cloudflare 的 UI 界面中添加到 Variables and Secrets 下面
# 切换到 worker 目录
cd worker
pnpm wrangler secret put TELEGRAM_BOT_TOKEN
Bot
- 可设置白名单用户
- 点击
初始化即可完成配置。 - 点击
查看状态,可以查看当前配置的状态。
语言切换功能
Note
此功能从 v1.2.0 版本开始支持
Telegram Bot 支持中英文切换,用户可以通过 /lang 命令设置语言偏好。
启用语言切换
需要在 worker 变量中配置 TG_ALLOW_USER_LANG = true 才能启用此功能。
使用方法
/lang zh- 切换为中文/lang en- 切换为英文/lang- 查看当前语言设置
语言偏好会保存到 KV 中,每个用户可以独立设置。
每用户邮件推送
Telegram Bot 支持 每用户独立推送,用户绑定地址后,该地址收到的邮件会自动推送给对应用户。
用户操作流程
- 在 Telegram 中找到你部署的 Bot
- 使用
/new [name@domain]创建新邮箱地址,或使用/bind <credential>绑定已有地址 - 绑定后,该地址收到邮件时会 自动推送通知给你
- 使用
/address查看已绑定的地址列表 - 使用
/unbind <address>解绑地址
Tip
每个用户最多可绑定
TG_MAX_ADDRESS(默认 5)个地址
全局推送
管理员可以在后台 设置 -> Telegram 页面开启 全局邮件推送,将所有邮件推送给指定的 Telegram 用户 ID 列表。
enableGlobalMailPush: 是否开启全局推送globalMailPushList: 接收全局推送的 Telegram 用户 ID 列表
Note
全局推送和每用户推送可以同时生效。如果某地址已绑定用户,同时该用户也在全局推送列表中,则会收到两条通知。
Mini App
可以通过命令行部署,或者 UI 界面部署
UI 部署
其他步骤参考 UI 部署 中的 前后端分离部署
Note
从这里下载 zip, telegram-frontend.zip
修改压缩包里面的 index-xxx.js 文件 ,xx 是随机的字符串
搜索
https://temp-email-api.xxx.xxx,替换成你worker 的域名,然后部署新的zip文件
命令行部署
cd frontend
pnpm install
cp .env.example .env.prod
# 修改 .env.prod 文件,设置 VITE_IS_TELEGRAM=true
# --project-name 可以单独为 mini app 创建一个 pages, 你也可以公用一个 pages,但是可能遇到 js 加载不了的问题
pnpm run deploy:telegram --project-name=<你的项目名称>
Warning
Windows 用户请注意:
npm scripts中的VITE_IS_TELEGRAM=true内联环境变量写法在 Windows 上不生效。 请在.env.prod文件中手动设置VITE_IS_TELEGRAM=true,然后使用普通的 build 命令代替:pnpm run build
- 部署完成后,请在 admin 后台的
设置->电报小程序页面电报小程序 URL中填写网页 URL。 - 请在
@BotFather处执行/setmenubutton,然后输入你的网页地址,设置左下角的Open App按钮。 - 请在
@BotFather处执行/newapp新建 app 来注册 mini app。
