mirror of
https://github.com/dreamhunter2333/cloudflare_temp_email.git
synced 2026-07-12 16:02:10 +08:00
docs: add webhook preset templates and Telegram push docs (#884)
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>
This commit is contained in:
@@ -55,6 +55,31 @@ Telegram Bot 支持中英文切换,用户可以通过 `/lang` 命令设置语
|
||||
|
||||
语言偏好会保存到 KV 中,每个用户可以独立设置。
|
||||
|
||||
## 每用户邮件推送
|
||||
|
||||
Telegram Bot 支持 **每用户独立推送**,用户绑定地址后,该地址收到的邮件会自动推送给对应用户。
|
||||
|
||||
### 用户操作流程
|
||||
|
||||
1. 在 Telegram 中找到你部署的 Bot
|
||||
2. 使用 `/new [name@domain]` 创建新邮箱地址,或使用 `/bind <credential>` 绑定已有地址
|
||||
3. 绑定后,该地址收到邮件时会 **自动推送通知给你**
|
||||
4. 使用 `/address` 查看已绑定的地址列表
|
||||
5. 使用 `/unbind <address>` 解绑地址
|
||||
|
||||
> [!TIP]
|
||||
> 每个用户最多可绑定 `TG_MAX_ADDRESS`(默认 5)个地址
|
||||
|
||||
### 全局推送
|
||||
|
||||
管理员可以在后台 `设置` -> `Telegram` 页面开启 **全局邮件推送**,将所有邮件推送给指定的 Telegram 用户 ID 列表。
|
||||
|
||||
- `enableGlobalMailPush`: 是否开启全局推送
|
||||
- `globalMailPushList`: 接收全局推送的 Telegram 用户 ID 列表
|
||||
|
||||
> [!NOTE]
|
||||
> 全局推送和每用户推送可以同时生效。如果某地址已绑定用户,同时该用户也在全局推送列表中,则会收到两条通知。
|
||||
|
||||
## Mini App
|
||||
|
||||
可以通过命令行部署,或者 UI 界面部署
|
||||
|
||||
@@ -26,6 +26,77 @@
|
||||
|
||||

|
||||
|
||||
## Webhook 模板示例
|
||||
|
||||
### Telegram Bot 推送
|
||||
|
||||
通过 Webhook 直接调用 Telegram Bot API 推送邮件通知,适合不想部署完整 Telegram Bot 集成或需要自定义推送格式的场景。
|
||||
|
||||
- **URL**: `https://api.telegram.org/bot<YOUR_BOT_TOKEN>/sendMessage`
|
||||
- **Method**: `POST`
|
||||
- **Headers**:
|
||||
|
||||
```json
|
||||
{
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
```
|
||||
|
||||
- **Body**:
|
||||
|
||||
```json
|
||||
{
|
||||
"chat_id": "YOUR_CHAT_ID",
|
||||
"text": "New Email\nFrom: ${from}\nTo: ${to}\nSubject: ${subject}\nURL: ${url}"
|
||||
}
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> 获取 `chat_id`:向 Bot 发送一条消息,然后访问 `https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates` 查看返回结果中的 `chat.id` 字段
|
||||
|
||||
### 企业微信机器人推送
|
||||
|
||||
- **URL**: `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=YOUR_KEY`
|
||||
- **Method**: `POST`
|
||||
- **Headers**:
|
||||
|
||||
```json
|
||||
{
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
```
|
||||
|
||||
- **Body**:
|
||||
|
||||
```json
|
||||
{
|
||||
"msgtype": "text",
|
||||
"text": {
|
||||
"content": "New Email\nFrom: ${from}\nTo: ${to}\nSubject: ${subject}\nURL: ${url}"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Discord Webhook 推送
|
||||
|
||||
- **URL**: `https://discord.com/api/webhooks/YOUR_WEBHOOK_ID/YOUR_WEBHOOK_TOKEN`
|
||||
- **Method**: `POST`
|
||||
- **Headers**:
|
||||
|
||||
```json
|
||||
{
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
```
|
||||
|
||||
- **Body**:
|
||||
|
||||
```json
|
||||
{
|
||||
"content": "**New Email**\nFrom: ${from}\nTo: ${to}\nSubject: ${subject}\nURL: ${url}"
|
||||
}
|
||||
```
|
||||
|
||||
## webhook 数据格式
|
||||
|
||||
要获取 url 需要配置 worker 的 `FRONTEND_URL` 为你的前端地址,或者你可以通过 `id` 自己拼接 url = `${FRONTEND_URL}?mail_id=${id}`
|
||||
|
||||
Reference in New Issue
Block a user