mirror of
https://github.com/dreamhunter2333/cloudflare_temp_email.git
synced 2026-05-12 19:49:52 +08:00
Compare commits
41 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e4c96c9868 | ||
|
|
2318e0f7e2 | ||
|
|
2cce3df213 | ||
|
|
a38a31a407 | ||
|
|
276093f113 | ||
|
|
36f8c4b3de | ||
|
|
8964d4461d | ||
|
|
a771446b9b | ||
|
|
50ab6756bd | ||
|
|
aee1f1942b | ||
|
|
3ebe22115a | ||
|
|
5e227d2b2d | ||
|
|
3b3968f3b4 | ||
|
|
499f65078b | ||
|
|
0d63142bd7 | ||
|
|
16ce1bf4e0 | ||
|
|
288eb38302 | ||
|
|
24366e2bff | ||
|
|
e5f62d4713 | ||
|
|
1836f931ee | ||
|
|
0f2836eebb | ||
|
|
b933aef7d9 | ||
|
|
fa72d7187f | ||
|
|
d15a4904a5 | ||
|
|
a25199eb34 | ||
|
|
7d485a7d0d | ||
|
|
abe812666f | ||
|
|
dbb55d948f | ||
|
|
a2a9f9e25f | ||
|
|
793901d349 | ||
|
|
113f9ad66b | ||
|
|
088bf3eefe | ||
|
|
024f9ba430 | ||
|
|
b337a44e62 | ||
|
|
eaeac8ebec | ||
|
|
7393519ba4 | ||
|
|
4ddc8e5c96 | ||
|
|
8b7ddae4f6 | ||
|
|
be36967b80 | ||
|
|
fac249ed31 | ||
|
|
bfd7d6811e |
4
.github/workflows/pr_agent.yml
vendored
4
.github/workflows/pr_agent.yml
vendored
@@ -3,6 +3,7 @@ name: Codium PR Agent
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, reopened, ready_for_review]
|
||||
issue_comment:
|
||||
jobs:
|
||||
pr_agent_job:
|
||||
if: ${{ github.event.sender.type != 'Bot' }}
|
||||
@@ -10,11 +11,12 @@ jobs:
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: write
|
||||
contents: write
|
||||
name: Run pr agent on every pull request, respond to user comments
|
||||
steps:
|
||||
- name: PR Agent action step
|
||||
id: pragent
|
||||
uses: docker://codiumai/pr-agent:0.29-github_action
|
||||
uses: qodo-ai/pr-agent@main
|
||||
env:
|
||||
PR_REVIEWER.REQUIRE_TESTS_REVIEW: "false"
|
||||
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
|
||||
|
||||
7
.github/workflows/smtp_proxy_server.yml
vendored
7
.github/workflows/smtp_proxy_server.yml
vendored
@@ -36,6 +36,9 @@ jobs:
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Set lowercase repository name
|
||||
run: echo "REPO_LOWER=${GITHUB_REPOSITORY,,}" >> $GITHUB_ENV
|
||||
|
||||
- name: Build and push Docker images
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
@@ -44,5 +47,5 @@ jobs:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: |
|
||||
${{ env.REGISTRY }}/${{ github.repository }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}
|
||||
${{ env.REGISTRY }}/${{ github.repository }}/${{ env.IMAGE_NAME }}:latest
|
||||
${{ env.REGISTRY }}/${{ env.REPO_LOWER }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}
|
||||
${{ env.REGISTRY }}/${{ env.REPO_LOWER }}/${{ env.IMAGE_NAME }}:latest
|
||||
|
||||
35
AGENTS.md
Normal file
35
AGENTS.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Repository Guidelines
|
||||
|
||||
## Project Structure
|
||||
- Backend: `worker/` (Workers API; entry `worker/src/worker.ts`, APIs under `worker/src/*_api/`).
|
||||
- Frontend: `frontend/` (Vue 3 app; routes in `frontend/src/router/`).
|
||||
- Pages middleware: `pages/functions/_middleware.js`.
|
||||
- Mail parser: `mail-parser-wasm/` (Rust WASM).
|
||||
- SMTP/IMAP proxy: `smtp_proxy_server/`.
|
||||
- DB schema/migrations: `db/`.
|
||||
- Docs: `vitepress-docs/`.
|
||||
|
||||
## Build & Dev Commands
|
||||
Run inside each folder:
|
||||
- Frontend: `pnpm dev`, `pnpm build`.
|
||||
- Worker: `pnpm dev`, `pnpm lint`, `pnpm build`.
|
||||
- Pages: `pnpm dev`.
|
||||
- Docs: `pnpm dev` in `vitepress-docs/`.
|
||||
- WASM: `wasm-pack build --release` in `mail-parser-wasm/`.
|
||||
- SMTP proxy: `pip install -r smtp_proxy_server/requirements.txt` then `python smtp_proxy_server/main.py`.
|
||||
|
||||
## Coding Style
|
||||
- Follow existing module style. `worker/` uses TypeScript + ESLint; `frontend/` uses Vue SFCs.
|
||||
- Keep current naming patterns: `*_api/`, `utils/`, `models/`.
|
||||
- ESM imports only (`type: module`).
|
||||
|
||||
## Testing
|
||||
- No formal test runner. Validate with local dev servers and key flows (login, inbox, send/receive).
|
||||
|
||||
## Commits & PRs
|
||||
- Use Conventional Commits (`feat:`, `fix:`, `docs:`). Recent history includes PR numbers like `(#123)`.
|
||||
- PRs should explain scope and add screenshots for UI changes.
|
||||
|
||||
## Config Tips
|
||||
- Worker settings in `worker/wrangler.toml` (see template for bindings).
|
||||
- Frontend uses `VITE_*` env vars. Don’t commit secrets.
|
||||
53
CHANGELOG.md
53
CHANGELOG.md
@@ -1,6 +1,57 @@
|
||||
<!-- markdownlint-disable-file MD004 MD024 MD034 MD036 -->
|
||||
<!-- markdownlint-disable-file MD004 MD024 MD033 MD034 MD036 -->
|
||||
# CHANGE LOG
|
||||
|
||||
<p align="center">
|
||||
<a href="CHANGELOG.md">🇨🇳 中文</a> |
|
||||
<a href="CHANGELOG_EN.md">🇺🇸 English</a>
|
||||
</p>
|
||||
|
||||
## v1.2.1(main)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- fix: |定时任务| 修复定时任务清理报错 `e.get is not a function`,使用可选链安全访问 Context 方法
|
||||
|
||||
### Improvements
|
||||
|
||||
- style: |AI 提取| 暗色模式下 AI 提取信息使用更柔和的蓝色 (#A8C7FA),减少视觉疲劳
|
||||
|
||||
## v1.2.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- |数据库| 新增 `source_meta` 字段,需执行 `db/2025-12-27-source-meta.sql` 更新数据库或到 admin 维护页面点击数据库更新按钮
|
||||
|
||||
### Features
|
||||
|
||||
- feat: |Admin| 新增管理员账号页面,显示当前登录方式并支持退出登录(仅限密码登录方式)
|
||||
- fix: |GitHub Actions| 修复容器镜像名需要全部小写的问题
|
||||
- feat: |邮件转发| 新增来源地址正则转发功能,支持按发件人地址过滤转发,完全向后兼容
|
||||
- feat: |地址来源| 新增地址来源追踪功能,记录地址创建来源(Web 记录 IP,Telegram 记录用户 ID,Admin 后台标记)
|
||||
- feat: |邮件过滤| 移除后端 keyword 参数,改为前端过滤当前页邮件,优化查询性能
|
||||
- feat: |前端| 地址切换统一为下拉组件,极简模式支持切换,主页提供地址管理入口
|
||||
- feat: |数据库| 为 `message_id` 字段添加索引,优化邮件更新操作性能,需执行 `db/2025-12-15-message-id-index.sql` 更新数据库
|
||||
- feat: |Admin| 维护页面增加自定义 SQL 清理功能,支持定时任务执行自定义清理语句
|
||||
- feat: |国际化| 后端 API 错误消息全面支持中英文国际化
|
||||
- feat: |Telegram| 机器人支持中英文切换,新增 `/lang` 命令设置语言偏好
|
||||
|
||||
## v1.1.0
|
||||
|
||||
- feat: |AI 提取| 增加 AI 邮件识别功能,使用 Cloudflare Workers AI 自动提取邮件中的验证码、认证链接、服务链接等重要信息
|
||||
- 支持优先级提取:验证码 > 认证链接 > 服务链接 > 订阅链接 > 其他链接
|
||||
- 管理员可配置地址白名单(支持通配符,如 `*@example.com`)
|
||||
- 前端列表和详情页展示提取结果
|
||||
- 需要配置 `ENABLE_AI_EMAIL_EXTRACT` 环境变量和 AI 绑定
|
||||
- 需要执行 `db/2025-12-06-metadata.sql` 文件中的 SQL 更新 `D1` 数据库 或者到 admin维护页面点击数据库更新按钮
|
||||
- feat: |Admin| 维护页面增加清理 n 天前空邮件的邮箱地址功能
|
||||
- fix: 修复自定义认证密码功能异常的问题 (前端属性名错误 & /open_api 接口被拦截)
|
||||
|
||||
## v1.0.7
|
||||
|
||||
- feat: |Admin| 新增 IP 黑名单功能,用于限制访问频率较高的 API
|
||||
- feat: |Admin| 新增 ASN 组织黑名单功能,支持基于 ASN 组织名称过滤请求(支持文本匹配和正则表达式)
|
||||
- feat: |Admin| 新增浏览器指纹黑名单功能,支持基于浏览器指纹过滤请求(支持精确匹配和正则表达式)
|
||||
|
||||
## v1.0.6
|
||||
|
||||
- feat: |DB| update db schema add index
|
||||
|
||||
588
CHANGELOG_EN.md
Normal file
588
CHANGELOG_EN.md
Normal file
@@ -0,0 +1,588 @@
|
||||
<!-- markdownlint-disable-file MD004 MD024 MD033 MD034 MD036 -->
|
||||
# CHANGE LOG
|
||||
|
||||
<p align="center">
|
||||
<a href="CHANGELOG.md">🇨🇳 中文</a> |
|
||||
<a href="CHANGELOG_EN.md">🇺🇸 English</a>
|
||||
</p>
|
||||
|
||||
## v1.2.1(main)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- fix: |Scheduled Tasks| Fix scheduled task cleanup error `e.get is not a function`, use optional chaining for safe access to Context methods
|
||||
|
||||
### Improvements
|
||||
|
||||
- style: |AI Extraction| Use softer blue color (#A8C7FA) for AI extraction info in dark mode to reduce eye strain
|
||||
|
||||
## v1.2.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- |Database| Add `source_meta` field, need to execute `db/2025-12-27-source-meta.sql` to update database or click database update button on admin maintenance page
|
||||
|
||||
### Features
|
||||
|
||||
- feat: |Admin| Add admin account page, display current login method and support logout (password login only)
|
||||
- fix: |GitHub Actions| Fix container image name must be lowercase
|
||||
- feat: |Email Forwarding| Add source address regex forwarding, filter by sender address, fully backward compatible
|
||||
- feat: |Address Source| Add address source tracking feature, record address creation source (Web records IP, Telegram records user ID, Admin panel marked)
|
||||
- feat: |Email Filtering| Remove backend keyword parameter, switch to frontend filtering of current page emails, optimize query performance
|
||||
- feat: |Frontend| Unify address switching into a dropdown component, support switching in simple mode, add address management entry on the homepage
|
||||
- feat: |Database| Add index for `message_id` field to optimize email update operations, need to execute `db/2025-12-15-message-id-index.sql` to update database
|
||||
- feat: |Admin| Add custom SQL cleanup feature to maintenance page, support scheduled task execution of custom cleanup statements
|
||||
- feat: |i18n| Backend API error messages now fully support Chinese and English internationalization
|
||||
- feat: |Telegram| Bot supports Chinese/English switching, add `/lang` command to set language preference
|
||||
|
||||
## v1.1.0
|
||||
|
||||
- feat: |AI Extraction| Add AI email recognition feature, use Cloudflare Workers AI to automatically extract verification codes, authentication links, service links and other important information from emails
|
||||
- Support priority extraction: verification codes > authentication links > service links > subscription links > other links
|
||||
- Admin can configure address whitelist (supports wildcards, e.g. `*@example.com`)
|
||||
- Frontend list and detail pages display extraction results
|
||||
- Need to configure `ENABLE_AI_EMAIL_EXTRACT` environment variable and AI binding
|
||||
- Need to execute SQL in `db/2025-12-06-metadata.sql` file to update `D1` database or click database update button on admin maintenance page
|
||||
- feat: |Admin| Add feature to cleanup addresses with empty mailboxes older than n days on maintenance page
|
||||
- fix: Fix custom authentication password function issue (frontend property name error & /open_api interface blocked)
|
||||
|
||||
## v1.0.7
|
||||
|
||||
- feat: |Admin| Add IP blacklist feature for limiting high-frequency API access
|
||||
- feat: |Admin| Add ASN organization blacklist feature, support filtering requests based on ASN organization name (supports text matching and regex)
|
||||
- feat: |Admin| Add browser fingerprint blacklist feature, support filtering requests based on browser fingerprint (supports exact matching and regex)
|
||||
|
||||
## v1.0.6
|
||||
|
||||
- feat: |DB| Update db schema add index
|
||||
- feat: |Address Password| Add address password login feature, enabled via `ENABLE_ADDRESS_PASSWORD` configuration, need to execute SQL in `db/2025-09-23-patch.sql` file to update `D1` database
|
||||
- fix: |GitHub Actions| Fix debug mode configuration, only enable debug mode when DEBUG_MODE is 'true'
|
||||
- feat: |Admin| Account management page adds multi-select batch operations (batch delete, batch clear inbox, batch clear outbox)
|
||||
- feat: |Admin| Maintenance page adds feature to cleanup unbound user addresses
|
||||
- feat: Support configuring different bound address quantity limits for different roles, configurable in admin page
|
||||
|
||||
## v1.0.5
|
||||
|
||||
- feat: Add `DISABLE_CUSTOM_ADDRESS_NAME` configuration: disable custom email address name feature
|
||||
- feat: Add `CREATE_ADDRESS_DEFAULT_DOMAIN_FIRST` configuration: prioritize first domain when creating addresses
|
||||
- feat: |UI| Add button to enter minimalist mode on homepage
|
||||
- feat: |Webhook| Add whitelist switch feature, support flexible access control
|
||||
|
||||
## v1.0.4
|
||||
|
||||
- feat: |UI| Optimize minimalist mode homepage, add all emails page functionality (delete/download/attachments/...), switchable in `Appearance`
|
||||
- feat: Admin account settings page adds `Email Forwarding Rules` configuration
|
||||
- feat: Admin account settings page adds `Reject Unknown Address Emails` configuration
|
||||
- feat: Email page adds Previous/Next buttons
|
||||
|
||||
## v1.0.3
|
||||
|
||||
- fix: Fix github actions deployment issue
|
||||
- feat: telegram /new when domain not specified, use random address
|
||||
|
||||
## v1.0.2
|
||||
|
||||
- fix: Fix oauth2 login failure issue
|
||||
|
||||
## v1.0.1
|
||||
|
||||
- feat: |UI| Add minimalist mode homepage, switchable in `Appearance`
|
||||
- fix: Fix oauth2 login default role not taking effect issue
|
||||
|
||||
## v1.0.0
|
||||
|
||||
- fix: |UI| Fix User inbox viewing, when address not selected, keyword query not working
|
||||
- fix: Fix auto cleanup task, time 0 not taking effect issue
|
||||
- feat: Cleanup feature adds cleanup of addresses created n days ago, cleanup of addresses inactive for n days
|
||||
- fix: |IMAP Proxy| Fix IMAP Proxy server unable to view new emails issue
|
||||
|
||||
## v0.10.0
|
||||
|
||||
- feat: Support User inbox viewing, `/user_api/mails` interface, support `address` and `keyword` filtering
|
||||
- fix: Fix Oauth2 login token retrieval, some Oauth2 require `redirect_uri` parameter issue
|
||||
- feat: When user accesses webpage, if `user token` expires within 7 days, auto refresh
|
||||
- feat: Add db initialization feature to admin portal
|
||||
- feat: Add `ALWAYS_SHOW_ANNOUNCEMENT` variable to configure whether to always show announcements
|
||||
|
||||
## v0.9.1
|
||||
|
||||
- feat: |UI| Support google ads
|
||||
- feat: |UI| Use shadow DOM to prevent style pollution
|
||||
- feat: |UI| Support URL jwt parameter auto-login to mailbox, jwt parameter overrides browser jwt
|
||||
- fix: |CleanUP| Fix cleanup emails when cleanup time exceeds 30 days error bug
|
||||
- feat: Admin user management page: add user address viewing feature
|
||||
- feat: | S3 Attachments| Add S3 attachment deletion feature
|
||||
- feat: | Admin API| Add admin bind user and address api
|
||||
- feat: | Oauth2 | When Oauth2 gets user info, support `JSONPATH` expressions
|
||||
|
||||
## v0.9.0
|
||||
|
||||
- feat: | Worker | Support multi-language
|
||||
- feat: | Worker | `NO_LIMIT_SEND_ROLE` configuration supports multiple roles, comma separated
|
||||
- feat: | Actions | Add `worker-with-wasm-mail-parser.zip` in build to support UI deployment with `wasm` worker
|
||||
|
||||
## v0.8.7
|
||||
|
||||
- fix: |UI| Fix mobile device date display issue
|
||||
- feat: |Worker| Support sending emails via `SMTP`, using [zou-yu/worker-mailer](https://github.com/zou-yu/worker-mailer/blob/main/README_zh-CN.md)
|
||||
|
||||
## v0.8.6
|
||||
|
||||
- feat: |UI| Announcements support html format
|
||||
- feat: |UI| `COPYRIGHT` supports html format
|
||||
- feat: |Doc| Optimize deployment documentation, supplement `Github Actions Deployment Documentation`, add `Worker Variable Description`
|
||||
|
||||
## v0.8.5
|
||||
|
||||
- feat: |mail-parser-wasm-worker| Fix `deprecated` parameter warning when calling `initSync` function
|
||||
- feat: rpc headers convert & typo (#559)
|
||||
- fix: telegram mail page use iframe show email (#561)
|
||||
- feat: |Worker| Add `REMOVE_ALL_ATTACHMENT` and `REMOVE_EXCEED_SIZE_ATTACHMENT` for removing email attachments, due to parsing emails some information will be lost, such as images.
|
||||
|
||||
## v0.8.4
|
||||
|
||||
- fix: |UI| Fix admin portal delete call api error when no recipient email
|
||||
- feat: |Telegram Bot| Add telegram bot cleanup invalid address credentials command
|
||||
- feat: Add worker configuration `DISABLE_ANONYMOUS_USER_CREATE_EMAIL` to disable anonymous user email creation, only allow logged-in users to create email addresses
|
||||
- feat: Add worker configuration `ENABLE_ANOTHER_WORKER` and `ANOTHER_WORKER_LIST`, for calling other worker rpc interfaces (#547)
|
||||
- feat: |UI| Auto refresh configuration saved to browser, configurable refresh interval
|
||||
- feat: Spam detection adds check-when-exists list `JUNK_MAIL_CHECK_LIST` configuration
|
||||
- feat: | Worker | Add `ParsedEmailContext` class for caching parsed email content, reduce parsing times
|
||||
- feat: |Github Action| Worker deployment adds `DEBUG_MODE` output logging, `BACKEND_USE_MAIL_WASM_PARSER` configuration for whether to use wasm to parse emails
|
||||
|
||||
## v0.8.3
|
||||
|
||||
- feat: |Github Action| Add auto update and deploy feature
|
||||
- feat: |UI| Admin user settings, support oauth2 configuration deletion
|
||||
- feat: Add spam detection must-pass list `JUNK_MAIL_FORCE_PASS_LIST` configuration
|
||||
|
||||
## v0.8.2
|
||||
|
||||
- fix: |Doc| Fix some documentation errors
|
||||
- fix: |Github Action| Fix frontend deployment branch error issue
|
||||
- feat: Admin send email feature
|
||||
- feat: Admin backend, account configuration page adds unlimited send email address list
|
||||
|
||||
## v0.8.1
|
||||
|
||||
- feat: |Doc| Update UI installation documentation
|
||||
- feat: |UI| Hide mailbox account ID from users
|
||||
- feat: |UI| Add `Forward` button to email detail page
|
||||
|
||||
## v0.8.0
|
||||
|
||||
- feat: |UI| Random address generation doesn't exceed max length
|
||||
- feat: |UI| Email time display in browser timezone, can switch to display UTC time in settings
|
||||
- feat: Support transferring emails to other users
|
||||
|
||||
## v0.7.6
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
UI deployment worker needs to click Settings -> Runtime, modify Compatibility flags, add `nodejs_compat`
|
||||
|
||||

|
||||
|
||||
### Changes
|
||||
|
||||
- feat: Support pre-setting bot info to reduce telegram callback latency (#441)
|
||||
- feat: Add telegram mini app build archive
|
||||
- feat: Add whether to enable spam check `ENABLE_CHECK_JUNK_MAIL` configuration
|
||||
|
||||
## v0.7.5
|
||||
|
||||
- fix: Fix `name` validation check
|
||||
|
||||
## v0.7.4
|
||||
|
||||
- feat: UI list page adds minimum width
|
||||
- fix: Fix `name` validation check
|
||||
- fix: Fix `DEFAULT_DOMAINS` configuration empty not taking effect issue
|
||||
|
||||
## v0.7.3
|
||||
|
||||
- feat: Worker adds `ADDRESS_CHECK_REGEX`, address name regex, only for checking, matching will pass check
|
||||
- fix: UI fix login page tab active icon misalignment
|
||||
- fix: UI fix admin page refresh popup password input issue
|
||||
- feat: Support `OAuth2` login, can login via `Github` `Authentik` and other third parties, see details [OAuth2 Third-party Login](https://temp-mail-docs.awsl.uk/en/guide/feature/user-oauth2.html)
|
||||
|
||||
## v0.7.2
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
`webhook` structure adds `enabled` field, existing configurations need to be re-enabled and saved on the page.
|
||||
|
||||
### Changes
|
||||
|
||||
- fix: Worker adds `NO_LIMIT_SEND_ROLE` configuration, loading failure issue
|
||||
- feat: Worker adds `# ADDRESS_REGEX = "[^a-z.0-9]"` configuration, regex for replacing illegal symbols, if not set, defaults to [^a-z0-9], use with caution, some symbols may cause receiving issues
|
||||
- feat: Worker optimizes webhook logic, supports admin configuring global webhook, adds `message pusher` integration example
|
||||
|
||||
## v0.7.1
|
||||
|
||||
- fix: Fix user role loading failure issue
|
||||
- feat: Admin account settings adds source email address blacklist configuration
|
||||
|
||||
## v0.7.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
DB changes: Add user `passkey` table, need to execute `db/2024-08-10-patch.sql` to update `D1` database
|
||||
|
||||
### Changes
|
||||
|
||||
- Docs: Update new-address-api.md (#360)
|
||||
- feat: Worker adds `ADMIN_USER_ROLE` configuration, for configuring admin user role, users with this role can access admin management page (#363)
|
||||
- feat: Worker adds `DISABLE_SHOW_GITHUB` configuration, for configuring whether to show github link
|
||||
- feat: Worker adds `NO_LIMIT_SEND_ROLE` configuration, for configuring roles that can send unlimited emails
|
||||
- feat: User adds `passkey` login method, for user login, no password required
|
||||
- feat: Worker adds `DISABLE_ADMIN_PASSWORD_CHECK` configuration, for configuring whether to disable admin console password check, if your site is only privately accessible, you can disable the check
|
||||
|
||||
## v0.6.1
|
||||
|
||||
- pages github actions && fix cleanup emails days 0 not taking effect by @tqjason (#355)
|
||||
- fix: imap proxy server doesn't support password by @dreamhunter2333 (#356)
|
||||
- worker adds `ANNOUNCEMENT` configuration, for configuring announcement info by @dreamhunter2333 (#357)
|
||||
- fix: telegram bot create new address defaults to first domain by @dreamhunter2333 (#358)
|
||||
|
||||
## v0.6.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
DB changes: Add user role table, need to execute `db/2024-07-14-patch.sql` to update `D1` database
|
||||
|
||||
### Changes
|
||||
|
||||
Worker configuration file adds `DEFAULT_DOMAINS`, `USER_ROLES`, `USER_DEFAULT_ROLE`, see documentation [worker configuration](https://temp-mail-docs.awsl.uk/en/guide/cli/worker.html)
|
||||
|
||||
- Remove `apiV1` related code and related database tables
|
||||
- Update `admin/statistics` api, add user statistics info
|
||||
- Update address rules, only allow lowercase+numbers, for historical addresses `lowercase` processing will be performed when querying emails
|
||||
- Add user role feature, `admin` can set user roles (currently can configure domain and prefix for each role)
|
||||
- Admin page search optimization, enter key auto search, input content auto trim
|
||||
|
||||
## v0.5.4
|
||||
|
||||
- Click logo 5 times to enter admin page
|
||||
- Fix 401 cannot redirect to login page (admin and site authentication)
|
||||
|
||||
## v0.5.3
|
||||
|
||||
- Fix some bugs in smtp imap proxy server
|
||||
- Improve user/admin delete inbox/outbox functionality
|
||||
- Admin can delete send permission records
|
||||
- Add Chinese email alias configuration `DOMAIN_LABELS` [documentation](https://temp-mail-docs.awsl.uk/en/guide/cli/worker.html)
|
||||
- Remove `mail channels` related code
|
||||
- github actions adds `FRONTEND_BRANCH` variable to specify deployment branch (#324)
|
||||
|
||||
## v0.5.1
|
||||
|
||||
- Add `mail-parser-wasm-worker` for worker email parsing, [documentation](https://temp-mail-docs.awsl.uk/en/guide/feature/mail_parser_wasm_worker.html)
|
||||
- Add user email length validation configuration `MIN_ADDRESS_LEN` and `MAX_ADDRESS_LEN`
|
||||
- Fix `pages function` not forwarding `telegram` api issue
|
||||
|
||||
## v0.5.0
|
||||
|
||||
- UI: Add local cache for address management
|
||||
- worker: Add `FORWARD_ADDRESS_LIST` global email forwarding address (equivalent to `catch all`)
|
||||
- UI: Multi-language uses routing for switching
|
||||
- Add save attachments to S3 feature
|
||||
- UI: Add received email list `batch delete` and `batch download`
|
||||
|
||||
## v0.4.6
|
||||
|
||||
- Worker configuration file adds `TITLE = "Custom Title"`, can customize website title
|
||||
- Fix KV not bound unable to delete address issue
|
||||
|
||||
## v0.4.5
|
||||
|
||||
- UI lazy load
|
||||
- telegram bot adds user global push feature (admin users)
|
||||
- Add support for cloudflare verified user sending emails
|
||||
- Add using `resend` to send emails, `resend` provides http and smtp api, easier to use, documentation: https://temp-mail-docs.awsl.uk/en/guide/config-send-mail.html
|
||||
|
||||
## v0.4.4
|
||||
|
||||
- Add telegram mini app
|
||||
- telegram bot adds `unbind`, `delete` commands
|
||||
- Fix webhook multiline text issue
|
||||
|
||||
## v0.4.3
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
Configuration file `main = "src/worker.js"` changed to `main = "src/worker.ts"`
|
||||
|
||||
### Changes
|
||||
|
||||
- `telegram bot` whitelist configuration
|
||||
- `ENABLE_WEBHOOK` add webhook
|
||||
- UI: admin page uses two-level tabs
|
||||
- UI: can directly switch addresses on homepage after login
|
||||
- UI: outbox also uses split view display (similar to inbox)
|
||||
- `SMTP IMAP Proxy` add outbox viewing
|
||||
|
||||
* feat: telegram bot TelegramSettings && webhook by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/244
|
||||
* fix build by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/245
|
||||
* feat: UI changes by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/247
|
||||
* feat: SMTP IMAP Proxy: add sendbox && UI: sendbox use split view by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/248
|
||||
|
||||
## v0.4.2
|
||||
|
||||
- Fix some bugs in smtp imap proxy server
|
||||
- Fix UI interface text errors, interface adds version number
|
||||
- Add telegram bot documentation https://temp-mail-docs.awsl.uk/en/guide/feature/telegram.html
|
||||
|
||||
* fix: imap server by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/227
|
||||
* fix: Maintenance wrong label by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/229
|
||||
* feat: add version for frontend && backend by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/230
|
||||
* feat: add page functions proxy to make response faster by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/234
|
||||
* feat: add about page by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/235
|
||||
* feat: remove mailV1Alert && fix mobile showSideMargin by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/236
|
||||
* feat: telegram bot by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/238
|
||||
* fix: remove cleanup address due to many table need to be clean by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/240
|
||||
* feat: docs: Telegram Bot by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/241
|
||||
* fix: smtp_proxy: cannot decode 8bit && tg bot new random address by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/242
|
||||
* fix: smtp_proxy: update raise imap4.NoSuchMailbox by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/243
|
||||
|
||||
### v0.4.1
|
||||
|
||||
- Username limited to max 30 characters
|
||||
- Fix `/external/api/send_mail` not returning bug (#222)
|
||||
- Add `IMAP proxy` service, support `IMAP` viewing emails
|
||||
- UI interface adds version number display
|
||||
|
||||
* feat: use common function handleListQuery when query by page by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/220
|
||||
* fix: typos by @lwd-temp in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/221
|
||||
* fix: name max 30 && /external/api/send_mail not return result by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/222
|
||||
* fix: smtp_proxy_server support decode from mail charset by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/223
|
||||
* feat: add imap proxy server by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/225
|
||||
* feat: UI show version by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/226
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @lwd-temp made their first contribution in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/221
|
||||
|
||||
## v0.4.0
|
||||
|
||||
### DB Changes/Breaking changes
|
||||
|
||||
Added user related tables for storing user information
|
||||
|
||||
- `db/2024-05-08-patch.sql`
|
||||
|
||||
### config changes
|
||||
|
||||
Enable user registration email verification requires `KV`
|
||||
|
||||
```toml
|
||||
# kv config for send email verification code
|
||||
# [[kv_namespaces]]
|
||||
# binding = "KV"
|
||||
# id = "xxxx"
|
||||
```
|
||||
|
||||
### function changes
|
||||
|
||||
- Add user registration feature, can bind email addresses, automatically obtain email JWT credentials after binding
|
||||
- Add default text display for emails, text and HTML email display mode switch button
|
||||
- Fix `BUG` randomly generated email names are invalid #211
|
||||
- `admin` email page supports email content search #210
|
||||
- Fix bug where emails weren't deleted when deleting addresses #213
|
||||
- UI adds global tab position configuration, side margin configuration
|
||||
|
||||
* feat: update docs by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/204
|
||||
* feat: add Deploy to Cloudflare Workers button by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/205
|
||||
* feat: add Deploy to Cloudflare Workers docs by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/206
|
||||
* feat: add UserLogin by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/209
|
||||
* feat: admin search mailbox && fix generateName multi dot && user jwt exp in 30 days && UI globalTabplacement && useSideMargin by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/214
|
||||
* feat: UI check openSettings in Login page by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/215
|
||||
* feat: UI move AdminContact to common by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/217
|
||||
* feat: docs by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/218
|
||||
|
||||
## v0.3.3
|
||||
|
||||
- Fix Admin delete email error
|
||||
- UI: Reply email button, quote original email text #186
|
||||
- Add send email address blacklist
|
||||
- Add `CF Turnstile` CAPTCHA configuration
|
||||
- Add `/external/api/send_mail` send email api, use body verification #194
|
||||
|
||||
## v0.3.2
|
||||
|
||||
## What's Changed
|
||||
|
||||
- UI: Add reply email button
|
||||
- Add scheduled cleanup feature, configurable in admin page (need to enable scheduled task in config file)
|
||||
- Fix delete account no response issue
|
||||
|
||||
* feat: UI: MailBox add reply button by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/187
|
||||
* feat: add cron auto clean up by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/189
|
||||
* fix: delete account by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/190
|
||||
|
||||
## v0.3.1
|
||||
|
||||
### DB Changes
|
||||
|
||||
Added `settings` table for storing general configuration information
|
||||
|
||||
- `db/2024-05-01-patch.sql`
|
||||
|
||||
### Changes
|
||||
|
||||
- `ENABLE_USER_CREATE_EMAIL` whether to allow users to create emails
|
||||
- Allow admin to create emails without prefix
|
||||
- Add `SMTP proxy server`, support SMTP sending emails
|
||||
- Fix some cases where browsers can't load `wasm` use js to parse emails
|
||||
- Footer adds `COPYRIGHT`
|
||||
- UI allows users to switch email display mode `v-html` / `iframe`
|
||||
- Add `admin` account configuration page, support configuring user registration name blacklist
|
||||
|
||||
* feat: support admin create address && add ENABLE_USER_CREATE_EMAIL co… by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/175
|
||||
* feat: add SMTP proxy server by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/177
|
||||
* fix: cf ui var is string by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/178
|
||||
* fix: UI mailbox 100vh to 80vh by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/179
|
||||
* fix: smtp_proxy_server hostname && add docker image for linux/arm64 by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/180
|
||||
* fix: some browser do not support wasm by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/182
|
||||
* feat: add COPYRIGHT by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/183
|
||||
* feat: UI: add user page: useIframeShowMail && mailboxSplitSize by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/184
|
||||
* feat: add address_block_list for new address by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/185
|
||||
|
||||
## v0.3.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
The prefix of the `address` table will migrate from code to db, please replace `tmp` in the sql below with your prefix, then execute.
|
||||
If your data is important, please backup your database first.
|
||||
|
||||
**Note: Replace prefix**
|
||||
|
||||
```sql
|
||||
update
|
||||
address
|
||||
set
|
||||
name = 'tmp' || name;
|
||||
```
|
||||
|
||||
### Changes
|
||||
|
||||
- Migrate the prefix of the `address` table from code to db
|
||||
- `admin` account page adds send/receive email counts
|
||||
- `admin` outbox page defaults to show all
|
||||
- `admin` send permission page supports search by address
|
||||
- `admin` email page uses split view UI
|
||||
|
||||
* feat: remove PREFIX logic in db by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/171
|
||||
* feat: admin page add account mail count && sendbox default all && sen… by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/172
|
||||
* feat: all mail use MailBox Component by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/173
|
||||
|
||||
**Full Changelog**: https://github.com/dreamhunter2333/cloudflare_temp_email/compare/0.2.10...v0.3.0
|
||||
|
||||
## v0.2.10
|
||||
|
||||
- `ENABLE_USER_DELETE_EMAIL` whether to allow users to delete account and emails
|
||||
- `ENABLE_AUTO_REPLY` whether to enable auto reply
|
||||
- fetchAddressError prompt improvement
|
||||
- Auto refresh shows countdown
|
||||
|
||||
* feat: docs update by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/165
|
||||
* feat: add ENABLE_USER_DELETE_EMAIL && ENABLE_AUTO_REPLY && modify fetchAddressError i18n && UI: show autoRefreshInterval by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/169
|
||||
|
||||
## v0.2.9
|
||||
|
||||
- Add rich text editor
|
||||
- Admin contact info, won't show if not configured, can configure any string `ADMIN_CONTACT = "xx@xx.xxx"`
|
||||
- Default send email balance, if not set, will be 0 `DEFAULT_SEND_BALANCE = 1`
|
||||
|
||||
## v0.2.8
|
||||
|
||||
- Allow users to delete emails
|
||||
- Admin notifies user by email when modifying send permissions
|
||||
- Send permission defaults to 1
|
||||
- Add RATE_LIMITER rate limiting for sending emails and creating new addresses
|
||||
- Some bug fixes
|
||||
|
||||
- feat: allow user delete mail && notify when send access changed by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/132
|
||||
- feat: request_send_mail_access default 1 balance by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/143
|
||||
- fix: RATE_LIMITER not call jwt by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/146
|
||||
- fix: delete_address not delete address_sender by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/153
|
||||
- fix: send_balance not update when click sendmail by @dreamhunter2333 in https://github.com/dreamhunter2333/cloudflare_temp_email/pull/155
|
||||
|
||||
## v0.2.7
|
||||
|
||||
- Added user interface installation documentation
|
||||
- Support email DKIM
|
||||
- Rate limiting configuration for `/api/new_address`
|
||||
|
||||
## v0.2.6
|
||||
|
||||
- Added admin query outbox page
|
||||
- Add admin data cleaning page
|
||||
|
||||
## 2024-04-12 v0.2.5
|
||||
|
||||
- Support send email
|
||||
|
||||
DB changes:
|
||||
|
||||
- `db/2024-04-12-patch.sql`
|
||||
|
||||
## 2024-04-10 v0.2.0
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- remove `ENABLE_ATTACHMENT` config
|
||||
- use rust wasm to parse email in frontend
|
||||
- deprecated api moved to `/api/v1`
|
||||
|
||||
### Rust Mail Parser
|
||||
|
||||
Due to some problems with nodejs' email parsing library, this version switches to using rust wasm to call rust's mail parsing library.
|
||||
|
||||
- Faster speed, good attachment support, can display attachment images of emails
|
||||
- Parsing supports more rfc specifications
|
||||
|
||||
### DB changes
|
||||
|
||||
The `mails` table will be discarded, and the `raw` text of the new `mail` will be directly stored in the `raw_mails` table
|
||||
|
||||
## Upgrade Step
|
||||
|
||||
```bash
|
||||
git checkout v0.2.0
|
||||
cd worker
|
||||
wrangler d1 execute dev --file=../db/2024-04-09-patch.sql --remote
|
||||
pnpm run deploy
|
||||
cd ../frontend
|
||||
pnpm run deploy
|
||||
```
|
||||
|
||||
Note: For historical messages, use the Deploy New web page to view old data.
|
||||
|
||||
```bash
|
||||
git checkout feature/backup
|
||||
cd frontend
|
||||
# Create a new pages for accessing old data
|
||||
pnpm run deploy --project-name temp-email-v1
|
||||
```
|
||||
|
||||
## 2024-04-09 v0.0.0
|
||||
|
||||
release v0.0.0
|
||||
|
||||
## 2024-04-03
|
||||
|
||||
DB changes
|
||||
|
||||
- `db/2024-04-03-patch.sql`
|
||||
|
||||
Changes:
|
||||
|
||||
- add delete account
|
||||
- add admin panel search
|
||||
|
||||
## 2024-01-13
|
||||
|
||||
DB changes
|
||||
|
||||
- `db/2024-01-13-patch.sql`
|
||||
11
README.md
11
README.md
@@ -108,8 +108,9 @@
|
||||
### 📧 邮件处理
|
||||
|
||||
- [x] 使用 `rust wasm` 解析邮件,解析速度快,几乎所有邮件都能解析,node 的解析模块解析邮件失败的邮件,rust wasm 也能解析成功
|
||||
- [x] **AI 邮件识别** - 使用 Cloudflare Workers AI 自动提取邮件中的验证码、认证链接、服务链接等重要信息
|
||||
- [x] 支持发送邮件,支持 `DKIM` 验证
|
||||
- [x] 支持 `SMTP` 和 `Resend` 等多种发送方式
|
||||
- [x] 支持 `SMTP` 和 `Resend` 等多种发送方式
|
||||
- [x] 增加查看 `附件` 功能,支持附件图片显示
|
||||
- [x] 支持 S3 附件存储和删除功能
|
||||
- [x] 垃圾邮件检测和黑白名单配置
|
||||
@@ -183,6 +184,14 @@
|
||||
|
||||
</details>
|
||||
|
||||
### 提醒
|
||||
|
||||
- 在Resend添加域名记录时,如果您域名解析服务商正在托管您的3级域名a.b.com,请删除Resend生成的默认name中二级域名前缀b,否则将会添加a.b.b.com,导致验证失败。添加记录后,可通过
|
||||
```bash
|
||||
nslookup -qt="mx" a.b.com 1.1.1.1
|
||||
```
|
||||
进行验证。
|
||||
|
||||
## 🌟 加入社区
|
||||
|
||||
- [Telegram](https://t.me/cloudflare_temp_email)
|
||||
|
||||
216
README_EN.md
216
README_EN.md
@@ -1,46 +1,196 @@
|
||||
<!-- markdownlint-disable-file MD033 MD045 -->
|
||||
# Cloudflare Temp Email
|
||||
# Cloudflare Temp Email - Free Temporary Email Service
|
||||
|
||||
<p align="center">
|
||||
<a href="README.md">🇨🇳 中文</a> |
|
||||
<a href="README_EN.md">🇺🇸 English</a>
|
||||
</p>
|
||||
|
||||
**A fully-featured temporary email service built on Cloudflare's free services.**
|
||||
|
||||
> This project is for learning and personal use only.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
- [📖 Documentation](https://temp-mail-docs.awsl.uk/en/)
|
||||
- [🎯 Live Demo](https://mail.awsl.uk/)
|
||||
- [📝 CHANGELOG](CHANGELOG.md)
|
||||
|
||||
<p align="center">
|
||||
<a href="https://temp-mail-docs.awsl.uk/en/guide/actions/github-action.html">
|
||||
<img src="https://deploy.workers.cloudflare.com/button" alt="Deploy to Cloudflare Workers">
|
||||
<a href="https://temp-mail-docs.awsl.uk" target="_blank">
|
||||
<img alt="docs" src="https://img.shields.io/badge/docs-grey?logo=vitepress">
|
||||
</a>
|
||||
<a href="https://github.com/dreamhunter2333/cloudflare_temp_email/releases/latest" target="_blank">
|
||||
<img src="https://img.shields.io/github/v/release/dreamhunter2333/cloudflare_temp_email">
|
||||
</a>
|
||||
<a href="https://github.com/dreamhunter2333/cloudflare_temp_email/blob/main/LICENSE" target="_blank">
|
||||
<img alt="MIT License" src="https://img.shields.io/github/license/dreamhunter2333/cloudflare_temp_email">
|
||||
</a>
|
||||
<a href="https://github.com/dreamhunter2333/cloudflare_temp_email/graphs/contributors" target="_blank">
|
||||
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/dreamhunter2333/cloudflare_temp_email">
|
||||
</a>
|
||||
<a href="">
|
||||
<img alt="GitHub top language" src="https://img.shields.io/github/languages/top/dreamhunter2333/cloudflare_temp_email">
|
||||
</a>
|
||||
<a href="">
|
||||
<img src="https://img.shields.io/github/last-commit/dreamhunter2333/cloudflare_temp_email">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## ✨ Key Features
|
||||
<p align="center">
|
||||
<a href="https://hellogithub.com/repository/2ccc64bb1ba346b480625f584aa19eb1" target="_blank">
|
||||
<img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=2ccc64bb1ba346b480625f584aa19eb1&claim_uid=FxNypXK7UQ9OECT" alt="Featured|HelloGitHub" height="30"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
- **<2A> Email Processing**: Rust WASM parser, SMTP/IMAP support, attachments, auto-reply
|
||||
- **👥 User Management**: OAuth2 login, Passkey authentication, role management
|
||||
- **🌐 Admin Panel**: Complete admin console, user management, scheduled cleanup
|
||||
- **🤖 Integrations**: Telegram Bot, webhooks, CAPTCHA, rate limiting
|
||||
- **<2A> Modern UI**: Multi-language, responsive design, JWT auto-login
|
||||
<p align="center">
|
||||
<a href="README.md">🇨🇳 中文文档</a> |
|
||||
<a href="README_EN.md">🇺🇸 English Document</a>
|
||||
</p>
|
||||
|
||||
## 🏗️ Tech Stack
|
||||
> This project is for learning and personal use only. Please do not use it for any illegal activities, or you will be responsible for the consequences.
|
||||
|
||||
- **Frontend**: Vue 3 + TypeScript + Vite
|
||||
- **Backend**: Cloudflare Workers + D1 Database
|
||||
- **Email**: Cloudflare Email Routing + Rust WASM Parser
|
||||
**🎉 A fully-featured temporary email service!**
|
||||
|
||||
- 🆓 **Completely Free** - Built on Cloudflare's free services with zero cost
|
||||
- ⚡ **High Performance** - Rust WASM email parsing for extremely fast response
|
||||
- 🎨 **Modern UI** - Responsive design with multi-language support and easy operation
|
||||
- 🔐 **Address Password** - Support setting individual passwords for email addresses to enhance security (enabled via `ENABLE_ADDRESS_PASSWORD`)
|
||||
|
||||
## 📚 Deployment Documentation - Quick Start
|
||||
|
||||
[📖 Documentation](https://temp-mail-docs.awsl.uk) | [🚀 Github Action Deployment Guide](https://temp-mail-docs.awsl.uk/en/guide/actions/github-action.html)
|
||||
|
||||
<a href="https://temp-mail-docs.awsl.uk/en/guide/actions/github-action.html">
|
||||
<img src="https://deploy.workers.cloudflare.com/button" alt="Deploy to Cloudflare Workers" height="32">
|
||||
</a>
|
||||
|
||||
## 📝 Changelog
|
||||
|
||||
See [CHANGELOG](CHANGELOG.md) for the latest updates.
|
||||
|
||||
## 🎯 Live Demo
|
||||
|
||||
Try it now → [https://mail.awsl.uk/](https://mail.awsl.uk/)
|
||||
|
||||
<details>
|
||||
<summary>📊 Service Status Monitoring (Click to expand/collapse)</summary>
|
||||
|
||||
| | |
|
||||
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| [Backend](https://temp-email-api.awsl.uk/) | [](https://github.com/dreamhunter2333/cloudflare_temp_email/actions/workflows/backend_deploy.yaml)       |
|
||||
| [Frontend](https://mail.awsl.uk/) | [](https://github.com/dreamhunter2333/cloudflare_temp_email/actions/workflows/frontend_deploy.yaml)       |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>⭐ Star History (Click to expand/collapse)</summary>
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=dreamhunter2333/cloudflare_temp_email&type=Date&theme=dark" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=dreamhunter2333/cloudflare_temp_email&type=Date" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=dreamhunter2333/cloudflare_temp_email&type=Date" />
|
||||
</picture>
|
||||
|
||||
</details>
|
||||
|
||||
<details open>
|
||||
<summary>📖 Table of Contents (Click to expand/collapse)</summary>
|
||||
|
||||
- [Cloudflare Temp Email - Free Temporary Email Service](#cloudflare-temp-email---free-temporary-email-service)
|
||||
- [📚 Deployment Documentation - Quick Start](#-deployment-documentation---quick-start)
|
||||
- [📝 Changelog](#-changelog)
|
||||
- [🎯 Live Demo](#-live-demo)
|
||||
- [✨ Core Features](#-core-features)
|
||||
- [📧 Email Processing](#-email-processing)
|
||||
- [👥 User Management](#-user-management)
|
||||
- [🔧 Admin Features](#-admin-features)
|
||||
- [🌐 Multi-language \& Interface](#-multi-language--interface)
|
||||
- [🤖 Integration \& Extensions](#-integration--extensions)
|
||||
- [🏗️ Technical Architecture](#️-technical-architecture)
|
||||
- [🏛️ System Architecture](#️-system-architecture)
|
||||
- [🛠️ Tech Stack](#️-tech-stack)
|
||||
- [📦 Main Components](#-main-components)
|
||||
- [🌟 Join the Community](#-join-the-community)
|
||||
|
||||
</details>
|
||||
|
||||
## ✨ Core Features
|
||||
|
||||
<details open>
|
||||
<summary>✨ Core Features Details (Click to expand/collapse)</summary>
|
||||
|
||||
### 📧 Email Processing
|
||||
|
||||
- [x] Use `rust wasm` to parse emails, with fast parsing speed. Almost all emails can be parsed. Even emails that Node.js parsing modules fail to parse can be successfully parsed by rust wasm
|
||||
- [x] **AI Email Recognition** - Use Cloudflare Workers AI to automatically extract verification codes, authentication links, service links and other important information from emails
|
||||
- [x] Support sending emails with `DKIM` verification
|
||||
- [x] Support multiple sending methods such as `SMTP` and `Resend`
|
||||
- [x] Add attachment viewing feature with support for displaying attachment images
|
||||
- [x] Support S3 attachment storage and deletion
|
||||
- [x] Spam detection and blacklist/whitelist configuration
|
||||
- [x] Email forwarding feature with global forwarding address support
|
||||
|
||||
### 👥 User Management
|
||||
|
||||
- [x] Use `credentials` to log in to previously used mailboxes
|
||||
- [x] Add complete user registration and login functionality. Users can bind email addresses and automatically obtain email JWT credentials to switch between different mailboxes after binding
|
||||
- [x] Support `OAuth2` third-party login (Github, Authentik, etc.)
|
||||
- [x] Support `Passkey` passwordless login
|
||||
- [x] User role management with support for multi-role domain and prefix configuration
|
||||
- [x] User inbox viewing with address and keyword filtering support
|
||||
|
||||
### 🔧 Admin Features
|
||||
|
||||
- [x] Complete admin console
|
||||
- [x] Create mailboxes without prefix in `admin` backend
|
||||
- [x] Admin user management page with user address viewing feature
|
||||
- [x] Scheduled cleanup function with support for multiple cleanup strategies
|
||||
- [x] Get mailboxes with custom names, `admin` can configure blacklist
|
||||
- [x] Add access password for use as a private site
|
||||
|
||||
### 🌐 Multi-language & Interface
|
||||
|
||||
- [x] Both frontend and backend support multi-language
|
||||
- [x] Modern UI design with responsive layout
|
||||
- [x] Google Ads integration support
|
||||
- [x] Use shadow DOM to prevent style pollution
|
||||
- [x] Support URL JWT parameter auto-login
|
||||
|
||||
### 🤖 Integration & Extensions
|
||||
|
||||
- [x] Complete `Telegram Bot` support, `Telegram` push notifications, and Telegram Bot mini app
|
||||
- [x] Add `SMTP proxy server` supporting `SMTP` for sending emails and `IMAP` for viewing emails
|
||||
- [x] Webhook support and message push integration
|
||||
- [x] Support `CF Turnstile` CAPTCHA verification
|
||||
- [x] Rate limiting configuration to prevent abuse
|
||||
|
||||
</details>
|
||||
|
||||
## 🏗️ Technical Architecture
|
||||
|
||||
<details>
|
||||
<summary>🏗️ Technical Architecture Details (Click to expand/collapse)</summary>
|
||||
|
||||
### 🏛️ System Architecture
|
||||
|
||||
- **Database**: Cloudflare D1 as the main database
|
||||
- **Frontend Deployment**: Deploy frontend using Cloudflare Pages
|
||||
- **Backend Deployment**: Deploy backend using Cloudflare Workers
|
||||
- **Email Routing**: Use Cloudflare Email Routing
|
||||
|
||||
### 🛠️ Tech Stack
|
||||
|
||||
- **Frontend**: Vue 3 + Vite + TypeScript
|
||||
- **Backend**: TypeScript + Cloudflare Workers
|
||||
- **Email Parsing**: Rust WASM (mail-parser-wasm)
|
||||
- **Database**: Cloudflare D1 (SQLite)
|
||||
- **Storage**: Cloudflare KV + R2 (optional S3)
|
||||
- **Proxy Service**: Python SMTP/IMAP Proxy Server
|
||||
|
||||
## 🌟 Community
|
||||
### 📦 Main Components
|
||||
|
||||
- **Worker**: Core backend service
|
||||
- **Frontend**: Vue 3 user interface
|
||||
- **Mail Parser WASM**: Rust email parsing module
|
||||
- **SMTP Proxy Server**: Python email proxy service
|
||||
- **Pages Functions**: Cloudflare Pages middleware
|
||||
- **Documentation**: VitePress documentation site
|
||||
|
||||
</details>
|
||||
|
||||
### Important Notes
|
||||
|
||||
- When adding domain records in Resend, if your DNS provider is hosting your 3rd level domain a.b.com, please remove the 2nd level domain prefix b from the default name generated by Resend, otherwise it will add a.b.b.com, causing verification to fail. After adding the record, you can verify it using:
|
||||
```bash
|
||||
nslookup -qt="mx" a.b.com 1.1.1.1
|
||||
```
|
||||
|
||||
## 🌟 Join the Community
|
||||
|
||||
- [Telegram](https://t.me/cloudflare_temp_email)
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
4
db/2025-12-06-metadata.sql
Normal file
4
db/2025-12-06-metadata.sql
Normal file
@@ -0,0 +1,4 @@
|
||||
-- Add metadata column to raw_mails table for storing AI extraction results and other metadata
|
||||
-- This column stores JSON data with flexible schema for various analysis results
|
||||
|
||||
ALTER TABLE raw_mails ADD COLUMN metadata TEXT;
|
||||
4
db/2025-12-15-message-id-index.sql
Normal file
4
db/2025-12-15-message-id-index.sql
Normal file
@@ -0,0 +1,4 @@
|
||||
-- Add index on message_id column in raw_mails table
|
||||
-- This index improves performance for queries filtering/updating by message_id
|
||||
-- Example: UPDATE raw_mails SET metadata = ? WHERE message_id = ?
|
||||
CREATE INDEX IF NOT EXISTS idx_raw_mails_message_id ON raw_mails(message_id);
|
||||
8
db/2025-12-27-source-meta.sql
Normal file
8
db/2025-12-27-source-meta.sql
Normal file
@@ -0,0 +1,8 @@
|
||||
-- Add source_meta column to address table for tracking address creation source
|
||||
-- For web: stores IP address (e.g., "192.168.1.1") or "web:unknown" as fallback
|
||||
-- For telegram: stores "tg:{userId}" (e.g., "tg:123456789")
|
||||
-- For admin: stores "admin"
|
||||
|
||||
ALTER TABLE address ADD COLUMN source_meta TEXT;
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_address_source_meta ON address(source_meta);
|
||||
@@ -4,6 +4,7 @@ CREATE TABLE IF NOT EXISTS raw_mails (
|
||||
source TEXT,
|
||||
address TEXT,
|
||||
raw TEXT,
|
||||
metadata TEXT,
|
||||
created_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
|
||||
@@ -11,10 +12,13 @@ CREATE INDEX IF NOT EXISTS idx_raw_mails_address ON raw_mails(address);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_raw_mails_created_at ON raw_mails(created_at);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_raw_mails_message_id ON raw_mails(message_id);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS address (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name TEXT UNIQUE,
|
||||
password TEXT,
|
||||
source_meta TEXT,
|
||||
created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
|
||||
updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
@@ -25,6 +29,8 @@ CREATE INDEX IF NOT EXISTS idx_address_created_at ON address(created_at);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_address_updated_at ON address(updated_at);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_address_source_meta ON address(source_meta);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS auto_reply_mails (
|
||||
id INTEGER PRIMARY KEY,
|
||||
source_prefix TEXT,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "cloudflare_temp_email",
|
||||
"version": "1.0.6",
|
||||
"version": "1.2.1",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
@@ -20,35 +20,36 @@
|
||||
"deploy:actions": "npm run build && wrangler pages deploy ./dist"
|
||||
},
|
||||
"dependencies": {
|
||||
"@fingerprintjs/fingerprintjs": "^5.0.1",
|
||||
"@simplewebauthn/browser": "10.0.0",
|
||||
"@unhead/vue": "^1.11.20",
|
||||
"@vueuse/core": "^12.8.2",
|
||||
"@unhead/vue": "^2.1.2",
|
||||
"@vueuse/core": "^14.1.0",
|
||||
"@wangeditor/editor": "^5.1.23",
|
||||
"@wangeditor/editor-for-vue": "^5.1.12",
|
||||
"axios": "^1.12.2",
|
||||
"axios": "^1.13.2",
|
||||
"jszip": "^3.10.1",
|
||||
"mail-parser-wasm": "^0.2.1",
|
||||
"naive-ui": "^2.43.1",
|
||||
"postal-mime": "^2.5.0",
|
||||
"naive-ui": "^2.43.2",
|
||||
"postal-mime": "^2.7.3",
|
||||
"vooks": "^0.2.12",
|
||||
"vue": "^3.5.22",
|
||||
"vue": "^3.5.27",
|
||||
"vue-clipboard3": "^2.0.0",
|
||||
"vue-i18n": "^11.1.12",
|
||||
"vue-router": "^4.5.1"
|
||||
"vue-i18n": "^11.2.8",
|
||||
"vue-router": "^4.6.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@vicons/fa": "^0.13.0",
|
||||
"@vicons/material": "^0.13.0",
|
||||
"@vitejs/plugin-vue": "^5.2.4",
|
||||
"unplugin-auto-import": "^19.3.0",
|
||||
"unplugin-vue-components": "^28.8.0",
|
||||
"vite": "^6.3.6",
|
||||
"vite-plugin-pwa": "^1.0.3",
|
||||
"@vitejs/plugin-vue": "^6.0.3",
|
||||
"unplugin-auto-import": "^20.3.0",
|
||||
"unplugin-vue-components": "^30.0.0",
|
||||
"vite": "^7.3.1",
|
||||
"vite-plugin-pwa": "^1.2.0",
|
||||
"vite-plugin-top-level-await": "^1.6.0",
|
||||
"vite-plugin-wasm": "^3.5.0",
|
||||
"workbox-build": "^7.3.0",
|
||||
"workbox-window": "^7.3.0",
|
||||
"wrangler": "^4.42.2"
|
||||
"workbox-build": "^7.4.0",
|
||||
"workbox-window": "^7.4.0",
|
||||
"wrangler": "^4.59.2"
|
||||
},
|
||||
"packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39"
|
||||
}
|
||||
|
||||
3509
frontend/pnpm-lock.yaml
generated
3509
frontend/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -22,8 +22,16 @@ const showSideMargin = computed(() => !isMobile.value && useSideMargin.value);
|
||||
const showAd = computed(() => !isMobile.value && adClient && adSlot);
|
||||
const gridMaxCols = computed(() => showAd.value ? 8 : 12);
|
||||
|
||||
onMounted(async () => {
|
||||
// Load Google Ad script at top level (not inside onMounted)
|
||||
if (showAd.value) {
|
||||
useScript({
|
||||
src: `https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=${adClient}`,
|
||||
async: true,
|
||||
crossorigin: "anonymous",
|
||||
})
|
||||
}
|
||||
|
||||
onMounted(async () => {
|
||||
try {
|
||||
await api.getUserSettings();
|
||||
} catch (error) {
|
||||
@@ -43,11 +51,6 @@ onMounted(async () => {
|
||||
|
||||
// check if google ad is enabled
|
||||
if (showAd.value) {
|
||||
useScript({
|
||||
src: `https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=${adClient}`,
|
||||
async: true,
|
||||
crossorigin: "anonymous",
|
||||
});
|
||||
(window.adsbygoogle = window.adsbygoogle || []).push({});
|
||||
(window.adsbygoogle = window.adsbygoogle || []).push({});
|
||||
}
|
||||
|
||||
@@ -3,6 +3,7 @@ import { h } from 'vue'
|
||||
import axios from 'axios'
|
||||
|
||||
import i18n from '../i18n'
|
||||
import { getFingerprint } from '../utils/fingerprint'
|
||||
|
||||
const API_BASE = import.meta.env.VITE_API_BASE || "";
|
||||
const {
|
||||
@@ -20,6 +21,9 @@ const instance = axios.create({
|
||||
const apiFetch = async (path, options = {}) => {
|
||||
loading.value = true;
|
||||
try {
|
||||
// Get browser fingerprint for request tracking
|
||||
const fingerprint = await getFingerprint();
|
||||
|
||||
const response = await instance.request(path, {
|
||||
method: options.method || 'GET',
|
||||
data: options.body || null,
|
||||
@@ -29,6 +33,7 @@ const apiFetch = async (path, options = {}) => {
|
||||
'x-user-access-token': userSettings.value.access_token,
|
||||
'x-custom-auth': auth.value,
|
||||
'x-admin-auth': adminAuth.value,
|
||||
'x-fingerprint': fingerprint,
|
||||
'Authorization': `Bearer ${jwt.value}`,
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
@@ -36,7 +41,7 @@ const apiFetch = async (path, options = {}) => {
|
||||
if (response.status === 401 && path.startsWith("/admin")) {
|
||||
showAdminAuth.value = true;
|
||||
}
|
||||
if (response.status === 401 && openSettings.value.auth) {
|
||||
if (response.status === 401 && openSettings.value.needAuth) {
|
||||
showAuth.value = true;
|
||||
}
|
||||
if (response.status >= 300) {
|
||||
|
||||
260
frontend/src/components/AddressSelect.vue
Normal file
260
frontend/src/components/AddressSelect.vue
Normal file
@@ -0,0 +1,260 @@
|
||||
<script setup>
|
||||
import { onMounted, ref, watch } from 'vue'
|
||||
import { useLocalStorage } from '@vueuse/core'
|
||||
import { useI18n } from 'vue-i18n'
|
||||
import { useMessage } from 'naive-ui'
|
||||
import useClipboard from 'vue-clipboard3'
|
||||
import { Copy } from '@vicons/fa'
|
||||
|
||||
import { useGlobalState } from '../store'
|
||||
import { api } from '../api'
|
||||
|
||||
const props = defineProps({
|
||||
showCopy: {
|
||||
type: Boolean,
|
||||
default: true,
|
||||
},
|
||||
size: {
|
||||
type: String,
|
||||
default: 'small',
|
||||
},
|
||||
})
|
||||
|
||||
const message = useMessage()
|
||||
const { toClipboard } = useClipboard()
|
||||
|
||||
const {
|
||||
jwt, settings, userJwt, isTelegram, openSettings, telegramApp
|
||||
} = useGlobalState()
|
||||
|
||||
const { t } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
userAddresses: 'User Addresses',
|
||||
localAddresses: 'Local Addresses',
|
||||
address: 'Address',
|
||||
copy: 'Copy',
|
||||
copied: 'Copied',
|
||||
},
|
||||
zh: {
|
||||
userAddresses: '用户地址',
|
||||
localAddresses: '本地地址',
|
||||
address: '地址',
|
||||
copy: '复制',
|
||||
copied: '已复制',
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const addressOptions = ref([])
|
||||
const addressValue = ref(null)
|
||||
const addressLoading = ref(false)
|
||||
const localAddressCache = useLocalStorage("LocalAddressCache", [])
|
||||
const optionValueMap = new Map()
|
||||
|
||||
const formatAddressLabel = (address) => {
|
||||
if (!address) return address;
|
||||
const domain = address.split('@')[1]
|
||||
const domainLabel = openSettings.value.domains.find(
|
||||
d => d.value === domain
|
||||
)?.label;
|
||||
if (!domainLabel) return address;
|
||||
return address.replace('@' + domain, `@${domainLabel}`);
|
||||
}
|
||||
|
||||
const parseJwtAddress = (curJwt) => {
|
||||
try {
|
||||
const payload = JSON.parse(
|
||||
decodeURIComponent(
|
||||
atob(curJwt.split(".")[1]
|
||||
.replace(/-/g, "+").replace(/_/g, "/")
|
||||
)
|
||||
)
|
||||
);
|
||||
return payload.address;
|
||||
} catch (e) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
const getOptionValue = (key, scope, payload, address) => {
|
||||
if (optionValueMap.has(key)) {
|
||||
const cached = optionValueMap.get(key)
|
||||
cached.scope = scope
|
||||
cached.payload = payload
|
||||
cached.address = address
|
||||
return cached
|
||||
}
|
||||
const value = { key, scope, payload, address }
|
||||
optionValueMap.set(key, value)
|
||||
return value
|
||||
}
|
||||
|
||||
const buildLocalOptions = (excludeAddresses = new Set()) => {
|
||||
if (typeof jwt.value === 'string' && jwt.value && !localAddressCache.value.includes(jwt.value)) {
|
||||
localAddressCache.value.push(jwt.value)
|
||||
}
|
||||
const children = localAddressCache.value
|
||||
.map((curJwt) => {
|
||||
const address = parseJwtAddress(curJwt);
|
||||
if (!address) return null;
|
||||
if (excludeAddresses.has(address)) return null;
|
||||
const label = formatAddressLabel(address);
|
||||
const key = `local:${curJwt}`;
|
||||
const option = { label, value: getOptionValue(key, 'local', curJwt, address), address };
|
||||
if (settings.value.address && address === settings.value.address) {
|
||||
addressValue.value = option.value;
|
||||
}
|
||||
return option;
|
||||
})
|
||||
.filter(Boolean);
|
||||
return children;
|
||||
}
|
||||
|
||||
const buildUserOptions = async () => {
|
||||
const children = [];
|
||||
try {
|
||||
const { results } = await api.fetch(`/user_api/bind_address`);
|
||||
for (const row of results || []) {
|
||||
const address = row.address || row.name;
|
||||
if (!address) continue;
|
||||
const label = formatAddressLabel(address);
|
||||
const key = `user:${row.id}`;
|
||||
const option = { label, value: getOptionValue(key, 'user', String(row.id), address), address };
|
||||
if (settings.value.address && address === settings.value.address) {
|
||||
addressValue.value = option.value;
|
||||
}
|
||||
children.push(option);
|
||||
}
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
}
|
||||
return children;
|
||||
}
|
||||
|
||||
const buildTelegramOptions = async () => {
|
||||
const children = [];
|
||||
try {
|
||||
const data = await api.fetch(`/telegram/get_bind_address`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({
|
||||
initData: telegramApp.value.initData
|
||||
})
|
||||
});
|
||||
for (const row of data || []) {
|
||||
if (!row?.address || !row?.jwt) continue;
|
||||
const label = formatAddressLabel(row.address);
|
||||
const key = `tg:${row.jwt}`;
|
||||
const option = { label, value: getOptionValue(key, 'tg', row.jwt, row.address), address: row.address };
|
||||
if (settings.value.address && row.address === settings.value.address) {
|
||||
addressValue.value = option.value;
|
||||
}
|
||||
children.push(option);
|
||||
}
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
}
|
||||
return children;
|
||||
}
|
||||
|
||||
const refreshAddressOptions = async () => {
|
||||
addressLoading.value = true;
|
||||
addressValue.value = null;
|
||||
try {
|
||||
if (isTelegram.value) {
|
||||
const telegramChildren = await buildTelegramOptions();
|
||||
addressOptions.value = telegramChildren;
|
||||
return;
|
||||
}
|
||||
const groups = [];
|
||||
if (userJwt.value) {
|
||||
const userChildren = await buildUserOptions();
|
||||
if (userChildren.length > 0) {
|
||||
groups.push({ type: 'group', label: t('userAddresses'), children: userChildren });
|
||||
}
|
||||
const userAddressSet = new Set(userChildren.map((item) => item.address));
|
||||
const localChildren = buildLocalOptions(userAddressSet);
|
||||
if (localChildren.length > 0) {
|
||||
groups.push({ type: 'group', label: t('localAddresses'), children: localChildren });
|
||||
}
|
||||
} else {
|
||||
const localChildren = buildLocalOptions();
|
||||
if (localChildren.length > 0) {
|
||||
groups.push({ type: 'group', label: t('localAddresses'), children: localChildren });
|
||||
}
|
||||
}
|
||||
addressOptions.value = groups;
|
||||
} finally {
|
||||
addressLoading.value = false;
|
||||
}
|
||||
}
|
||||
|
||||
const onAddressChange = async (value) => {
|
||||
if (!value) return;
|
||||
if (value.scope === 'local' || value.scope === 'tg') {
|
||||
jwt.value = value.payload;
|
||||
location.reload();
|
||||
return;
|
||||
}
|
||||
if (value.scope === 'user') {
|
||||
try {
|
||||
const res = await api.fetch(`/user_api/bind_address_jwt/${value.payload}`);
|
||||
if (!res?.jwt) {
|
||||
message.error("jwt not found");
|
||||
return;
|
||||
}
|
||||
jwt.value = res.jwt;
|
||||
location.reload();
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const copy = async () => {
|
||||
try {
|
||||
await toClipboard(settings.value.address)
|
||||
message.success(t('copied'));
|
||||
} catch (e) {
|
||||
message.error(e.message || "error");
|
||||
}
|
||||
}
|
||||
|
||||
onMounted(async () => {
|
||||
await refreshAddressOptions();
|
||||
});
|
||||
|
||||
watch([userJwt, isTelegram, () => settings.value.address], async () => {
|
||||
await refreshAddressOptions();
|
||||
});
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<n-flex class="address-row" align="center" justify="center" :wrap="true">
|
||||
<n-select v-model:value="addressValue" :options="addressOptions" :size="size" filterable
|
||||
:loading="addressLoading" :placeholder="t('address')" @update:value="onAddressChange"
|
||||
class="address-select" />
|
||||
<slot name="actions" />
|
||||
<n-button v-if="showCopy" class="address-copy" @click="copy" :size="size" tertiary type="primary">
|
||||
<n-icon :component="Copy" /> {{ t('copy') }}
|
||||
</n-button>
|
||||
</n-flex>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.address-row {
|
||||
width: 100%;
|
||||
gap: 10px;
|
||||
}
|
||||
|
||||
.address-select {
|
||||
min-width: 220px;
|
||||
max-width: 420px;
|
||||
flex: 1 1 220px;
|
||||
}
|
||||
|
||||
.address-copy {
|
||||
flex: 0 0 auto;
|
||||
white-space: nowrap;
|
||||
}
|
||||
</style>
|
||||
176
frontend/src/components/AiExtractInfo.vue
Normal file
176
frontend/src/components/AiExtractInfo.vue
Normal file
@@ -0,0 +1,176 @@
|
||||
<script setup>
|
||||
import { computed } from 'vue';
|
||||
import { useI18n } from 'vue-i18n';
|
||||
import { ContentCopyOutlined, LinkRound, CodeRound } from '@vicons/material';
|
||||
import { useMessage } from 'naive-ui';
|
||||
import { useGlobalState } from '../store';
|
||||
|
||||
const message = useMessage();
|
||||
const { isDark } = useGlobalState();
|
||||
|
||||
// Dark mode: use Gmail's softer blue (#A8C7FA) for better readability
|
||||
const alertThemeOverrides = computed(() => {
|
||||
if (isDark.value) {
|
||||
return {
|
||||
colorSuccess: 'rgba(168, 199, 250, 0.15)',
|
||||
borderSuccess: '1px solid rgba(168, 199, 250, 0.3)',
|
||||
iconColorSuccess: '#A8C7FA',
|
||||
titleTextColorSuccess: '#A8C7FA',
|
||||
}
|
||||
}
|
||||
return {}
|
||||
});
|
||||
|
||||
const tagThemeOverrides = computed(() => {
|
||||
if (isDark.value) {
|
||||
return {
|
||||
colorSuccess: 'rgba(168, 199, 250, 0.15)',
|
||||
borderSuccess: '1px solid rgba(168, 199, 250, 0.3)',
|
||||
textColorSuccess: '#A8C7FA',
|
||||
}
|
||||
}
|
||||
return {}
|
||||
});
|
||||
|
||||
const { t } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
authCode: 'Verification Code',
|
||||
authLink: 'Authentication Link',
|
||||
serviceLink: 'Service Link',
|
||||
subscriptionLink: 'Subscription Link',
|
||||
otherLink: 'Other Link',
|
||||
copySuccess: 'Copied successfully',
|
||||
copyFailed: 'Copy failed',
|
||||
open: 'Open',
|
||||
},
|
||||
zh: {
|
||||
authCode: '验证码',
|
||||
authLink: '认证链接',
|
||||
serviceLink: '服务链接',
|
||||
subscriptionLink: '订阅链接',
|
||||
otherLink: '其他链接',
|
||||
copySuccess: '复制成功',
|
||||
copyFailed: '复制失败',
|
||||
open: '打开',
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const props = defineProps({
|
||||
metadata: {
|
||||
type: String,
|
||||
default: null
|
||||
},
|
||||
compact: {
|
||||
type: Boolean,
|
||||
default: false
|
||||
}
|
||||
});
|
||||
|
||||
const aiExtract = computed(() => {
|
||||
if (!props.metadata) return null;
|
||||
try {
|
||||
const data = JSON.parse(props.metadata);
|
||||
return data.ai_extract || null;
|
||||
} catch (e) {
|
||||
return null;
|
||||
}
|
||||
});
|
||||
|
||||
const typeLabel = computed(() => {
|
||||
if (!aiExtract.value) return '';
|
||||
const typeMap = {
|
||||
auth_code: t('authCode'),
|
||||
auth_link: t('authLink'),
|
||||
service_link: t('serviceLink'),
|
||||
subscription_link: t('subscriptionLink'),
|
||||
other_link: t('otherLink'),
|
||||
};
|
||||
return typeMap[aiExtract.value.type] || '';
|
||||
});
|
||||
|
||||
const typeIcon = computed(() => {
|
||||
if (!aiExtract.value) return null;
|
||||
const iconMap = {
|
||||
auth_code: CodeRound,
|
||||
auth_link: LinkRound,
|
||||
service_link: LinkRound,
|
||||
subscription_link: LinkRound,
|
||||
other_link: LinkRound,
|
||||
};
|
||||
return iconMap[aiExtract.value.type] || null;
|
||||
});
|
||||
|
||||
const isLink = computed(() => {
|
||||
return aiExtract.value && aiExtract.value.type !== 'auth_code';
|
||||
});
|
||||
|
||||
const displayText = computed(() => {
|
||||
if (!aiExtract.value) return '';
|
||||
// For auth_code, always show the raw result (verification code)
|
||||
if (aiExtract.value.type === 'auth_code') {
|
||||
return aiExtract.value.result;
|
||||
}
|
||||
// For links, prefer result_text as display label
|
||||
return aiExtract.value.result_text || aiExtract.value.result;
|
||||
});
|
||||
|
||||
const copyToClipboard = async () => {
|
||||
try {
|
||||
await navigator.clipboard.writeText(aiExtract.value.result);
|
||||
message.success(t('copySuccess'));
|
||||
} catch (e) {
|
||||
message.error(t('copyFailed'));
|
||||
}
|
||||
};
|
||||
|
||||
const openLink = () => {
|
||||
if (isLink.value && aiExtract.value.result) {
|
||||
window.open(aiExtract.value.result, '_blank');
|
||||
}
|
||||
};
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div v-if="aiExtract && aiExtract.result" class="ai-extract-info">
|
||||
<n-alert v-if="!compact" type="success" closable :theme-overrides="alertThemeOverrides">
|
||||
<template #icon>
|
||||
<n-icon :component="typeIcon" />
|
||||
</template>
|
||||
<template #header>
|
||||
{{ typeLabel }}
|
||||
</template>
|
||||
<n-space align="center">
|
||||
<n-text v-if="aiExtract.type === 'auth_code'" strong style="font-size: 18px; font-family: monospace;">
|
||||
{{ aiExtract.result }}
|
||||
</n-text>
|
||||
<n-ellipsis v-else style="max-width: 400px;">
|
||||
{{ displayText }}
|
||||
</n-ellipsis>
|
||||
<n-button size="small" @click="copyToClipboard" tertiary>
|
||||
<template #icon>
|
||||
<n-icon :component="ContentCopyOutlined" />
|
||||
</template>
|
||||
</n-button>
|
||||
<n-button v-if="isLink" size="small" @click="openLink" tertiary type="primary">
|
||||
{{ t('open') }}
|
||||
</n-button>
|
||||
</n-space>
|
||||
</n-alert>
|
||||
<n-tag v-else type="success" @click="copyToClipboard" style="cursor: pointer;" size="small" :theme-overrides="tagThemeOverrides">
|
||||
<template #icon>
|
||||
<n-icon :component="typeIcon" />
|
||||
</template>
|
||||
<n-ellipsis style="max-width: 150px;">
|
||||
{{ typeLabel }}: {{ displayText }}
|
||||
</n-ellipsis>
|
||||
</n-tag>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.ai-extract-info {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
</style>
|
||||
@@ -8,6 +8,7 @@ import { useIsMobile } from '../utils/composables'
|
||||
import { processItem } from '../utils/email-parser'
|
||||
import { utcToLocalDate } from '../utils';
|
||||
import MailContentRenderer from "./MailContentRenderer.vue";
|
||||
import AiExtractInfo from "./AiExtractInfo.vue";
|
||||
|
||||
const message = useMessage()
|
||||
const isMobile = useIsMobile()
|
||||
@@ -48,20 +49,44 @@ const props = defineProps({
|
||||
default: (mail_id, filename, blob) => { },
|
||||
required: false
|
||||
},
|
||||
showFilterInput: {
|
||||
type: Boolean,
|
||||
default: false,
|
||||
required: false
|
||||
},
|
||||
})
|
||||
|
||||
const localFilterKeyword = ref('')
|
||||
|
||||
const {
|
||||
isDark, mailboxSplitSize, indexTab, loading, useUTCDate,
|
||||
autoRefresh, configAutoRefreshInterval, sendMailModel
|
||||
} = useGlobalState()
|
||||
const autoRefreshInterval = ref(configAutoRefreshInterval.value)
|
||||
const data = ref([])
|
||||
const rawData = ref([])
|
||||
const timer = ref(null)
|
||||
|
||||
const count = ref(0)
|
||||
const page = ref(1)
|
||||
const pageSize = ref(20)
|
||||
|
||||
// Computed property for filtered data (only filter current page)
|
||||
const data = computed(() => {
|
||||
if (!localFilterKeyword.value || localFilterKeyword.value.trim() === '') {
|
||||
return rawData.value;
|
||||
}
|
||||
const keyword = localFilterKeyword.value.toLowerCase();
|
||||
return rawData.value.filter(mail => {
|
||||
// Search in subject, text, message fields
|
||||
const searchFields = [
|
||||
mail.subject || '',
|
||||
mail.text || '',
|
||||
mail.message || ''
|
||||
].map(field => field.toLowerCase());
|
||||
return searchFields.some(field => field.includes(keyword));
|
||||
});
|
||||
})
|
||||
|
||||
const canGoPrevMail = computed(() => {
|
||||
if (!curMail.value) return false
|
||||
const currentIndex = data.value.findIndex(mail => mail.id === curMail.value.id)
|
||||
@@ -135,6 +160,8 @@ const { t } = useI18n({
|
||||
unselectAll: 'Unselect All',
|
||||
prevMail: 'Previous',
|
||||
nextMail: 'Next',
|
||||
keywordQueryTip: 'Filter current page',
|
||||
query: 'Query',
|
||||
},
|
||||
zh: {
|
||||
success: '成功',
|
||||
@@ -157,6 +184,8 @@ const { t } = useI18n({
|
||||
unselectAll: '取消全选',
|
||||
prevMail: '上一封',
|
||||
nextMail: '下一封',
|
||||
keywordQueryTip: '过滤当前页',
|
||||
query: '查询',
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -196,7 +225,7 @@ const refresh = async () => {
|
||||
pageSize.value, (page.value - 1) * pageSize.value
|
||||
);
|
||||
loading.value = true;
|
||||
data.value = await Promise.all(results.map(async (item) => {
|
||||
rawData.value = await Promise.all(results.map(async (item) => {
|
||||
item.checked = false;
|
||||
return await processItem(item);
|
||||
}));
|
||||
@@ -369,7 +398,7 @@ onBeforeUnmount(() => {
|
||||
<div>
|
||||
<div v-if="!isMobile" class="left">
|
||||
<div style="margin-bottom: 10px;">
|
||||
<n-space v-if="multiActionMode">
|
||||
<n-space v-if="multiActionMode" align="center">
|
||||
<n-button @click="multiActionModeClick(false)" tertiary>
|
||||
{{ t('cancelMultiAction') }}
|
||||
</n-button>
|
||||
@@ -392,7 +421,7 @@ onBeforeUnmount(() => {
|
||||
{{ t('downloadMail') }}
|
||||
</n-button>
|
||||
</n-space>
|
||||
<n-space v-else>
|
||||
<n-space v-else align="center">
|
||||
<n-button @click="multiActionModeClick(true)" type="primary" tertiary>
|
||||
{{ t('multiAction') }}
|
||||
</n-button>
|
||||
@@ -409,6 +438,9 @@ onBeforeUnmount(() => {
|
||||
<n-button @click="backFirstPageAndRefresh" type="primary" tertiary>
|
||||
{{ t('refresh') }}
|
||||
</n-button>
|
||||
<n-input v-if="showFilterInput" v-model:value="localFilterKeyword"
|
||||
:placeholder="t('keywordQueryTip')" style="width: 200px; display: flex; align-items: center;"
|
||||
clearable />
|
||||
</n-space>
|
||||
</div>
|
||||
<n-split class="left" direction="horizontal" :max="0.75" :min="0.25" :default-size="mailboxSplitSize"
|
||||
@@ -439,6 +471,7 @@ onBeforeUnmount(() => {
|
||||
TO: {{ row.address }}
|
||||
</n-ellipsis>
|
||||
</n-tag>
|
||||
<AiExtractInfo :metadata="row.metadata" compact />
|
||||
</template>
|
||||
</n-thing>
|
||||
</n-list-item>
|
||||
@@ -480,10 +513,8 @@ onBeforeUnmount(() => {
|
||||
</n-split>
|
||||
</div>
|
||||
<div class="left" v-else>
|
||||
<n-space justify="center">
|
||||
<div style="display: inline-block;">
|
||||
<n-pagination v-model:page="page" v-model:page-size="pageSize" :item-count="count" simple size="small" />
|
||||
</div>
|
||||
<n-space justify="space-around" align="center" :wrap="false" style="display: flex; align-items: center;">
|
||||
<n-pagination v-model:page="page" v-model:page-size="pageSize" :item-count="count" simple size="small" />
|
||||
<n-switch v-model:value="autoRefresh" size="small" :round="false">
|
||||
<template #checked>
|
||||
{{ t('refreshAfter', { msg: autoRefreshInterval }) }}
|
||||
@@ -496,6 +527,10 @@ onBeforeUnmount(() => {
|
||||
{{ t('refresh') }}
|
||||
</n-button>
|
||||
</n-space>
|
||||
<div v-if="showFilterInput" style="padding: 0 10px; margin-top: 8px; margin-bottom: 10px;">
|
||||
<n-input v-model:value="localFilterKeyword"
|
||||
:placeholder="t('keywordQueryTip')" size="small" clearable />
|
||||
</div>
|
||||
<div style="overflow: auto; height: 80vh;">
|
||||
<n-list hoverable clickable>
|
||||
<n-list-item v-for="row in data" v-bind:key="row.id" @click="() => clickRow(row)">
|
||||
@@ -508,11 +543,16 @@ onBeforeUnmount(() => {
|
||||
{{ utcToLocalDate(row.created_at, useUTCDate) }}
|
||||
</n-tag>
|
||||
<n-tag type="info">
|
||||
{{ showEMailTo ? "FROM: " + row.source : row.source }}
|
||||
<n-ellipsis style="max-width: 240px;">
|
||||
{{ showEMailTo ? "FROM: " + row.source : row.source }}
|
||||
</n-ellipsis>
|
||||
</n-tag>
|
||||
<n-tag v-if="showEMailTo" type="info">
|
||||
TO: {{ row.address }}
|
||||
<n-ellipsis style="max-width: 240px;">
|
||||
TO: {{ row.address }}
|
||||
</n-ellipsis>
|
||||
</n-tag>
|
||||
<AiExtractInfo :metadata="row.metadata" compact />
|
||||
</template>
|
||||
</n-thing>
|
||||
</n-list-item>
|
||||
|
||||
@@ -3,6 +3,7 @@ import { ref } from "vue";
|
||||
import { useI18n } from 'vue-i18n'
|
||||
import { CloudDownloadRound, ReplyFilled, ForwardFilled, FullscreenRound } from '@vicons/material'
|
||||
import ShadowHtmlComponent from "./ShadowHtmlComponent.vue";
|
||||
import AiExtractInfo from "./AiExtractInfo.vue";
|
||||
import { getDownloadEmlUrl } from '../utils/email-parser';
|
||||
import { utcToLocalDate } from '../utils';
|
||||
import { useGlobalState } from '../store';
|
||||
@@ -179,6 +180,9 @@ const handleSaveToS3 = async (filename, blob) => {
|
||||
</n-button>
|
||||
</n-space>
|
||||
|
||||
<!-- AI 提取信息 -->
|
||||
<AiExtractInfo :metadata="mail.metadata" />
|
||||
|
||||
<!-- 邮件内容 -->
|
||||
<div class="mail-content">
|
||||
<pre v-if="showTextMail" class="mail-text">{{ mail.text }}</pre>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { createApp } from 'vue'
|
||||
import { createHead } from '@unhead/vue'
|
||||
import { createHead } from '@unhead/vue/client'
|
||||
|
||||
import App from './App.vue'
|
||||
import router from './router'
|
||||
|
||||
@@ -111,6 +111,7 @@ export const useGlobalState = createGlobalState(
|
||||
const isTelegram = ref(!!window.Telegram?.WebApp?.initData);
|
||||
const userOauth2SessionState = useSessionStorage('userOauth2SessionState', '');
|
||||
const userOauth2SessionClientID = useSessionStorage('userOauth2SessionClientID', '');
|
||||
const browserFingerprint = ref('');
|
||||
return {
|
||||
isDark,
|
||||
toggleDark,
|
||||
@@ -148,6 +149,7 @@ export const useGlobalState = createGlobalState(
|
||||
userOauth2SessionClientID,
|
||||
useSimpleIndex,
|
||||
addressPassword,
|
||||
browserFingerprint,
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
30
frontend/src/utils/fingerprint.ts
Normal file
30
frontend/src/utils/fingerprint.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
import FingerprintJS from '@fingerprintjs/fingerprintjs';
|
||||
import { useGlobalState } from '../store';
|
||||
|
||||
const { browserFingerprint } = useGlobalState();
|
||||
|
||||
/**
|
||||
* Get browser fingerprint
|
||||
* Uses cached value from global state if available to avoid unnecessary computation
|
||||
* @returns Fingerprint visitor ID, or 'ERROR' if failed
|
||||
*/
|
||||
export const getFingerprint = async (): Promise<string> => {
|
||||
// Return cached fingerprint if available
|
||||
if (browserFingerprint.value) {
|
||||
return browserFingerprint.value;
|
||||
}
|
||||
|
||||
try {
|
||||
const fp = await FingerprintJS.load();
|
||||
const result = await fp.get();
|
||||
browserFingerprint.value = result.visitorId;
|
||||
return browserFingerprint.value;
|
||||
} catch (error) {
|
||||
console.error('Failed to get fingerprint:', error);
|
||||
// Return special error value to prevent blocking requests
|
||||
const errorValue = 'ERROR';
|
||||
browserFingerprint.value = errorValue;
|
||||
return errorValue;
|
||||
}
|
||||
};
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
<script setup>
|
||||
import { computed, onMounted, ref } from 'vue';
|
||||
import { useI18n } from 'vue-i18n'
|
||||
import { useRouter } from 'vue-router'
|
||||
|
||||
import { useGlobalState } from '../store'
|
||||
import { api } from '../api'
|
||||
import { getRouterPathWithLang } from '../utils'
|
||||
|
||||
import SenderAccess from './admin/SenderAccess.vue'
|
||||
import Statistics from "./admin/Statistics.vue"
|
||||
@@ -25,12 +27,16 @@ import Telegram from './admin/Telegram.vue';
|
||||
import Webhook from './admin/Webhook.vue';
|
||||
import MailWebhook from './admin/MailWebhook.vue';
|
||||
import WorkerConfig from './admin/WorkerConfig.vue';
|
||||
import IpBlacklistSettings from './admin/IpBlacklistSettings.vue';
|
||||
import AiExtractSettings from './admin/AiExtractSettings.vue';
|
||||
|
||||
const {
|
||||
adminAuth, showAdminAuth, adminTab, loading,
|
||||
globalTabplacement, showAdminPage, userSettings
|
||||
globalTabplacement, showAdminPage, userSettings,
|
||||
openSettings
|
||||
} = useGlobalState()
|
||||
const message = useMessage()
|
||||
const router = useRouter()
|
||||
|
||||
const SendMail = defineAsyncComponent(() => {
|
||||
loading.value = true;
|
||||
@@ -47,7 +53,20 @@ const authFunc = async () => {
|
||||
}
|
||||
}
|
||||
|
||||
const { t } = useI18n({
|
||||
const showLogoutModal = ref(false)
|
||||
|
||||
const handleLogout = async () => {
|
||||
// 清空管理员认证
|
||||
adminAuth.value = '';
|
||||
// 重置管理员相关状态
|
||||
showAdminAuth.value = false;
|
||||
adminTab.value = 'account';
|
||||
// 显示成功提示并跳转
|
||||
message.success(t('logoutSuccess'));
|
||||
await router.push(getRouterPathWithLang('/', locale.value));
|
||||
}
|
||||
|
||||
const { t, locale } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
accessHeader: 'Admin Password',
|
||||
@@ -72,10 +91,22 @@ const { t } = useI18n({
|
||||
maintenance: 'Maintenance',
|
||||
database: 'Database',
|
||||
workerconfig: 'Worker Config',
|
||||
ipBlacklistSettings: 'IP Blacklist',
|
||||
aiExtractSettings: 'AI Extract Settings',
|
||||
appearance: 'Appearance',
|
||||
about: 'About',
|
||||
ok: 'OK',
|
||||
mailWebhook: 'Mail Webhook',
|
||||
adminAccount: 'Admin',
|
||||
loginMethod: 'Login Method',
|
||||
loginViaPassword: 'Admin Password Login',
|
||||
loginViaUserAdmin: 'User Admin Permission',
|
||||
loginViaDisabledCheck: 'Disabled Password Check',
|
||||
logout: 'Logout',
|
||||
logoutConfirmTitle: 'Confirm Logout',
|
||||
logoutConfirmContent: 'Are you sure you want to logout from admin panel?',
|
||||
confirm: 'Confirm',
|
||||
logoutSuccess: 'Logout successful',
|
||||
},
|
||||
zh: {
|
||||
accessHeader: 'Admin 密码',
|
||||
@@ -100,16 +131,42 @@ const { t } = useI18n({
|
||||
maintenance: '维护',
|
||||
database: '数据库',
|
||||
workerconfig: 'Worker 配置',
|
||||
ipBlacklistSettings: 'IP 黑名单',
|
||||
aiExtractSettings: 'AI 提取设置',
|
||||
appearance: '外观',
|
||||
about: '关于',
|
||||
ok: '确定',
|
||||
mailWebhook: '邮件 Webhook',
|
||||
adminAccount: '管理员',
|
||||
loginMethod: '登录方式',
|
||||
loginViaPassword: 'Admin 密码登录',
|
||||
loginViaUserAdmin: '用户管理员权限',
|
||||
loginViaDisabledCheck: '已禁用密码检查',
|
||||
logout: '退出登录',
|
||||
logoutConfirmTitle: '确认退出',
|
||||
logoutConfirmContent: '确定要退出管理员面板吗?',
|
||||
confirm: '确认',
|
||||
logoutSuccess: '退出成功',
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const showAdminPasswordModal = computed(() => !showAdminPage.value || showAdminAuth.value)
|
||||
const tmpAdminAuth = ref('')
|
||||
// 判断是否通过 admin password 登录(而非用户管理员权限)
|
||||
const isAdminPasswordLogin = computed(() => !!adminAuth.value)
|
||||
|
||||
// 获取当前登录方式
|
||||
const currentLoginMethod = computed(() => {
|
||||
if (adminAuth.value) {
|
||||
return t('loginViaPassword');
|
||||
} else if (userSettings.value.is_admin) {
|
||||
return t('loginViaUserAdmin');
|
||||
} else if (openSettings.value.disableAdminPasswordCheck) {
|
||||
return t('loginViaDisabledCheck');
|
||||
}
|
||||
return '';
|
||||
})
|
||||
|
||||
onMounted(async () => {
|
||||
// make sure user_id is fetched
|
||||
@@ -160,6 +217,12 @@ onMounted(async () => {
|
||||
<n-tab-pane name="senderAccess" :tab="t('senderAccess')">
|
||||
<SenderAccess />
|
||||
</n-tab-pane>
|
||||
<n-tab-pane name="ipBlacklistSettings" :tab="t('ipBlacklistSettings')">
|
||||
<IpBlacklistSettings />
|
||||
</n-tab-pane>
|
||||
<n-tab-pane name="aiExtractSettings" :tab="t('aiExtractSettings')">
|
||||
<AiExtractSettings />
|
||||
</n-tab-pane>
|
||||
<n-tab-pane name="webhook" :tab="t('webhookSettings')">
|
||||
<Webhook />
|
||||
</n-tab-pane>
|
||||
@@ -222,10 +285,32 @@ onMounted(async () => {
|
||||
<n-tab-pane name="appearance" :tab="t('appearance')">
|
||||
<Appearance />
|
||||
</n-tab-pane>
|
||||
<n-tab-pane name="adminAccount" :tab="t('adminAccount')">
|
||||
<div style="display: flex; justify-content: center; padding: 20px;">
|
||||
<n-card style="width: 600px;">
|
||||
<n-space vertical>
|
||||
<n-text strong>{{ t('loginMethod') }}</n-text>
|
||||
<n-text>{{ currentLoginMethod }}</n-text>
|
||||
<n-divider v-if="isAdminPasswordLogin" />
|
||||
<n-button v-if="isAdminPasswordLogin" type="warning" @click="showLogoutModal = true" block>
|
||||
{{ t('logout') }}
|
||||
</n-button>
|
||||
</n-space>
|
||||
</n-card>
|
||||
</div>
|
||||
</n-tab-pane>
|
||||
<n-tab-pane name="about" :tab="t('about')">
|
||||
<About />
|
||||
</n-tab-pane>
|
||||
</n-tabs>
|
||||
<n-modal v-model:show="showLogoutModal" preset="dialog" :title="t('logoutConfirmTitle')">
|
||||
<p>{{ t('logoutConfirmContent') }}</p>
|
||||
<template #action>
|
||||
<n-button :loading="loading" @click="handleLogout" size="small" tertiary type="warning">
|
||||
{{ t('confirm') }}
|
||||
</n-button>
|
||||
</template>
|
||||
</n-modal>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
|
||||
@@ -158,7 +158,7 @@ onMounted(() => {
|
||||
</div>
|
||||
<MailBox :key="mailBoxKey" :showEMailTo="false" :showReply="true" :showSaveS3="openSettings.isS3Enabled"
|
||||
:saveToS3="saveToS3" :enableUserDeleteEmail="openSettings.enableUserDeleteEmail"
|
||||
:fetchMailData="fetchMailData" :deleteMail="deleteMail" />
|
||||
:fetchMailData="fetchMailData" :deleteMail="deleteMail" :showFilterInput="true" />
|
||||
</n-tab-pane>
|
||||
<n-tab-pane name="sendbox" :tab="t('sendbox')">
|
||||
<SendBox :fetchMailData="fetchSenboxData" :enableUserDeleteEmail="openSettings.enableUserDeleteEmail"
|
||||
|
||||
@@ -22,6 +22,7 @@ const { t } = useI18n({
|
||||
updated_at: 'Update At',
|
||||
mail_count: 'Mail Count',
|
||||
send_count: 'Send Count',
|
||||
source_meta: 'Source',
|
||||
showCredential: 'Show Mail Address Credential',
|
||||
addressCredential: 'Mail Address Credential',
|
||||
addressCredentialTip: 'Please copy the Mail Address Credential and you can use it to login to your email account.',
|
||||
@@ -59,6 +60,7 @@ const { t } = useI18n({
|
||||
updated_at: '更新时间',
|
||||
mail_count: '邮件数量',
|
||||
send_count: '发送数量',
|
||||
source_meta: '来源',
|
||||
showCredential: '查看邮箱地址凭证',
|
||||
addressCredential: '邮箱地址凭证',
|
||||
addressCredentialTip: '请复制邮箱地址凭证,你可以使用它登录你的邮箱。',
|
||||
@@ -319,6 +321,10 @@ const columns = [
|
||||
title: t('updated_at'),
|
||||
key: "updated_at"
|
||||
},
|
||||
{
|
||||
title: t('source_meta'),
|
||||
key: "source_meta"
|
||||
},
|
||||
{
|
||||
title: t('mail_count'),
|
||||
key: "mail_count",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<script setup>
|
||||
import { onMounted, ref, h } from 'vue';
|
||||
import { useI18n } from 'vue-i18n'
|
||||
import { NButton, NPopconfirm, NInput, NSelect } from 'naive-ui'
|
||||
import { NButton, NPopconfirm, NInput, NSelect, NRadioGroup, NRadio } from 'naive-ui'
|
||||
|
||||
import { useGlobalState } from '../../store'
|
||||
import { api } from '../../api'
|
||||
@@ -24,7 +24,7 @@ const { t } = useI18n({
|
||||
fromBlockList: 'Block Keywords for receive email',
|
||||
block_receive_unknow_address_email: 'Block receive unknow address email',
|
||||
email_forwarding_config: 'Email Forwarding Configuration',
|
||||
domain_list: 'Domain List',
|
||||
domain_list: 'Domain List (Optional)',
|
||||
forward_address: 'Forward Address',
|
||||
actions: 'Actions',
|
||||
select_domain: 'Select Domain',
|
||||
@@ -32,10 +32,20 @@ const { t } = useI18n({
|
||||
delete_rule: 'Delete',
|
||||
delete_rule_confirm: 'Are you sure you want to delete this rule?',
|
||||
delete_success: 'Delete Success',
|
||||
forwarding_rule_warning: 'Each rule will run, if domains is empty, all emails will be forwarded, forward address needs to be a verified address',
|
||||
forwarding_rule_warning: 'Each rule will run independently. Forward address needs to be a verified address.',
|
||||
add: 'Add',
|
||||
cancel: 'Cancel',
|
||||
config: 'Config',
|
||||
source_patterns: 'Source Address Regex (Optional)',
|
||||
source_patterns_placeholder: 'e.g. gmail.com',
|
||||
source_match_mode: 'Match Mode',
|
||||
match_any: 'Any',
|
||||
match_all: 'All',
|
||||
source_patterns_tip: 'Domain list filters by recipient address, source regex filters by sender address. Both conditions must match for forwarding (AND logic). Leave either empty to skip that filter.',
|
||||
regex_too_long: 'Regex pattern too long (max 200 characters)',
|
||||
regex_invalid: 'Invalid regex pattern',
|
||||
forward_address_required: 'Forward address is required',
|
||||
rule_index: 'Rule',
|
||||
},
|
||||
zh: {
|
||||
tip: '您可以手动输入以下多选输入框, 回车增加',
|
||||
@@ -50,7 +60,7 @@ const { t } = useI18n({
|
||||
fromBlockList: '接收邮件地址屏蔽关键词',
|
||||
block_receive_unknow_address_email: '禁止接收未知地址邮件',
|
||||
email_forwarding_config: '邮件转发配置',
|
||||
domain_list: '域名列表',
|
||||
domain_list: '域名列表(可选)',
|
||||
forward_address: '转发地址',
|
||||
actions: '操作',
|
||||
select_domain: '选择域名',
|
||||
@@ -58,10 +68,20 @@ const { t } = useI18n({
|
||||
delete_rule: '删除',
|
||||
delete_rule_confirm: '确定要删除这条规则吗?',
|
||||
delete_success: '删除成功',
|
||||
forwarding_rule_warning: '每条规则都会运行,如果 domains 为空,则转发所有邮件,转发地址需要为已验证的地址',
|
||||
forwarding_rule_warning: '每条规则独立运行,转发地址需要为已验证的地址。',
|
||||
add: '添加',
|
||||
cancel: '取消',
|
||||
config: '配置',
|
||||
source_patterns: '来源地址正则(可选)',
|
||||
source_patterns_placeholder: '例如: gmail.com',
|
||||
source_match_mode: '匹配模式',
|
||||
match_any: '任一',
|
||||
match_all: '全部',
|
||||
source_patterns_tip: '域名列表按收件地址过滤,来源正则按发件地址过滤,两者均为可选。同时配置时需同时满足(AND 逻辑),留空则跳过该条件。',
|
||||
regex_too_long: '正则表达式过长(最大200字符)',
|
||||
regex_invalid: '无效的正则表达式',
|
||||
forward_address_required: '转发地址不能为空',
|
||||
rule_index: '规则',
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -98,6 +118,39 @@ const emailForwardingColumns = [
|
||||
})
|
||||
}
|
||||
},
|
||||
{
|
||||
title: t('source_patterns'),
|
||||
key: 'sourcePatterns',
|
||||
render: (row, index) => {
|
||||
return h('div', { style: 'display: flex; flex-direction: column; gap: 4px;' }, [
|
||||
h(NSelect, {
|
||||
value: Array.isArray(row.sourcePatterns) ? row.sourcePatterns : [],
|
||||
onUpdateValue: (val) => {
|
||||
emailForwardingList.value[index].sourcePatterns = val
|
||||
},
|
||||
multiple: true,
|
||||
filterable: true,
|
||||
tag: true,
|
||||
placeholder: t('source_patterns_placeholder')
|
||||
}, {
|
||||
empty: () => h('span', { style: 'color: #999; font-size: 12px;' }, t('manualInputPrompt'))
|
||||
}),
|
||||
h(NRadioGroup, {
|
||||
value: row.sourceMatchMode || 'any',
|
||||
onUpdateValue: (val) => {
|
||||
emailForwardingList.value[index].sourceMatchMode = val
|
||||
},
|
||||
size: 'small',
|
||||
style: 'margin-top: 4px;'
|
||||
}, {
|
||||
default: () => [
|
||||
h(NRadio, { value: 'any' }, { default: () => t('match_any') }),
|
||||
h(NRadio, { value: 'all' }, { default: () => t('match_all') })
|
||||
]
|
||||
})
|
||||
])
|
||||
}
|
||||
},
|
||||
{
|
||||
title: t('forward_address'),
|
||||
key: 'forward',
|
||||
@@ -145,12 +198,50 @@ const addNewEmailForwardingItem = () => {
|
||||
...emailForwardingList.value,
|
||||
{
|
||||
domains: [],
|
||||
forward: ''
|
||||
forward: '',
|
||||
sourcePatterns: [],
|
||||
sourceMatchMode: 'any'
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
const MAX_REGEX_LENGTH = 200
|
||||
|
||||
const validateForwardingRules = () => {
|
||||
for (let i = 0; i < emailForwardingList.value.length; i++) {
|
||||
const rule = emailForwardingList.value[i]
|
||||
|
||||
// 验证转发地址
|
||||
if (!rule.forward || rule.forward.trim() === '') {
|
||||
message.error(`${t('forward_address_required')} (${t('rule_index')} ${i + 1})`)
|
||||
return false
|
||||
}
|
||||
|
||||
// 验证正则表达式
|
||||
if (rule.sourcePatterns && rule.sourcePatterns.length > 0) {
|
||||
for (const pattern of rule.sourcePatterns) {
|
||||
// 检查长度
|
||||
if (pattern.length > MAX_REGEX_LENGTH) {
|
||||
message.error(`${t('regex_too_long')}: ${pattern.substring(0, 30)}...`)
|
||||
return false
|
||||
}
|
||||
// 检查正则有效性
|
||||
try {
|
||||
new RegExp(pattern, 'i')
|
||||
} catch (e) {
|
||||
message.error(`${t('regex_invalid')}: ${pattern}`)
|
||||
return false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
const saveEmailForwardingConfig = () => {
|
||||
if (!validateForwardingRules()) {
|
||||
return
|
||||
}
|
||||
emailRuleSettings.value.emailForwardingList = [...emailForwardingList.value]
|
||||
showEmailForwardingModal.value = false
|
||||
}
|
||||
@@ -164,9 +255,9 @@ const fetchData = async () => {
|
||||
verifiedAddressList.value = res.verifiedAddressList || []
|
||||
fromBlockList.value = res.fromBlockList || []
|
||||
noLimitSendAddressList.value = res.noLimitSendAddressList || []
|
||||
emailRuleSettings.value = res.emailRuleSettings || {
|
||||
blockReceiveUnknowAddressEmail: false,
|
||||
emailForwardingList: []
|
||||
emailRuleSettings.value = {
|
||||
blockReceiveUnknowAddressEmail: res.emailRuleSettings?.blockReceiveUnknowAddressEmail || false,
|
||||
emailForwardingList: res.emailRuleSettings?.emailForwardingList || []
|
||||
}
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
@@ -269,10 +360,12 @@ onMounted(async () => {
|
||||
|
||||
<!-- 邮件转发配置弹窗 -->
|
||||
<n-modal v-model:show="showEmailForwardingModal" preset="card" :title="t('email_forwarding_config')"
|
||||
style="max-width: 800px;">
|
||||
style="max-width: 1000px;">
|
||||
<n-space vertical>
|
||||
<n-alert :show-icon="false" :bordered="false" type="warning">
|
||||
<span>{{ t('forwarding_rule_warning') }}</span>
|
||||
<br />
|
||||
<span>{{ t('source_patterns_tip') }}</span>
|
||||
</n-alert>
|
||||
<n-space justify="end">
|
||||
<n-button @click="addNewEmailForwardingItem">{{ t('add') }}</n-button>
|
||||
|
||||
125
frontend/src/views/admin/AiExtractSettings.vue
Normal file
125
frontend/src/views/admin/AiExtractSettings.vue
Normal file
@@ -0,0 +1,125 @@
|
||||
<script setup lang="ts">
|
||||
import { onMounted, ref } from 'vue'
|
||||
import { useI18n } from 'vue-i18n'
|
||||
import { useMessage } from 'naive-ui'
|
||||
// @ts-ignore
|
||||
import { api } from '../../api'
|
||||
|
||||
const message = useMessage()
|
||||
|
||||
const { t } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
title: 'AI Email Extraction Settings',
|
||||
successTip: 'Success',
|
||||
save: 'Save',
|
||||
enableAllowList: 'Enable Address Allowlist',
|
||||
enableAllowListTip: 'When enabled, AI extraction will only process emails sent to addresses in the allowlist',
|
||||
allowList: 'Address Allowlist (Enter address and press Enter, wildcards supported)',
|
||||
allowListTip: "Wildcard * matches any characters, e.g. *{'@'}example.com matches all addresses under example.com domain",
|
||||
manualInputPrompt: 'Type and press Enter to add',
|
||||
disabledTip: 'When disabled, AI extraction will process all email addresses',
|
||||
},
|
||||
zh: {
|
||||
title: 'AI 邮件提取设置',
|
||||
successTip: '成功',
|
||||
save: '保存',
|
||||
enableAllowList: '启用地址白名单',
|
||||
enableAllowListTip: '启用后,AI 提取功能仅对白名单中的邮箱地址生效',
|
||||
allowList: '地址白名单 (请输入地址并回车,支持通配符)',
|
||||
allowListTip: "通配符 * 可匹配任意字符,如 *{'@'}example.com 可匹配 example.com 域名下的所有地址",
|
||||
manualInputPrompt: '输入后按回车键添加',
|
||||
disabledTip: '未启用时,所有邮箱地址都可使用 AI 提取功能',
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
type AiExtractSettings = {
|
||||
enableAllowList: boolean
|
||||
allowList: string[]
|
||||
}
|
||||
|
||||
const settings = ref<AiExtractSettings>({
|
||||
enableAllowList: false,
|
||||
allowList: []
|
||||
})
|
||||
|
||||
const fetchData = async () => {
|
||||
try {
|
||||
const res = await api.fetch(`/admin/ai_extract/settings`) as AiExtractSettings
|
||||
Object.assign(settings.value, res)
|
||||
} catch (error) {
|
||||
message.error((error as Error).message || "error");
|
||||
}
|
||||
}
|
||||
|
||||
const saveSettings = async () => {
|
||||
try {
|
||||
await api.fetch(`/admin/ai_extract/settings`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(settings.value),
|
||||
})
|
||||
message.success(t('successTip'))
|
||||
} catch (error) {
|
||||
message.error((error as Error).message || "error");
|
||||
}
|
||||
}
|
||||
|
||||
onMounted(async () => {
|
||||
await fetchData();
|
||||
})
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="center">
|
||||
<n-card :title="t('title')" :bordered="false" embedded style="max-width: 800px; overflow: auto;">
|
||||
<n-flex justify="end">
|
||||
<n-button @click="saveSettings" type="primary">
|
||||
{{ t('save') }}
|
||||
</n-button>
|
||||
</n-flex>
|
||||
|
||||
<n-form-item-row :label="t('enableAllowList')">
|
||||
<n-switch v-model:value="settings.enableAllowList" :round="false" />
|
||||
</n-form-item-row>
|
||||
|
||||
<n-alert v-if="!settings.enableAllowList" type="info" style="margin-bottom: 16px;">
|
||||
{{ t('disabledTip') }}
|
||||
</n-alert>
|
||||
|
||||
<div v-if="settings.enableAllowList">
|
||||
<n-alert type="warning" style="margin-bottom: 16px;">
|
||||
{{ t('enableAllowListTip') }}
|
||||
</n-alert>
|
||||
|
||||
<n-form-item-row :label="t('allowList')">
|
||||
<n-select v-model:value="settings.allowList" filterable multiple tag
|
||||
:placeholder="t('allowListTip')">
|
||||
<template #empty>
|
||||
<n-text depth="3">
|
||||
{{ t('manualInputPrompt') }}
|
||||
</n-text>
|
||||
</template>
|
||||
</n-select>
|
||||
</n-form-item-row>
|
||||
|
||||
<n-text depth="3" style="font-size: 12px;">
|
||||
{{ t('allowListTip') }}
|
||||
</n-text>
|
||||
</div>
|
||||
</n-card>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.center {
|
||||
display: flex;
|
||||
text-align: left;
|
||||
place-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.n-button {
|
||||
margin-top: 10px;
|
||||
}
|
||||
</style>
|
||||
220
frontend/src/views/admin/IpBlacklistSettings.vue
Normal file
220
frontend/src/views/admin/IpBlacklistSettings.vue
Normal file
@@ -0,0 +1,220 @@
|
||||
<script setup>
|
||||
import { onMounted, ref } from 'vue';
|
||||
import { useI18n } from 'vue-i18n'
|
||||
|
||||
import { useGlobalState } from '../../store'
|
||||
import { api } from '../../api'
|
||||
|
||||
const { loading } = useGlobalState()
|
||||
const message = useMessage()
|
||||
|
||||
const { t } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
title: 'IP Blacklist Settings',
|
||||
manualInputPrompt: 'Type pattern and press Enter to add',
|
||||
save: 'Save',
|
||||
successTip: 'Save Success',
|
||||
enable_ip_blacklist: 'Enable IP Blacklist',
|
||||
enable_tip: 'Block IPs matching blacklist patterns from accessing rate-limited APIs',
|
||||
ip_blacklist: 'IP Blacklist Patterns',
|
||||
ip_blacklist_placeholder: 'Enter pattern (e.g., 192.168.1 or ^10\\.0\\.0\\.5$)',
|
||||
asn_blacklist: 'ASN Organization Blacklist',
|
||||
asn_blacklist_placeholder: 'Enter ASN organization (e.g., Google, Amazon)',
|
||||
fingerprint_blacklist: 'Browser Fingerprint Blacklist',
|
||||
fingerprint_blacklist_placeholder: 'Enter fingerprint ID (e.g., a1b2c3d4e5f6g7h8)',
|
||||
tip_ip: 'IP Blacklist: Supports text matching (e.g., "192.168.1") or regex (e.g., "^10\\.0\\.0\\.5$").',
|
||||
tip_asn: 'ASN Organization: Block by ISP/provider. Case-insensitive text matching or regex.',
|
||||
tip_fingerprint: 'Browser Fingerprint: Block by browser fingerprint. Supports exact matching or regex patterns.',
|
||||
tip_daily_limit: 'Daily Limit: Restrict the maximum number of requests per IP address per day (1-1000000).',
|
||||
tip_scope: 'Applies to: Create Address, Send Mail, External Send Mail API, User Registration, Verify Code',
|
||||
enable_daily_limit: 'Enable Daily Request Limit',
|
||||
enable_daily_limit_tip: 'Limit the number of API requests per IP address per day',
|
||||
daily_request_limit: 'Daily Request Limit',
|
||||
daily_request_limit_placeholder: 'Enter limit (e.g., 1000)',
|
||||
},
|
||||
zh: {
|
||||
title: 'IP 黑名单设置',
|
||||
manualInputPrompt: '输入匹配模式后按回车键添加',
|
||||
save: '保存',
|
||||
successTip: '保存成功',
|
||||
enable_ip_blacklist: '启用 IP 黑名单',
|
||||
enable_tip: '阻止匹配黑名单的 IP 访问限流 API',
|
||||
ip_blacklist: 'IP 黑名单匹配模式',
|
||||
ip_blacklist_placeholder: '输入匹配模式(例如:192.168.1 或 ^10\\.0\\.0\\.5$)',
|
||||
asn_blacklist: 'ASN 组织(运营商)黑名单',
|
||||
asn_blacklist_placeholder: '输入 ASN 组织名称(例如:Google, Amazon)',
|
||||
fingerprint_blacklist: '浏览器指纹黑名单',
|
||||
fingerprint_blacklist_placeholder: '输入指纹 ID(例如:a1b2c3d4e5f6g7h8)',
|
||||
tip_ip: 'IP 黑名单:支持文本匹配(如 "192.168.1")或正则表达式(如 "^10\\.0\\.0\\.5$")。',
|
||||
tip_asn: 'ASN 组织:根据运营商/ISP 拉黑。支持不区分大小写的文本匹配或正则表达式。',
|
||||
tip_fingerprint: '浏览器指纹:根据浏览器指纹拉黑。支持完全匹配或正则表达式。',
|
||||
tip_daily_limit: '每日限流:限制单个 IP 地址每天最多请求次数(1-1000000)。',
|
||||
tip_scope: '作用范围:创建邮箱地址、发送邮件、外部发送邮件 API、用户注册、验证码验证',
|
||||
enable_daily_limit: '启用每日请求限流',
|
||||
enable_daily_limit_tip: '限制每个 IP 地址每天的 API 请求次数',
|
||||
daily_request_limit: '每日请求次数上限',
|
||||
daily_request_limit_placeholder: '输入限制次数(例如:1000)',
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const enabled = ref(false)
|
||||
const ipBlacklist = ref([])
|
||||
const asnBlacklist = ref([])
|
||||
const fingerprintBlacklist = ref([])
|
||||
const enableDailyLimit = ref(false)
|
||||
const dailyRequestLimit = ref(1000)
|
||||
|
||||
const fetchData = async () => {
|
||||
try {
|
||||
loading.value = true
|
||||
const res = await api.fetch(`/admin/ip_blacklist/settings`)
|
||||
enabled.value = res.enabled || false
|
||||
ipBlacklist.value = res.blacklist || []
|
||||
asnBlacklist.value = res.asnBlacklist || []
|
||||
fingerprintBlacklist.value = res.fingerprintBlacklist || []
|
||||
enableDailyLimit.value = res.enableDailyLimit || false
|
||||
dailyRequestLimit.value = res.dailyRequestLimit || 1000
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
} finally {
|
||||
loading.value = false
|
||||
}
|
||||
}
|
||||
|
||||
const save = async () => {
|
||||
try {
|
||||
loading.value = true
|
||||
await api.fetch(`/admin/ip_blacklist/settings`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({
|
||||
enabled: enabled.value,
|
||||
blacklist: ipBlacklist.value || [],
|
||||
asnBlacklist: asnBlacklist.value || [],
|
||||
fingerprintBlacklist: fingerprintBlacklist.value || [],
|
||||
enableDailyLimit: enableDailyLimit.value,
|
||||
dailyRequestLimit: dailyRequestLimit.value
|
||||
})
|
||||
})
|
||||
message.success(t('successTip'))
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
} finally {
|
||||
loading.value = false
|
||||
}
|
||||
}
|
||||
|
||||
onMounted(async () => {
|
||||
await fetchData();
|
||||
})
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="center">
|
||||
<n-card :title="t('title')" :bordered="false" embedded style="max-width: 800px;">
|
||||
<template #header-extra>
|
||||
<n-button @click="save" type="primary" :loading="loading">
|
||||
{{ t('save') }}
|
||||
</n-button>
|
||||
</template>
|
||||
|
||||
<n-space vertical :size="20">
|
||||
<n-alert :show-icon="false" :bordered="false" type="info">
|
||||
<div style="line-height: 1.8;">
|
||||
<div><strong>{{ t("tip_scope") }}</strong></div>
|
||||
<div>• {{ t("tip_ip") }}</div>
|
||||
<div>• {{ t("tip_asn") }}</div>
|
||||
<div>• {{ t("tip_fingerprint") }}</div>
|
||||
<div>• {{ t("tip_daily_limit") }}</div>
|
||||
</div>
|
||||
</n-alert>
|
||||
|
||||
<n-form-item-row :label="t('enable_ip_blacklist')">
|
||||
<n-switch v-model:value="enabled" :round="false" />
|
||||
<n-text depth="3" style="margin-left: 10px; font-size: 12px;">
|
||||
{{ t('enable_tip') }}
|
||||
</n-text>
|
||||
</n-form-item-row>
|
||||
|
||||
<n-form-item-row :label="t('ip_blacklist')">
|
||||
<n-select
|
||||
v-model:value="ipBlacklist"
|
||||
filterable
|
||||
multiple
|
||||
tag
|
||||
:placeholder="t('ip_blacklist_placeholder')"
|
||||
:disabled="!enabled">
|
||||
<template #empty>
|
||||
<n-text depth="3">
|
||||
{{ t('manualInputPrompt') }}
|
||||
</n-text>
|
||||
</template>
|
||||
</n-select>
|
||||
</n-form-item-row>
|
||||
|
||||
<n-form-item-row :label="t('asn_blacklist')">
|
||||
<n-select
|
||||
v-model:value="asnBlacklist"
|
||||
filterable
|
||||
multiple
|
||||
tag
|
||||
:placeholder="t('asn_blacklist_placeholder')"
|
||||
:disabled="!enabled">
|
||||
<template #empty>
|
||||
<n-text depth="3">
|
||||
{{ t('manualInputPrompt') }}
|
||||
</n-text>
|
||||
</template>
|
||||
</n-select>
|
||||
</n-form-item-row>
|
||||
|
||||
<n-form-item-row :label="t('fingerprint_blacklist')">
|
||||
<n-select
|
||||
v-model:value="fingerprintBlacklist"
|
||||
filterable
|
||||
multiple
|
||||
tag
|
||||
:placeholder="t('fingerprint_blacklist_placeholder')"
|
||||
:disabled="!enabled">
|
||||
<template #empty>
|
||||
<n-text depth="3">
|
||||
{{ t('manualInputPrompt') }}
|
||||
</n-text>
|
||||
</template>
|
||||
</n-select>
|
||||
</n-form-item-row>
|
||||
|
||||
<n-divider />
|
||||
|
||||
<n-form-item-row :label="t('enable_daily_limit')">
|
||||
<n-switch v-model:value="enableDailyLimit" :round="false" />
|
||||
<n-text depth="3" style="margin-left: 10px; font-size: 12px;">
|
||||
{{ t('enable_daily_limit_tip') }}
|
||||
</n-text>
|
||||
</n-form-item-row>
|
||||
|
||||
<n-form-item-row :label="t('daily_request_limit')">
|
||||
<n-input-number
|
||||
v-model:value="dailyRequestLimit"
|
||||
:min="1"
|
||||
:max="1000000"
|
||||
:placeholder="t('daily_request_limit_placeholder')"
|
||||
:disabled="!enableDailyLimit"
|
||||
style="width: 100%;"
|
||||
/>
|
||||
</n-form-item-row>
|
||||
</n-space>
|
||||
</n-card>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.center {
|
||||
display: flex;
|
||||
text-align: left;
|
||||
place-items: center;
|
||||
justify-content: center;
|
||||
margin: 20px;
|
||||
}
|
||||
</style>
|
||||
@@ -12,23 +12,19 @@ const { t } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
addressQueryTip: 'Leave blank to query all addresses',
|
||||
keywordQueryTip: 'Leave blank to not query by keyword',
|
||||
query: 'Query',
|
||||
},
|
||||
zh: {
|
||||
addressQueryTip: '留空查询所有地址',
|
||||
keywordQueryTip: '留空不按关键字查询',
|
||||
query: '查询',
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const mailBoxKey = ref("")
|
||||
const mailKeyword = ref("")
|
||||
|
||||
const queryMail = () => {
|
||||
adminMailTabAddress.value = adminMailTabAddress.value.trim();
|
||||
mailKeyword.value = mailKeyword.value.trim();
|
||||
mailBoxKey.value = Date.now();
|
||||
}
|
||||
|
||||
@@ -38,7 +34,6 @@ const fetchMailData = async (limit, offset) => {
|
||||
+ `?limit=${limit}`
|
||||
+ `&offset=${offset}`
|
||||
+ (adminMailTabAddress.value ? `&address=${adminMailTabAddress.value}` : '')
|
||||
+ (mailKeyword.value ? `&keyword=${mailKeyword.value}` : '')
|
||||
);
|
||||
}
|
||||
|
||||
@@ -51,14 +46,13 @@ const deleteMail = async (curMailId) => {
|
||||
<div style="margin-top: 10px;">
|
||||
<n-input-group>
|
||||
<n-input v-model:value="adminMailTabAddress" :placeholder="t('addressQueryTip')"
|
||||
@keydown.enter="queryMail" />
|
||||
<n-input v-model:value="mailKeyword" :placeholder="t('keywordQueryTip')" @keydown.enter="queryMail" />
|
||||
@keydown.enter="queryMail" clearable />
|
||||
<n-button @click="queryMail" type="primary" tertiary>
|
||||
{{ t('query') }}
|
||||
</n-button>
|
||||
</n-input-group>
|
||||
<div style="margin-top: 10px;"></div>
|
||||
<MailBox :key="mailBoxKey" :enableUserDeleteEmail="true" :fetchMailData="fetchMailData"
|
||||
:deleteMail="deleteMail" />
|
||||
:deleteMail="deleteMail" :showFilterInput="true" />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
<script setup>
|
||||
import { ref, onMounted } from 'vue';
|
||||
import { useI18n } from 'vue-i18n'
|
||||
import { CleaningServicesFilled } from '@vicons/material'
|
||||
import { CleaningServicesFilled, AddFilled, DeleteFilled } from '@vicons/material'
|
||||
|
||||
import { useGlobalState } from '../../store'
|
||||
import { api } from '../../api'
|
||||
|
||||
const { loading } = useGlobalState()
|
||||
const message = useMessage()
|
||||
const cleanupModel = ref({
|
||||
enableMailsAutoCleanup: false,
|
||||
@@ -19,6 +21,9 @@ const cleanupModel = ref({
|
||||
cleanInactiveAddressDays: 30,
|
||||
enableUnboundAddressAutoCleanup: false,
|
||||
cleanUnboundAddressDays: 30,
|
||||
enableEmptyAddressAutoCleanup: false,
|
||||
cleanEmptyAddressDays: 30,
|
||||
customSqlCleanupList: []
|
||||
})
|
||||
|
||||
const { t } = useI18n({
|
||||
@@ -31,11 +36,22 @@ const { t } = useI18n({
|
||||
addressCreateLabel: "Cleanup the address created before n days",
|
||||
inactiveAddressLabel: "Cleanup the inactive address before n days",
|
||||
unboundAddressLabel: "Cleanup the unbound address before n days",
|
||||
emptyAddressLabel: "Cleanup the empty address before n days",
|
||||
cleanupNow: "Cleanup now",
|
||||
autoCleanup: "Auto cleanup",
|
||||
cleanupSuccess: "Cleanup success",
|
||||
saveSuccess: "Save success",
|
||||
save: "Save",
|
||||
cronTip: "Enable cron cleanup, need to configure [crons] in worker, please refer to the document, setting 0 days means clear all",
|
||||
basicCleanup: "Basic Cleanup",
|
||||
customSqlCleanup: "Custom SQL Cleanup",
|
||||
customSqlTip: "Add custom DELETE SQL statements for scheduled cleanup. Only single DELETE statement is allowed per entry.",
|
||||
addCustomSql: "Add Custom SQL",
|
||||
sqlName: "Name",
|
||||
sqlStatement: "SQL Statement (DELETE only)",
|
||||
sqlNamePlaceholder: "e.g. Clean old logs",
|
||||
sqlPlaceholder: "e.g. DELETE FROM raw_mails WHERE source GLOB '*{'@'}example.com' AND created_at < datetime('now', '-3 day')",
|
||||
deleteCustomSql: "Delete",
|
||||
},
|
||||
zh: {
|
||||
tip: '请输入天数',
|
||||
@@ -45,11 +61,22 @@ const { t } = useI18n({
|
||||
addressCreateLabel: "清理 n 天前创建的地址",
|
||||
inactiveAddressLabel: "清理 n 天前的未活跃地址",
|
||||
unboundAddressLabel: "清理 n 天前的未绑定用户地址",
|
||||
emptyAddressLabel: "清理 n 天前空邮件的邮箱地址",
|
||||
autoCleanup: "自动清理",
|
||||
cleanupSuccess: "清理成功",
|
||||
saveSuccess: "保存成功",
|
||||
cleanupNow: "立即清理",
|
||||
save: "保存",
|
||||
cronTip: "启用定时清理, 需在 worker 配置 [crons] 参数, 请参考文档, 配置为 0 天表示全部清空",
|
||||
basicCleanup: "基础清理",
|
||||
customSqlCleanup: "自定义 SQL 清理",
|
||||
customSqlTip: "添加自定义 DELETE SQL 语句进行定时清理。每条记录仅允许单条 DELETE 语句。",
|
||||
addCustomSql: "添加自定义 SQL",
|
||||
sqlName: "名称",
|
||||
sqlStatement: "SQL 语句 (仅限 DELETE)",
|
||||
sqlNamePlaceholder: "例如: 清理旧日志",
|
||||
sqlPlaceholder: "例如: DELETE FROM raw_mails WHERE source GLOB '*{'@'}example.com' AND created_at < datetime('now', '-3 day')",
|
||||
deleteCustomSql: "删除",
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -66,10 +93,29 @@ const cleanup = async (cleanType, cleanDays) => {
|
||||
}
|
||||
}
|
||||
|
||||
const addCustomSql = () => {
|
||||
if (!cleanupModel.value.customSqlCleanupList) {
|
||||
cleanupModel.value.customSqlCleanupList = [];
|
||||
}
|
||||
cleanupModel.value.customSqlCleanupList.push({
|
||||
id: Date.now().toString(),
|
||||
name: '',
|
||||
sql: '',
|
||||
enabled: false
|
||||
});
|
||||
}
|
||||
|
||||
const removeCustomSql = (index) => {
|
||||
cleanupModel.value.customSqlCleanupList.splice(index, 1);
|
||||
}
|
||||
|
||||
const fetchData = async () => {
|
||||
try {
|
||||
const res = await api.fetch('/admin/auto_cleanup');
|
||||
if (res) Object.assign(cleanupModel.value, res);
|
||||
if (!cleanupModel.value.customSqlCleanupList) {
|
||||
cleanupModel.value.customSqlCleanupList = [];
|
||||
}
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
}
|
||||
@@ -81,7 +127,7 @@ const save = async () => {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(cleanupModel.value)
|
||||
});
|
||||
message.success(t('cleanupSuccess'));
|
||||
message.success(t('saveSuccess'));
|
||||
} catch (error) {
|
||||
message.error(error.message || "error");
|
||||
}
|
||||
@@ -104,80 +150,132 @@ onMounted(async () => {
|
||||
{{ t('save') }}
|
||||
</n-button>
|
||||
</n-flex>
|
||||
<n-form :model="cleanupModel">
|
||||
<n-form-item-row :label="t('mailBoxLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableMailsAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanMailsDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('mails', cleanupModel.cleanMailsDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('mailUnknowLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableUnknowMailsAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanUnknowMailsDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('mails_unknow', cleanupModel.cleanUnknowMailsDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('sendBoxLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableSendBoxAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanSendBoxDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('sendbox', cleanupModel.cleanSendBoxDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('addressCreateLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableAddressAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanAddressDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('addressCreated', cleanupModel.cleanAddressDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('inactiveAddressLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableInactiveAddressAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanInactiveAddressDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('inactiveAddress', cleanupModel.cleanInactiveAddressDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('unboundAddressLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableUnboundAddressAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanUnboundAddressDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('unboundAddress', cleanupModel.cleanUnboundAddressDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
</n-form>
|
||||
<n-tabs type="segment" style="margin-top: 16px;">
|
||||
<n-tab-pane name="basic" :tab="t('basicCleanup')">
|
||||
<n-form :model="cleanupModel">
|
||||
<n-form-item-row :label="t('mailBoxLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableMailsAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanMailsDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('mails', cleanupModel.cleanMailsDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('mailUnknowLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableUnknowMailsAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanUnknowMailsDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('mails_unknow', cleanupModel.cleanUnknowMailsDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('sendBoxLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableSendBoxAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanSendBoxDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('sendbox', cleanupModel.cleanSendBoxDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('addressCreateLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableAddressAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanAddressDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('addressCreated', cleanupModel.cleanAddressDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('inactiveAddressLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableInactiveAddressAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanInactiveAddressDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('inactiveAddress', cleanupModel.cleanInactiveAddressDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('unboundAddressLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableUnboundAddressAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanUnboundAddressDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('unboundAddress', cleanupModel.cleanUnboundAddressDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
<n-form-item-row :label="t('emptyAddressLabel')">
|
||||
<n-checkbox v-model:checked="cleanupModel.enableEmptyAddressAutoCleanup">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input-number v-model:value="cleanupModel.cleanEmptyAddressDays" :placeholder="t('tip')" />
|
||||
<n-button @click="cleanup('emptyAddress', cleanupModel.cleanEmptyAddressDays)">
|
||||
<template #icon>
|
||||
<n-icon :component="CleaningServicesFilled" />
|
||||
</template>
|
||||
{{ t('cleanupNow') }}
|
||||
</n-button>
|
||||
</n-form-item-row>
|
||||
</n-form>
|
||||
</n-tab-pane>
|
||||
<n-tab-pane name="custom_sql" :tab="t('customSqlCleanup')">
|
||||
<n-alert :show-icon="false" :bordered="false" type="info" style="margin-bottom: 16px;">
|
||||
<span>{{ t('customSqlTip') }}</span>
|
||||
</n-alert>
|
||||
<n-space vertical>
|
||||
<n-card v-for="(item, index) in cleanupModel.customSqlCleanupList" :key="item.id" size="small">
|
||||
<n-space vertical>
|
||||
<n-space align="center">
|
||||
<n-checkbox v-model:checked="item.enabled">
|
||||
{{ t('autoCleanup') }}
|
||||
</n-checkbox>
|
||||
<n-input v-model:value="item.name" :placeholder="t('sqlNamePlaceholder')" style="width: 200px;" />
|
||||
<n-button @click="removeCustomSql(index)" type="error" quaternary>
|
||||
<template #icon>
|
||||
<n-icon :component="DeleteFilled" />
|
||||
</template>
|
||||
{{ t('deleteCustomSql') }}
|
||||
</n-button>
|
||||
</n-space>
|
||||
<n-input
|
||||
v-model:value="item.sql"
|
||||
type="textarea"
|
||||
:placeholder="t('sqlPlaceholder')"
|
||||
:autosize="{ minRows: 2 }"
|
||||
class="sql-input"
|
||||
/>
|
||||
</n-space>
|
||||
</n-card>
|
||||
<n-button @click="addCustomSql">
|
||||
<template #icon>
|
||||
<n-icon :component="AddFilled" />
|
||||
</template>
|
||||
{{ t('addCustomSql') }}
|
||||
</n-button>
|
||||
</n-space>
|
||||
</n-tab-pane>
|
||||
</n-tabs>
|
||||
</n-card>
|
||||
</div>
|
||||
</template>
|
||||
@@ -198,8 +296,7 @@ onMounted(async () => {
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.item {
|
||||
display: flex;
|
||||
margin: 10px;
|
||||
.sql-input {
|
||||
text-align: left;
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -1,81 +1,51 @@
|
||||
<script setup>
|
||||
import useClipboard from 'vue-clipboard3'
|
||||
import { computed, onMounted, ref } from 'vue'
|
||||
import { onMounted, ref } from 'vue'
|
||||
import { useI18n } from 'vue-i18n'
|
||||
import { useRouter } from 'vue-router'
|
||||
import { Copy, User, ExchangeAlt } from '@vicons/fa'
|
||||
import { User, ExchangeAlt } from '@vicons/fa'
|
||||
|
||||
import { useGlobalState } from '../../store'
|
||||
import { api } from '../../api'
|
||||
import Login from '../common/Login.vue'
|
||||
import AddressManagement from '../user/AddressManagement.vue'
|
||||
import TelegramAddress from './TelegramAddress.vue'
|
||||
import LocalAddress from './LocalAddress.vue'
|
||||
import AddressManagement from '../user/AddressManagement.vue'
|
||||
import { getRouterPathWithLang } from '../../utils'
|
||||
import AddressSelect from '../../components/AddressSelect.vue'
|
||||
|
||||
const { toClipboard } = useClipboard()
|
||||
const message = useMessage()
|
||||
const router = useRouter()
|
||||
|
||||
const {
|
||||
jwt, settings, showAddressCredential, userJwt,
|
||||
isTelegram, openSettings, addressPassword
|
||||
isTelegram, addressPassword
|
||||
} = useGlobalState()
|
||||
|
||||
const { locale, t } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
addressManage: 'Address Manage',
|
||||
changeAddress: 'Change Address',
|
||||
ok: 'OK',
|
||||
copy: 'Copy',
|
||||
copied: 'Copied',
|
||||
fetchAddressError: 'Mail address credential is invalid or account not exist, it may be network connection issue, please try again later.',
|
||||
addressCredential: 'Mail Address Credential',
|
||||
linkWithAddressCredential: 'Open to auto login email link',
|
||||
addressCredentialTip: 'Please copy the Mail Address Credential and you can use it to login to your email account.',
|
||||
addressPassword: 'Address Password',
|
||||
userLogin: 'User Login',
|
||||
addressManage: 'Manage',
|
||||
},
|
||||
zh: {
|
||||
addressManage: '地址管理',
|
||||
changeAddress: '更换地址',
|
||||
ok: '确定',
|
||||
copy: '复制',
|
||||
copied: '已复制',
|
||||
fetchAddressError: '邮箱地址凭证无效或邮箱地址不存在,也可能是网络连接异常,请稍后再尝试。',
|
||||
addressCredential: '邮箱地址凭证',
|
||||
linkWithAddressCredential: '打开即可自动登录邮箱的链接',
|
||||
addressCredentialTip: '请复制邮箱地址凭证,你可以使用它登录你的邮箱。',
|
||||
addressPassword: '地址密码',
|
||||
userLogin: '用户登录',
|
||||
addressManage: '地址管理',
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const showChangeAddress = ref(false)
|
||||
const showTelegramChangeAddress = ref(false)
|
||||
const showLocalAddress = ref(false)
|
||||
const addressLabel = computed(() => {
|
||||
if (settings.value.address) {
|
||||
const domain = settings.value.address.split('@')[1]
|
||||
const domainLabel = openSettings.value.domains.find(
|
||||
d => d.value === domain
|
||||
)?.label;
|
||||
if (!domainLabel) return settings.value.address;
|
||||
return settings.value.address.replace('@' + domain, `@${domainLabel}`);
|
||||
}
|
||||
return settings.value.address;
|
||||
})
|
||||
|
||||
const copy = async () => {
|
||||
try {
|
||||
await toClipboard(settings.value.address)
|
||||
message.success(t('copied'));
|
||||
} catch (e) {
|
||||
message.error(e.message || "error");
|
||||
}
|
||||
}
|
||||
const showAddressManage = ref(false)
|
||||
|
||||
const getUrlWithJwt = () => {
|
||||
return `${window.location.origin}/?jwt=${jwt.value}`
|
||||
@@ -97,29 +67,25 @@ onMounted(async () => {
|
||||
</n-card>
|
||||
<div v-else-if="settings.address">
|
||||
<n-alert type="info" :show-icon="false" :bordered="false">
|
||||
<span>
|
||||
<b>{{ addressLabel }}</b>
|
||||
<n-button v-if="isTelegram" style="margin-left: 10px" @click="showTelegramChangeAddress = true"
|
||||
size="small" tertiary type="primary">
|
||||
<n-icon :component="ExchangeAlt" /> {{ t('addressManage') }}
|
||||
</n-button>
|
||||
<n-button v-else-if="userJwt" style="margin-left: 10px" @click="showChangeAddress = true"
|
||||
size="small" tertiary type="primary">
|
||||
<n-icon :component="ExchangeAlt" /> {{ t('changeAddress') }}
|
||||
</n-button>
|
||||
<n-button v-else style="margin-left: 10px" @click="showLocalAddress = true" size="small" tertiary
|
||||
type="primary">
|
||||
<n-icon :component="ExchangeAlt" /> {{ t('addressManage') }}
|
||||
</n-button>
|
||||
<n-button style="margin-left: 10px" @click="copy" size="small" tertiary type="primary">
|
||||
<n-icon :component="Copy" /> {{ t('copy') }}
|
||||
</n-button>
|
||||
</span>
|
||||
<AddressSelect>
|
||||
<template #actions>
|
||||
<n-button class="address-manage" size="small" tertiary type="primary"
|
||||
@click="showAddressManage = true">
|
||||
<n-icon :component="ExchangeAlt" />
|
||||
{{ t('addressManage') }}
|
||||
</n-button>
|
||||
</template>
|
||||
</AddressSelect>
|
||||
</n-alert>
|
||||
</div>
|
||||
<div v-else-if="isTelegram">
|
||||
<TelegramAddress />
|
||||
</div>
|
||||
<div v-else-if="userJwt" class="center">
|
||||
<n-card :bordered="false" embedded style="max-width: 900px; width: 100%;">
|
||||
<AddressManagement />
|
||||
</n-card>
|
||||
</div>
|
||||
<div v-else class="center">
|
||||
<n-card :bordered="false" embedded style="max-width: 600px;">
|
||||
<n-alert v-if="jwt" type="warning" :show-icon="false" :bordered="false" closable>
|
||||
@@ -135,15 +101,6 @@ onMounted(async () => {
|
||||
</n-button>
|
||||
</n-card>
|
||||
</div>
|
||||
<n-modal v-model:show="showTelegramChangeAddress" preset="card" :title="t('changeAddress')">
|
||||
<TelegramAddress />
|
||||
</n-modal>
|
||||
<n-modal v-model:show="showChangeAddress" preset="card" :title="t('changeAddress')">
|
||||
<AddressManagement />
|
||||
</n-modal>
|
||||
<n-modal v-model:show="showLocalAddress" preset="card" :title="t('changeAddress')">
|
||||
<LocalAddress />
|
||||
</n-modal>
|
||||
<n-modal v-model:show="showAddressCredential" preset="dialog" :title="t('addressCredential')">
|
||||
<span>
|
||||
<p>{{ t("addressCredentialTip") }}</p>
|
||||
@@ -165,6 +122,11 @@ onMounted(async () => {
|
||||
</n-collapse>
|
||||
</n-card>
|
||||
</n-modal>
|
||||
<n-modal v-model:show="showAddressManage" preset="card" :title="t('addressManage')">
|
||||
<TelegramAddress v-if="isTelegram" />
|
||||
<AddressManagement v-else-if="userJwt" />
|
||||
<LocalAddress v-else />
|
||||
</n-modal>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
@@ -186,4 +148,9 @@ onMounted(async () => {
|
||||
justify-content: center;
|
||||
margin: 20px;
|
||||
}
|
||||
|
||||
.address-manage {
|
||||
flex: 0 0 auto;
|
||||
white-space: nowrap;
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -48,7 +48,7 @@ const data = computed(() => {
|
||||
}
|
||||
return localAddressCache.value.map((curJwt: string) => {
|
||||
try {
|
||||
var payload = JSON.parse(
|
||||
const payload = JSON.parse(
|
||||
decodeURIComponent(
|
||||
atob(curJwt.split(".")[1]
|
||||
.replace(/-/g, "+").replace(/_/g, "/")
|
||||
|
||||
@@ -17,6 +17,7 @@ import Login from '../common/Login.vue'
|
||||
import AccountSettings from './AccountSettings.vue'
|
||||
import { processItem } from '../../utils/email-parser'
|
||||
import MailContentRenderer from '../../components/MailContentRenderer.vue'
|
||||
import AddressSelect from '../../components/AddressSelect.vue'
|
||||
|
||||
const { jwt, settings, useSimpleIndex, showAddressCredential, openSettings, loading } = useGlobalState()
|
||||
const message = useMessage()
|
||||
@@ -171,7 +172,7 @@ onBeforeUnmount(() => {
|
||||
<div v-else>
|
||||
<n-card :bordered="false" embedded>
|
||||
<div style="text-align: center; margin-bottom: 16px; font-size: 18px;">
|
||||
<n-text strong size="large">{{ settings.address }}</n-text>
|
||||
<AddressSelect :showCopy="false" size="small" />
|
||||
</div>
|
||||
<n-flex justify="center">
|
||||
<n-button @click="refreshMails" :loading="loading" type="primary" tertiary size="small">
|
||||
|
||||
@@ -5,17 +5,16 @@ import { useI18n } from 'vue-i18n'
|
||||
import { api } from '../../api'
|
||||
import MailBox from '../../components/MailBox.vue';
|
||||
|
||||
const message = useMessage()
|
||||
|
||||
const { t } = useI18n({
|
||||
messages: {
|
||||
en: {
|
||||
addressQueryTip: 'Leave blank to query all addresses',
|
||||
keywordQueryTip: 'Leave blank to not query by keyword',
|
||||
query: 'Query',
|
||||
},
|
||||
zh: {
|
||||
addressQueryTip: '留空查询所有地址',
|
||||
keywordQueryTip: '留空不按关键字查询',
|
||||
query: '查询',
|
||||
}
|
||||
}
|
||||
@@ -23,12 +22,10 @@ const { t } = useI18n({
|
||||
|
||||
const mailBoxKey = ref("")
|
||||
const addressFilter = ref();
|
||||
const mailKeyword = ref("")
|
||||
const addressFilterOptions = ref([]);
|
||||
|
||||
const queryMail = () => {
|
||||
addressFilter.value = addressFilter.value ? addressFilter.value.trim() : addressFilter.value;
|
||||
mailKeyword.value = mailKeyword.value.trim();
|
||||
mailBoxKey.value = Date.now();
|
||||
}
|
||||
|
||||
@@ -38,7 +35,6 @@ const fetchMailData = async (limit, offset) => {
|
||||
+ `?limit=${limit}`
|
||||
+ `&offset=${offset}`
|
||||
+ (addressFilter.value ? `&address=${addressFilter.value}` : '')
|
||||
+ (mailKeyword.value ? `&keyword=${mailKeyword.value}` : '')
|
||||
);
|
||||
}
|
||||
|
||||
@@ -77,13 +73,12 @@ onMounted(() => {
|
||||
<n-input-group>
|
||||
<n-select v-model:value="addressFilter" :options="addressFilterOptions" clearable
|
||||
:placeholder="t('addressQueryTip')" />
|
||||
<n-input v-model:value="mailKeyword" :placeholder="t('keywordQueryTip')" @keydown.enter="queryMail" />
|
||||
<n-button @click="queryMail" type="primary" tertiary>
|
||||
{{ t('query') }}
|
||||
</n-button>
|
||||
</n-input-group>
|
||||
<div style="margin-top: 10px;"></div>
|
||||
<MailBox :key="mailBoxKey" :enableUserDeleteEmail="true" :fetchMailData="fetchMailData"
|
||||
:deleteMail="deleteMail" />
|
||||
:deleteMail="deleteMail" :showFilterInput="true" />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "temp-email-pages",
|
||||
"version": "1.0.6",
|
||||
"version": "1.2.1",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
@@ -11,7 +11,7 @@
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"devDependencies": {
|
||||
"wrangler": "^4.42.2"
|
||||
"wrangler": "^4.59.2"
|
||||
},
|
||||
"packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39"
|
||||
}
|
||||
|
||||
@@ -135,16 +135,16 @@ class SimpleMailbox:
|
||||
|
||||
def fetch(self, messages, uid):
|
||||
"""边查边返回邮件"""
|
||||
def email_generator():
|
||||
for range_item in messages.ranges:
|
||||
start, end = range_item
|
||||
_logger.info(f"Fetching messages: {self.name}, range: {start}-{end}")
|
||||
result = []
|
||||
for range_item in messages.ranges:
|
||||
start, end = range_item
|
||||
_logger.info(f"Fetching messages: {self.name}, range: {start}-{end}")
|
||||
|
||||
for email_data in self.fetchGenerator(start, end):
|
||||
yield email_data
|
||||
for email_data in self.fetchGenerator(start, end):
|
||||
result.append(email_data)
|
||||
|
||||
# 返回生成器,让IMAP4服务器逐个处理
|
||||
return email_generator()
|
||||
# 返回列表而不是生成器,以支持 IMAP SEARCH 等需要索引访问的操作
|
||||
return result
|
||||
|
||||
def fetchGenerator(self, start, end):
|
||||
"""通用的邮件获取生成器,边查边返回"""
|
||||
|
||||
@@ -2,13 +2,16 @@ import { defineConfig, type DefaultTheme } from 'vitepress'
|
||||
|
||||
export const en = defineConfig({
|
||||
title: "Temp Mail Doc",
|
||||
lang: 'zh-Hans',
|
||||
lang: 'en-US',
|
||||
description: 'CloudFlare Free sending and receiving of temporary domain name mailboxes',
|
||||
|
||||
themeConfig: {
|
||||
outline: 'deep',
|
||||
nav: nav(),
|
||||
|
||||
sidebar: {
|
||||
'/en/guide/': { base: '/en/guide/', items: sidebarGuide() },
|
||||
},
|
||||
|
||||
editLink: {
|
||||
pattern: 'https://github.com/dreamhunter2333/cloudflare_temp_email/edit/main/vitepress-docs/docs/:path',
|
||||
text: 'Edit this page on GitHub'
|
||||
@@ -18,6 +21,31 @@ export const en = defineConfig({
|
||||
message: 'Based on MIT license',
|
||||
copyright: `Copyright © 2023-${new Date().getFullYear()} Dream Hunter`
|
||||
},
|
||||
|
||||
docFooter: {
|
||||
prev: 'Previous',
|
||||
next: 'Next'
|
||||
},
|
||||
|
||||
outline: {
|
||||
level: 'deep',
|
||||
label: 'On this page'
|
||||
},
|
||||
|
||||
lastUpdated: {
|
||||
text: 'Last updated',
|
||||
formatOptions: {
|
||||
dateStyle: 'short',
|
||||
timeStyle: 'medium'
|
||||
}
|
||||
},
|
||||
|
||||
langMenuLabel: 'Language',
|
||||
returnToTopLabel: 'Return to top',
|
||||
sidebarMenuLabel: 'Menu',
|
||||
darkModeSwitchLabel: 'Theme',
|
||||
lightModeSwitchTitle: 'Switch to light mode',
|
||||
darkModeSwitchTitle: 'Switch to dark mode'
|
||||
}
|
||||
})
|
||||
|
||||
@@ -29,15 +57,16 @@ function nav(): DefaultTheme.NavItem[] {
|
||||
},
|
||||
{
|
||||
text: 'Guide',
|
||||
link: '/en/cli',
|
||||
link: '/en/guide/quick-start',
|
||||
activeMatch: '/en/guide/'
|
||||
},
|
||||
{
|
||||
text: 'Service Status',
|
||||
link: '/status',
|
||||
link: '/en/status',
|
||||
},
|
||||
{
|
||||
text: 'Reference',
|
||||
link: '/reference',
|
||||
link: '/en/reference',
|
||||
},
|
||||
{
|
||||
text: process.env.TAG_NAME || 'v0.2.2',
|
||||
@@ -54,3 +83,88 @@ function nav(): DefaultTheme.NavItem[] {
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
function sidebarGuide(): DefaultTheme.SidebarItem[] {
|
||||
return [
|
||||
{
|
||||
text: 'Introduction',
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: 'What is Temporary Email', link: 'what-is-temp-mail' },
|
||||
{ text: 'Star History', link: 'star-history' },
|
||||
{ text: 'Quick Start', link: 'quick-start' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Deploy via Command Line',
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: 'CLI Prerequisites', link: 'cli/pre-requisite' },
|
||||
{ text: 'D1 Database', link: 'cli/d1' },
|
||||
{ text: 'Cloudflare Workers Backend', link: 'cli/worker' },
|
||||
{ text: 'Configure Email Routing', link: 'email-routing.md' },
|
||||
{ text: 'Cloudflare Pages Frontend', link: 'cli/pages' },
|
||||
{ text: 'Configure Email Sending', link: 'config-send-mail' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Deploy via User Interface',
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: 'D1 Database', link: 'ui/d1' },
|
||||
{ text: 'Cloudflare Workers Backend', link: 'ui/worker' },
|
||||
{ text: 'Configure Email Routing', link: 'email-routing.md' },
|
||||
{ text: 'Cloudflare Pages Frontend', link: 'ui/pages' },
|
||||
{ text: 'Configure Email Sending', link: 'config-send-mail' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Deploy via Github Actions',
|
||||
collapsed: true,
|
||||
items: [
|
||||
{ text: 'Github Actions Prerequisites', link: 'actions/pre-requisite' },
|
||||
{ text: 'D1 Database', link: 'actions/d1' },
|
||||
{ text: 'Github Actions Configuration', link: 'actions/github-action' },
|
||||
{ text: 'Configure Email Routing', link: 'email-routing.md' },
|
||||
{ text: 'Configure Email Sending', link: 'config-send-mail' },
|
||||
{ text: 'Auto-Update Configuration', link: 'actions/auto-update' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'General',
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: 'Worker Variables', link: 'worker-vars' },
|
||||
{ text: 'Common Issues', link: 'common-issues' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Additional Features',
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: 'AI Email Recognition', link: 'feature/ai-extract' },
|
||||
{ text: 'Configure SMTP IMAP Proxy', link: 'feature/config-smtp-proxy' },
|
||||
{ text: 'Send Email API', link: 'feature/send-mail-api' },
|
||||
{ text: 'View Email API', link: 'feature/mail-api' },
|
||||
{ text: 'Configure Subdomain Email', link: 'feature/subdomain' },
|
||||
{ text: 'Configure Telegram Bot', link: 'feature/telegram' },
|
||||
{ text: 'Configure S3 Attachments', link: 'feature/s3-attachment' },
|
||||
{ text: 'Configure WASM Email Parser', link: 'feature/mail_parser_wasm_worker' },
|
||||
{ text: 'Configure Webhook', link: 'feature/webhook' },
|
||||
{ text: 'New Address API', link: 'feature/new-address-api' },
|
||||
{ text: 'OAuth2 Third-party Login', link: 'feature/user-oauth2' },
|
||||
{ text: 'Enhance with Other Workers', link: 'feature/another-worker-enhanced' },
|
||||
{ text: 'Add Google Ads', link: 'feature/google-ads.md' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Feature Overview',
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: 'Admin Console', link: 'feature/admin' },
|
||||
{ text: 'Admin User Management', link: 'feature/admin-user-management' },
|
||||
]
|
||||
},
|
||||
{ text: 'Reference', base: "/en/", link: 'reference' }
|
||||
]
|
||||
}
|
||||
|
||||
@@ -142,6 +142,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
|
||||
text: '附加功能',
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: 'AI 邮件识别', link: 'feature/ai-extract' },
|
||||
{ text: '配置 SMTP IMAP 代理服务', link: 'feature/config-smtp-proxy' },
|
||||
{ text: '发送邮件 API', link: 'feature/send-mail-api' },
|
||||
{ text: '查看邮件 API', link: 'feature/mail-api' },
|
||||
|
||||
10
vitepress-docs/docs/en/guide/actions/auto-update.md
Normal file
10
vitepress-docs/docs/en/guide/actions/auto-update.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# How to Configure Auto-Update for GitHub Actions Deployment
|
||||
|
||||
::: warning Notice
|
||||
If you encounter any issues, please report them via `GitHub Issues`. Thank you.
|
||||
Auto-update will not execute SQL files for the D1 database. When the database schema changes, you need to execute them manually.
|
||||
:::
|
||||
|
||||
1. Open the `Actions` page of the repository, find `Upstream Sync`, and click `enable workflow` to enable the `workflow`
|
||||
2. If `Upstream Sync` fails, go to the repository homepage and click `Sync` to synchronize manually
|
||||
3. You can customize the update interval by modifying the `schedule` configuration in `Upstream Sync`, refer to [cron expressions](https://crontab.guru/)
|
||||
17
vitepress-docs/docs/en/guide/actions/d1.md
Normal file
17
vitepress-docs/docs/en/guide/actions/d1.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Initialize/Update D1 Database
|
||||
|
||||
## Create Database
|
||||
|
||||
Open the Cloudflare console, select `Workers & Pages` -> `D1` -> `Create Database`, and click to create the database
|
||||
|
||||

|
||||
|
||||
After creation, you can see the D1 database in the Cloudflare console and obtain the database `name` and `database ID`
|
||||
|
||||
## Initialize Database
|
||||
|
||||
After deployment is complete, go to the admin page's `Quick Setup` -> `Database` section and click the `Initialize Database` button to initialize the database
|
||||
|
||||
## Update Database Schema
|
||||
|
||||
Refer to [Update D1 via Command Line](/en/guide/cli/d1) or [Update D1 via UI](/en/guide/ui/d1)
|
||||
61
vitepress-docs/docs/en/guide/actions/github-action.md
Normal file
61
vitepress-docs/docs/en/guide/actions/github-action.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Deploy via GitHub Actions
|
||||
|
||||
::: warning Notice
|
||||
Currently only supports Worker and Pages deployment.
|
||||
If you encounter any issues, please report them via `GitHub Issues`. Thank you.
|
||||
|
||||
The `worker.dev` domain is inaccessible in China, please use a custom domain
|
||||
:::
|
||||
|
||||
## Deployment Steps
|
||||
|
||||
### Fork Repository and Enable Actions
|
||||
|
||||
- Fork this repository on GitHub
|
||||
- Open the `Actions` page of the repository
|
||||
- Find `Deploy Backend` and click `enable workflow` to enable the `workflow`
|
||||
- If you need separate frontend and backend deployment, find `Deploy Frontend` and click `enable workflow` to enable the `workflow`
|
||||
|
||||
### Configure Secrets
|
||||
|
||||
Then go to the repository page `Settings` -> `Secrets and variables` -> `Actions` -> `Repository secrets`, and add the following `secrets`:
|
||||
|
||||
- Common `secrets`
|
||||
|
||||
| Name | Description |
|
||||
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `CLOUDFLARE_ACCOUNT_ID` | Cloudflare Account ID, [Reference Documentation](https://developers.cloudflare.com/workers/wrangler/ci-cd/#cloudflare-account-id) |
|
||||
| `CLOUDFLARE_API_TOKEN` | Cloudflare API Token, [Reference Documentation](https://developers.cloudflare.com/workers/wrangler/ci-cd/#api-token) |
|
||||
|
||||
- Worker backend `secrets`
|
||||
|
||||
| Name | Description |
|
||||
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `BACKEND_TOML` | Backend configuration file, [see here](/en/guide/cli/worker.html#modify-wrangler-toml-configuration-file) |
|
||||
| `DEBUG_MODE` | (Optional) Whether to enable debug mode, set to `true` to enable. By default, worker deployment logs are not output to GitHub Actions page, enabling this will output them |
|
||||
| `BACKEND_USE_MAIL_WASM_PARSER` | (Optional) Whether to use WASM to parse emails, set to `true` to enable. For features, refer to [Configure Worker to use WASM Email Parser](/en/guide/feature/mail_parser_wasm_worker) |
|
||||
| `USE_WORKER_ASSETS` | (Optional) Deploy Worker with frontend assets, set to `true` to enable |
|
||||
|
||||
- Pages frontend `secrets`
|
||||
|
||||
> [!warning] Notice
|
||||
> If you choose to deploy Worker with frontend assets, these `secrets` are not required
|
||||
|
||||
| Name | Description |
|
||||
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `FRONTEND_ENV` | Frontend configuration file, please copy the content from `frontend/.env.example`, [and modify according to this guide](/en/guide/cli/pages.html) |
|
||||
| `FRONTEND_NAME` | The project name you created in Cloudflare Pages, can be created via [UI](https://temp-mail-docs.awsl.uk/en/guide/ui/pages.html) or [Command Line](https://temp-mail-docs.awsl.uk/en/guide/cli/pages.html) |
|
||||
| `FRONTEND_BRANCH` | (Optional) Branch for pages deployment, can be left unconfigured, defaults to `production` |
|
||||
| `PAGE_TOML` | (Optional) Required when using page functions to forward backend requests. Please copy the content from `pages/wrangler.toml` and modify the `service` field to your worker backend name according to actual situation |
|
||||
| `TG_FRONTEND_NAME` | (Optional) The project name you created in Cloudflare Pages, same as `FRONTEND_NAME`. Fill this in if you need Telegram Mini App functionality |
|
||||
|
||||
### Deploy
|
||||
|
||||
- Open the `Actions` page of the repository
|
||||
- Find `Deploy Backend` and click `Run workflow` to select a branch and deploy manually
|
||||
- If you need separate frontend and backend deployment, find `Deploy Frontend` and click `Run workflow` to select a branch and deploy manually
|
||||
|
||||
## How to Configure Auto-Update
|
||||
|
||||
1. Open the `Actions` page of the repository, find `Upstream Sync`, and click `enable workflow` to enable the `workflow`
|
||||
2. If `Upstream Sync` fails, go to the repository homepage and click `Sync` to synchronize manually
|
||||
10
vitepress-docs/docs/en/guide/actions/pre-requisite.md
Normal file
10
vitepress-docs/docs/en/guide/actions/pre-requisite.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GitHub Actions Deployment Prerequisites
|
||||
|
||||
## GitHub Account
|
||||
|
||||
- A GitHub account is required
|
||||
- A stable network connection
|
||||
|
||||
## Fork Repository
|
||||
|
||||
- Fork [this repository](https://github.com/dreamhunter2333/cloudflare_temp_email.git) on GitHub
|
||||
30
vitepress-docs/docs/en/guide/cli/d1.md
Normal file
30
vitepress-docs/docs/en/guide/cli/d1.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Initialize/Update D1 Database
|
||||
|
||||
When executing the wrangler login command for the first time, you will be prompted to log in. Follow the prompts to complete the login process.
|
||||
|
||||
## Initialize Database
|
||||
|
||||
```bash
|
||||
cd worker
|
||||
cp wrangler.toml.template wrangler.toml
|
||||
# Create D1 and execute schema.sql
|
||||
wrangler d1 create dev
|
||||
wrangler d1 execute dev --file=../db/schema.sql --remote
|
||||
```
|
||||
|
||||
After creation, you can see the D1 database in the Cloudflare console.
|
||||
|
||||

|
||||
|
||||
## Update Database Schema
|
||||
|
||||
For `schema` updates, please confirm your previously deployed version.
|
||||
Check the [Changelog](https://github.com/dreamhunter2333/cloudflare_temp_email/blob/main/CHANGELOG.md)
|
||||
|
||||
Find the `patch` file you need to execute and run it, for example:
|
||||
|
||||
```bash
|
||||
cd worker
|
||||
wrangler d1 execute dev --file=../db/2024-01-13-patch.sql --remote
|
||||
wrangler d1 execute dev --file=../db/2024-04-03-patch.sql --remote
|
||||
```
|
||||
51
vitepress-docs/docs/en/guide/cli/pages.md
Normal file
51
vitepress-docs/docs/en/guide/cli/pages.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# Cloudflare Pages Frontend
|
||||
|
||||
> [!warning] Notice
|
||||
> Choose one of the following methods
|
||||
|
||||
## Deploy Worker with Frontend Assets
|
||||
|
||||
Refer to [Deploy Worker](/en/guide/cli/worker#deploy-worker-with-frontend-optional)
|
||||
|
||||
## Separate Frontend and Backend Deployment
|
||||
|
||||
The first deployment will prompt you to create a project. For the `production` branch, enter `production`.
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
pnpm install
|
||||
cp .env.example .env.prod
|
||||
```
|
||||
|
||||
Modify the `.env.prod` file.
|
||||
|
||||
Change `VITE_API_BASE` to the `worker` `url` created in the previous step. Do not add `/` at the end.
|
||||
|
||||
For example: `VITE_API_BASE=https://xxx.xxx.workers.dev`
|
||||
|
||||
```bash
|
||||
pnpm build --emptyOutDir
|
||||
# The first deployment will prompt you to create a project, for production branch enter production
|
||||
pnpm run deploy
|
||||
```
|
||||
|
||||
After deployment, you can see your project in the Cloudflare console. You can configure a custom domain for `pages`.
|
||||
|
||||

|
||||
|
||||
## Forward Backend Requests Through Page Functions
|
||||
|
||||
Forwarding requests from page functions to the worker backend can achieve faster response times.
|
||||
|
||||
The first deployment will prompt you to create a project. For the `production` branch, enter `production`.
|
||||
|
||||
If your worker backend name is not `cloudflare_temp_email`, please modify `pages/wrangler.toml`.
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
pnpm install
|
||||
# If you want to enable Cloudflare Zero Trust, you need to use pnpm build:pages:nopwa to disable caching
|
||||
pnpm build:pages
|
||||
cd ../pages
|
||||
pnpm run deploy
|
||||
```
|
||||
17
vitepress-docs/docs/en/guide/cli/pre-requisite.md
Normal file
17
vitepress-docs/docs/en/guide/cli/pre-requisite.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Prerequisites
|
||||
|
||||
## Installing wrangler
|
||||
|
||||
Install wrangler
|
||||
|
||||
```bash
|
||||
npm install wrangler -g
|
||||
```
|
||||
|
||||
## Clone the Project
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dreamhunter2333/cloudflare_temp_email.git
|
||||
# Switch to the latest tag or the branch you want to deploy, you can also use the main branch directly
|
||||
# git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
|
||||
```
|
||||
147
vitepress-docs/docs/en/guide/cli/worker.md
Normal file
147
vitepress-docs/docs/en/guide/cli/worker.md
Normal file
@@ -0,0 +1,147 @@
|
||||
# Cloudflare Worker Backend
|
||||
|
||||
> [!warning] Notice
|
||||
> The `worker.dev` domain is not accessible in China, please use a custom domain
|
||||
|
||||
## Initialize Project
|
||||
|
||||
```bash
|
||||
cd worker
|
||||
pnpm install
|
||||
cp wrangler.toml.template wrangler.toml
|
||||
```
|
||||
|
||||
## Create KV Cache
|
||||
|
||||
> [!NOTE]
|
||||
> If you want to enable user registration and need to send email verification, you need to create a `KV` cache. You can skip this step if not needed.
|
||||
> If you need Telegram Bot, you need to create a `KV` cache. You can skip this step if not needed.
|
||||
|
||||
Create KV cache through command line, or create it in the Cloudflare console, then copy the corresponding configuration to the `wrangler.toml` file.
|
||||
|
||||
```bash
|
||||
wrangler kv:namespace create DEV
|
||||
```
|
||||
|
||||
## Modify `wrangler.toml` Configuration File
|
||||
|
||||
> [!NOTE] Note
|
||||
> For more variable configurations, please check [Worker Variables Documentation](/en/guide/worker-vars)
|
||||
|
||||
```toml
|
||||
name = "cloudflare_temp_email"
|
||||
main = "src/worker.ts"
|
||||
compatibility_date = "2024-09-23"
|
||||
compatibility_flags = [ "nodejs_compat" ]
|
||||
|
||||
# If you want to use a custom domain, you need to add routes configuration
|
||||
# routes = [
|
||||
# { pattern = "temp-email-api.xxxxx.xyz", custom_domain = true },
|
||||
# ]
|
||||
|
||||
# If you want to deploy a worker with frontend assets, you need to add assets configuration
|
||||
# [assets]
|
||||
# directory = "../frontend/dist/"
|
||||
# binding = "ASSETS"
|
||||
# run_worker_first = true
|
||||
|
||||
# If you want to use scheduled tasks to clean up emails, uncomment the following and modify the cron expression
|
||||
# [triggers]
|
||||
# crons = [ "0 0 * * *" ]
|
||||
|
||||
# Send emails through Cloudflare
|
||||
# send_email = [
|
||||
# { name = "SEND_MAIL" },
|
||||
# ]
|
||||
|
||||
[vars]
|
||||
# Email name prefix, can be configured as an empty string or not configured if no prefix is needed
|
||||
PREFIX = "tmp"
|
||||
# All domains used for temporary email, supports multiple domains
|
||||
DOMAINS = ["xxx.xxx1" , "xxx.xxx2"]
|
||||
# Secret key for generating JWT, JWT is used for user login and authentication
|
||||
JWT_SECRET = "xxx"
|
||||
|
||||
# Admin console password, if not configured, console access is not allowed
|
||||
# ADMIN_PASSWORDS = ["123", "456"]
|
||||
|
||||
# Whether to allow users to create emails, not allowed if not configured
|
||||
ENABLE_USER_CREATE_EMAIL = true
|
||||
# Allow users to delete emails, not allowed if not configured
|
||||
ENABLE_USER_DELETE_EMAIL = true
|
||||
|
||||
# D1 database name and ID can be viewed in the Cloudflare console
|
||||
[[d1_databases]]
|
||||
binding = "DB"
|
||||
database_name = "xxx" # D1 database name
|
||||
database_id = "xxx" # D1 database ID
|
||||
|
||||
# KV config for user registration email verification, can be skipped if user registration is not enabled or registration verification is not enabled
|
||||
# [[kv_namespaces]]
|
||||
# binding = "KV"
|
||||
# id = "xxxx"
|
||||
|
||||
# Rate limit configuration for new address /api/new_address
|
||||
# [[unsafe.bindings]]
|
||||
# name = "RATE_LIMITER"
|
||||
# type = "ratelimit"
|
||||
# namespace_id = "1001"
|
||||
# # 10 requests per minute
|
||||
# simple = { limit = 10, period = 60 }
|
||||
|
||||
# Bind other workers to process emails, for example, using auth-inbox AI capabilities to parse verification codes or activation links
|
||||
# [[services]]
|
||||
# binding = "AUTH_INBOX"
|
||||
# service = "auth-inbox"
|
||||
```
|
||||
|
||||
## Deploy Worker with Frontend (Optional)
|
||||
|
||||
> [!NOTE]
|
||||
> If you don't need a [worker with frontend], you can skip this step.
|
||||
> Refer to the frontend deployment documentation later for separate frontend and backend deployment.
|
||||
|
||||
Ensure the frontend assets are built to the `frontend/dist` directory.
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
pnpm install --no-frozen-lockfile
|
||||
pnpm build:pages
|
||||
```
|
||||
|
||||
Add the following configuration to the `wrangler.toml` file in the `worker` directory.
|
||||
|
||||
```toml
|
||||
[assets]
|
||||
directory = "../frontend/dist/"
|
||||
binding = "ASSETS"
|
||||
run_worker_first = true
|
||||
```
|
||||
|
||||
## Telegram Bot Configuration
|
||||
|
||||
> [!NOTE]
|
||||
> If you don't need Telegram Bot, you can skip this step.
|
||||
|
||||
Please create a Telegram Bot first, then get the `token`, and execute the following command to add the `token` to secrets.
|
||||
|
||||
```bash
|
||||
pnpm wrangler secret put TELEGRAM_BOT_TOKEN
|
||||
```
|
||||
|
||||
## Deploy
|
||||
|
||||
The first deployment will prompt you to create a project. For the `production` branch, enter `production`.
|
||||
|
||||
```bash
|
||||
pnpm run deploy
|
||||
```
|
||||
|
||||
After successful deployment, you can see the `worker` `url` in the routes, and the console will also output the `worker` `url`.
|
||||
|
||||

|
||||
|
||||
> [!NOTE]
|
||||
> Open the `worker` `url`, if it displays `OK`, the deployment is successful.
|
||||
>
|
||||
> Open `/health_check`, if it displays `OK`, the deployment is successful.
|
||||
41
vitepress-docs/docs/en/guide/common-issues.md
Normal file
41
vitepress-docs/docs/en/guide/common-issues.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Common Issues
|
||||
|
||||
> [!NOTE] Note
|
||||
> If you don't find a solution here, please search or ask in `Github Issues`, or ask in the Telegram group.
|
||||
|
||||
## General
|
||||
|
||||
| Issue | Solution |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
|
||||
| Sending emails to authenticated forwarding addresses using Cloudflare Workers | Use CF's API for sending, only supports recipient addresses bound to CF, i.e., CF EMAIL forwarding destination addresses |
|
||||
| Binding multiple domains | Each domain needs to configure email forwarding to worker |
|
||||
|
||||
## Worker Related
|
||||
|
||||
| Issue | Solution |
|
||||
| ------------------------------------------------------------------ | --------------------------------------------------------------------------- |
|
||||
| `Uncaught Error: No such module "path". imported from "worker.js"` | [Reference](/en/guide/ui/worker) |
|
||||
| `No such module "node:stream". imported from "worker.js"` | [Reference](/en/guide/ui/worker) |
|
||||
| `Subdomain cannot send emails` | [Reference](https://github.com/dreamhunter2333/cloudflare_temp_email/issues/515) |
|
||||
| `Failed to send verify code: No balance` | Set unlimited emails in admin console or increase quota on the sending permission page |
|
||||
| `Github OAuth unable to get email 400 Failed to get user email` | GitHub user needs to set email to public |
|
||||
| `Cannot read properties of undefined (reading 'map')` | Worker variables not set successfully |
|
||||
|
||||
## Pages Related
|
||||
|
||||
| Issue | Solution |
|
||||
| --------------- | --------------------------------------------------------- |
|
||||
| `network error` | Use incognito mode or clear browser cache and DNS cache |
|
||||
|
||||
## Telegram Bot
|
||||
|
||||
| Issue | Solution |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `Telgram Bot failed to get email: 400: Bad Request:BUTTON_URL_INVALID` | tg mini app URL is incorrect, should be the pages URL |
|
||||
| `Telegram bot bind error: bind adress count reach the limit` | Need to set worker variable `TG_MAX_ADDRESS` |
|
||||
|
||||
## Github Actions
|
||||
|
||||
| Issue | Solution |
|
||||
| ---------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| After Github Action deployment, CF always shows preview branch | Go to CF pages settings to confirm that the frontend branch matches the Github Action frontend deployment branch |
|
||||
84
vitepress-docs/docs/en/guide/config-send-mail.md
Normal file
84
vitepress-docs/docs/en/guide/config-send-mail.md
Normal file
@@ -0,0 +1,84 @@
|
||||
|
||||
# Configure Email Sending
|
||||
|
||||
::: warning Note
|
||||
All three methods can be configured simultaneously. When sending emails, it will prioritize using `resend`, if `resend` is not configured, it will use `smtp`.
|
||||
|
||||
If a Cloudflare authenticated forwarding email address is configured, CF's internal API will be prioritized for sending emails
|
||||
:::
|
||||
|
||||
## Send Emails Using Resend
|
||||
|
||||
Register at `https://resend.com/domains` and add DNS records according to the instructions.
|
||||
|
||||
Create an `api key` on the `API KEYS` page.
|
||||
|
||||
Then execute the following command to add `RESEND_TOKEN` to secrets:
|
||||
|
||||
> [!NOTE]
|
||||
> If you find this troublesome, you can also put it directly in plain text under `[vars]` in `wrangler.toml`, but this is not recommended
|
||||
|
||||
If you deployed through the UI, you can add it under `Variables and Secrets` in the Cloudflare UI interface.
|
||||
|
||||
```bash
|
||||
# Switch to worker directory
|
||||
cd worker
|
||||
wrangler secret put RESEND_TOKEN
|
||||
```
|
||||
|
||||
If you have multiple domains with different `api keys`, you can add multiple secrets in `wrangler.toml`, named `RESEND_TOKEN_` + `<UPPERCASE DOMAIN WITH . REPLACED BY _>`, for example:
|
||||
|
||||
```bash
|
||||
wrangler secret put RESEND_TOKEN_XXX_COM
|
||||
wrangler secret put RESEND_TOKEN_DREAMHUNTER2333_XYZ
|
||||
```
|
||||
|
||||
## Send Emails Using SMTP
|
||||
|
||||
The format of `SMTP_CONFIG` is as follows, where key is the domain name and value is the SMTP configuration. For SMTP configuration format details, refer to [zou-yu/worker-mailer](https://github.com/zou-yu/worker-mailer/blob/main/README_zh-CN.md)
|
||||
|
||||
```json
|
||||
{
|
||||
"awsl.uk": {
|
||||
"host": "smtp.xxx.com",
|
||||
"port": 465,
|
||||
"secure": true,
|
||||
"authType": [
|
||||
"plain",
|
||||
"login"
|
||||
],
|
||||
"credentials": {
|
||||
"username": "username",
|
||||
"password": "password"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then execute the following command to add `SMTP_CONFIG` to secrets:
|
||||
|
||||
> [!NOTE]
|
||||
> If you find this troublesome, you can also put it directly in plain text under `[vars]` in `wrangler.toml`, but this is not recommended
|
||||
|
||||
If you deployed through the UI, you can add it under `Variables and Secrets` in the Cloudflare UI interface.
|
||||
|
||||
```bash
|
||||
# Switch to worker directory
|
||||
cd worker
|
||||
wrangler secret put SMTP_CONFIG
|
||||
```
|
||||
|
||||
## Send Emails to Authenticated Forwarding Addresses on Cloudflare
|
||||
|
||||
Only supported for CLI deployment, add `send_email` configuration in `wrangler.toml`.
|
||||
|
||||
The destination email address must be an authenticated email address on Cloudflare, which has significant limitations. If you need to send emails to other addresses, you can use `resend` or `smtp` to send emails.
|
||||
|
||||
```toml
|
||||
# Send emails through Cloudflare
|
||||
send_email = [
|
||||
{ name = "SEND_MAIL" },
|
||||
]
|
||||
```
|
||||
|
||||
Admin console account configuration `Verified address list (can send emails through CF internal API)`
|
||||
9
vitepress-docs/docs/en/guide/email-routing.md
Normal file
9
vitepress-docs/docs/en/guide/email-routing.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Cloudflare Email Routing
|
||||
|
||||
1. In the CF console for the corresponding domain under `Email Routing`, configure the `Email DNS records`. If there are multiple domains, you need to configure `Email DNS records` for each domain.
|
||||
|
||||
2. Before binding an email address to your Worker, you need to enable email routing and have at least one verified email address (destination address).
|
||||
|
||||
3. Configure the `Catch-all address` in the routing rules of each domain's `Email Routing` to send to `worker`.
|
||||
|
||||

|
||||
@@ -0,0 +1,11 @@
|
||||
# Admin User Management
|
||||
|
||||
## User Management Page
|
||||
|
||||

|
||||
|
||||
## User Settings
|
||||
|
||||
Configure user login and authentication settings here
|
||||
|
||||

|
||||
15
vitepress-docs/docs/en/guide/feature/admin.md
Normal file
15
vitepress-docs/docs/en/guide/feature/admin.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Admin Console
|
||||
|
||||
> [!NOTE]
|
||||
> You need to configure `ADMIN_PASSWORDS` or `ADMIN_USER_ROLE` to access the admin console
|
||||
> Admin role configuration: if the user role equals ADMIN_USER_ROLE, they can access the admin console
|
||||
|
||||
After deploying the frontend application, click the upper-left logo 5 times or visit the `/admin` path to enter the management console.
|
||||
|
||||
You need to configure `ADMIN_PASSWORDS` in the backend or ensure the current user role is `ADMIN_USER_ROLE`, otherwise access to the console will be denied.
|
||||
|
||||

|
||||
|
||||
## If your website is for private access only, you can disable this check
|
||||
|
||||
`DISABLE_ADMIN_PASSWORD_CHECK = true`
|
||||
74
vitepress-docs/docs/en/guide/feature/ai-extract.md
Normal file
74
vitepress-docs/docs/en/guide/feature/ai-extract.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# AI Email Recognition
|
||||
|
||||
> [!NOTE]
|
||||
> This feature is supported from version v1.1.0
|
||||
>
|
||||
> This feature is inspired by the [Alle project](https://github.com/bestruirui/Alle/blob/62e74629ded0c7966c12d4e1c54f0bcc2e54f12c/src/lib/email/extract.ts#L54)
|
||||
|
||||
## Features
|
||||
|
||||
The AI email recognition feature uses Cloudflare Workers AI to automatically analyze incoming email content and intelligently extract important information, including:
|
||||
|
||||
- **Verification Code** (auth_code) - OTP, security code, confirmation code, etc.
|
||||
- **Authentication Link** (auth_link) - Login, verify, activate, password reset links
|
||||
- **Service Link** (service_link) - GitHub, GitLab, deployment notifications and other service-related links
|
||||
- **Subscription Link** (subscription_link) - Unsubscribe, manage subscription links
|
||||
- **Other Link** (other_link) - Other valuable links
|
||||
|
||||
Extraction results are automatically saved to the `metadata` field in the database, and the frontend can directly display extracted verification codes or links.
|
||||
|
||||
## Configuration Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| -------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
|
||||
| `ENABLE_AI_EMAIL_EXTRACT` | Text/JSON | Whether to enable AI email recognition feature | `true` |
|
||||
| `AI_EXTRACT_MODEL` | Text | AI model name, choose from [models supporting JSON mode](https://developers.cloudflare.com/workers-ai/features/json-mode/#supported-models) | `@cf/meta/llama-3.1-8b-instruct` |
|
||||
|
||||
## Content Length Limit
|
||||
|
||||
To avoid AI model token limits, the maximum email content length for processing is **4000 characters**. Email content exceeding this limit will be truncated before AI analysis.
|
||||
|
||||
## Workers AI Binding
|
||||
|
||||
Configure Workers AI binding in `wrangler.toml`:
|
||||
|
||||
```toml
|
||||
[ai]
|
||||
binding = "AI"
|
||||
```
|
||||
|
||||
Or add in Cloudflare Dashboard Worker settings:
|
||||
- **Variable name**: `AI`
|
||||
- **Type**: Workers AI
|
||||
|
||||
## Address Allowlist (Optional)
|
||||
|
||||
To control costs and resource usage, you can configure an address allowlist in the Admin console's **AI Extract Settings** page:
|
||||
|
||||
### Configuration
|
||||
|
||||
- **Allowlist Disabled**: AI extraction will process all email addresses
|
||||
- **Allowlist Enabled**: AI extraction will only process addresses in the allowlist
|
||||
|
||||
### Allowlist Format
|
||||
|
||||
One address per line, supporting wildcard `*` to match any characters:
|
||||
|
||||
- **Exact Match**: `user@example.com` - Only matches this specific email
|
||||
- **Domain Wildcard**: `*@example.com` - Matches all emails under example.com domain
|
||||
- **User Wildcard**: `admin*@example.com` - Matches emails starting with admin
|
||||
- **Wildcard Anywhere**: `*test*@example.com` - Matches emails containing test
|
||||
- **Multiple Wildcards**: `admin*@*.com` - Matches emails starting with admin under any .com domain
|
||||
|
||||
### Configuration Example
|
||||
|
||||
```text
|
||||
user@example.com
|
||||
*@mydomain.com
|
||||
admin*@company.com
|
||||
```
|
||||
|
||||
This configuration will only perform AI extraction for:
|
||||
- `user@example.com` (exact match)
|
||||
- All emails under `@mydomain.com` (e.g., `test@mydomain.com`, `admin@mydomain.com`)
|
||||
- All emails starting with `admin` under `@company.com` (e.g., `admin@company.com`, `admin123@company.com`)
|
||||
144
vitepress-docs/docs/en/guide/feature/another-worker-enhanced.md
Normal file
144
vitepress-docs/docs/en/guide/feature/another-worker-enhanced.md
Normal file
@@ -0,0 +1,144 @@
|
||||
# Enhancement via Another Worker
|
||||
|
||||
> The core capability of temporary email is email management. Other workers can enhance temporary email functionality, for example, auth-inbox AI can parse verification codes or activation links
|
||||
> This feature only triggers other workers and executes after webhook
|
||||
> [!NOTE]
|
||||
> If you want to use worker enhancement, please create a worker that can be called via RPC in advance, details below
|
||||
> References:
|
||||
> - https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/rpc/
|
||||
> - https://developers.cloudflare.com/workers/runtime-apis/rpc/
|
||||
> - auth-inbox project: https://github.com/TooonyChen/AuthInbox
|
||||
|
||||
## Create Another Worker (using auth-inbox AI verification code parsing as an example)
|
||||
|
||||
### Transform Worker to Extend WorkerEntrypoint
|
||||
|
||||
A simple worker code that acts as a callee providing RPC method calls is as follows (the rpcEmail method is an example)
|
||||
(Using the already modified project https://github.com/oneisall8955/AuthInbox-fork)
|
||||
|
||||
src/index.ts file
|
||||
```js
|
||||
import { WorkerEntrypoint } from "cloudflare:workers";
|
||||
|
||||
interface Env {
|
||||
DB: D1Database;
|
||||
// ...
|
||||
}
|
||||
|
||||
export default class extends WorkerEntrypoint<Env> {
|
||||
async fetch(request: Request): Promise<Response> {
|
||||
console.log("Original fetch interface parameter is request,env,ctx");
|
||||
console.log("After modifying to WorkerEntrypoint style, there's only one parameter request, getting environment variables and context has slight changes");
|
||||
// Environment variable and context changes see:
|
||||
// https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/rpc/#bindings-env
|
||||
// https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/rpc/#lifecycle-methods-ctx
|
||||
const env: Env = this.env;
|
||||
const ctx: ExecutionContext = this.ctx;
|
||||
console.log("Subsequent logic remains unchanged");
|
||||
return new Response('ok', { status: 200 });
|
||||
}
|
||||
|
||||
// Main functionality
|
||||
async email(message: ForwardableEmailMessage): Promise<void> {
|
||||
console.log("Original fetch interface parameter is message,env,ctx");
|
||||
console.log("After modifying to WorkerEntrypoint style, there's only one parameter message, getting environment variables and context is the same as fetch method");
|
||||
const env: Env = this.env;
|
||||
const ctx: ExecutionContext = this.ctx;
|
||||
console.log("After receiving email routing request, subsequent logic remains unchanged");
|
||||
}
|
||||
|
||||
// Expose RPC interface to handle email requests from other workers
|
||||
async rpcEmail(requestBody: string): Promise<void> {
|
||||
console.log(`Received request from another worker (temporary email service cloudflare_temp_email), request body: ${requestBody}`);
|
||||
// requestBody is in JSON format, sent by temporary email service, format as follows
|
||||
// type RPCEmailMessage = {
|
||||
// from: string | undefined | null,
|
||||
// to: string | undefined | null,
|
||||
// rawEmail: string | undefined | null,
|
||||
// headers: Map<string, string>,
|
||||
// }
|
||||
// ... todo ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Deploy Another Worker
|
||||
|
||||
After modification, or using auth-inbox as an example, deploy to Cloudflare Worker. See https://github.com/TooonyChen/AuthInbox, or use the already modified project https://github.com/oneisall8955/AuthInbox-fork
|
||||
|
||||
## Configure Temporary Email Service to Use Specified Worker Enhancement
|
||||
|
||||
## Bind Service
|
||||
|
||||
### Configure via wrangler.toml
|
||||
|
||||
```toml
|
||||
[[services]]
|
||||
binding = "AUTH_INBOX"
|
||||
service = "auth-inbox"
|
||||
```
|
||||
|
||||
Here `binding = "AUTH_INBOX"` can be customized to any string, `service = "auth-inbox"` is the name of the deployed worker that provides RPC interface calls.
|
||||
|
||||
### User Interface Configuration
|
||||
|
||||
In Settings - Bindings, add binding, select binding service.
|
||||
Fill in the variable name with a custom name, can be any string, for example `AUTH_INBOX`.
|
||||
Select the service created in the previous step for service binding, for example `auth-inbox`.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## Environment Variable Configuration
|
||||
|
||||
### Configure via wrangler.toml
|
||||
|
||||
```toml
|
||||
ENABLE_ANOTHER_WORKER = true
|
||||
ANOTHER_WORKER_LIST ="""
|
||||
[
|
||||
{
|
||||
"binding":"AUTH_INBOX",
|
||||
"method":"rpcEmail",
|
||||
"keywords":[
|
||||
"验证码","激活码","激活链接","确认链接","验证邮箱","确认邮件","账号激活","邮件验证","账户确认","安全码","认证码","安全验证","登陆码","确认码","启用账户","激活账户","账号验证","注册确认",
|
||||
"account","activation","verify","verification","activate","confirmation","email","code","validate","registration","login","code","expire","confirm"
|
||||
]
|
||||
}
|
||||
]
|
||||
"""
|
||||
```
|
||||
|
||||
Environment variable explanation:
|
||||
- ENABLE_ANOTHER_WORKER = true: Default is false, set to true to enable other workers to process emails
|
||||
- ANOTHER_WORKER_LIST is a JSON array, each object contains 3 fields
|
||||
- binding: *Required, must match the binding = "XXX" specified in the services section*, in the example it's AUTH_INBOX
|
||||
- method: Optional, default is rpcEmail, refers to which RPC method of this worker to call for processing
|
||||
- keywords: Keyword array, case-insensitive. Used for filtering, if the *parsed email text* matches these keywords, this worker is triggered and the worker's `method` method is called
|
||||
|
||||
### User Interface Configuration
|
||||
|
||||
In Settings - Environment Variables, add environment variables
|
||||
- ENABLE_ANOTHER_WORKER = true
|
||||
- ANOTHER_WORKER_LIST is the JSON array string mentioned above, no further explanation needed, see above for detailed description
|
||||
```json
|
||||
[
|
||||
{
|
||||
"binding":"AUTH_INBOX",
|
||||
"method":"rpcEmail",
|
||||
"keywords":[
|
||||
"验证码","激活码","激活链接","确认链接","验证邮箱","确认邮件","账号激活","邮件验证","账户确认","安全码","认证码","安全验证","登陆码","确认码","启用账户","激活账户","账号验证","注册确认",
|
||||
"account","activation","verify","verification","activate","confirmation","email","code","validate","registration","login","code","expire","confirm"
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||

|
||||
|
||||
## Testing
|
||||
|
||||
Send an email to the temporary mailbox, observe the worker logs, or check the verification code on the panel provided by auth-inbox
|
||||
|
||||

|
||||
60
vitepress-docs/docs/en/guide/feature/config-smtp-proxy.md
Normal file
60
vitepress-docs/docs/en/guide/feature/config-smtp-proxy.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# Setting Up SMTP IMAP Proxy Service
|
||||
|
||||
::: warning Notice
|
||||
If you are using `resend`, you can directly use `resend`'s `SMTP` service without needing this service
|
||||
:::
|
||||
|
||||
## Why Do You Need SMTP IMAP Proxy Service
|
||||
|
||||
`SMTP` and `IMAP` have a wider range of application scenarios
|
||||
|
||||
## How to Set Up SMTP IMAP Proxy Service
|
||||
|
||||
### Local Run
|
||||
|
||||
```bash
|
||||
cd smtp_proxy_server/
|
||||
# Copy configuration file and modify it
|
||||
# Your worker address, proxy_url=https://temp-email-api.xxx.xxx
|
||||
# Your SMTP service port, port=8025
|
||||
cp .env.example .env
|
||||
python3 -m venv venv
|
||||
./venv/bin/python3 -m pip install -r requirements.txt
|
||||
./venv/bin/python3 main.py
|
||||
```
|
||||
|
||||
### Docker Run
|
||||
|
||||
```bash
|
||||
cd smtp_proxy_server/
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Modify the environment variables in docker-compose.yaml, note to choose the appropriate `tag`
|
||||
|
||||
`proxy_url` is the URL address of the `worker`
|
||||
|
||||
```yaml
|
||||
services:
|
||||
smtp_proxy_server:
|
||||
image: ghcr.io/dreamhunter2333/cloudflare_temp_email/smtp_proxy_server:latest
|
||||
# build:
|
||||
# context: .
|
||||
# dockerfile: dockerfile
|
||||
container_name: "smtp_proxy_server"
|
||||
ports:
|
||||
- "8025:8025"
|
||||
- "11143:11143"
|
||||
environment:
|
||||
- proxy_url=https://temp-email-api.xxx.xxx
|
||||
- port=8025
|
||||
- imap_port=11143
|
||||
```
|
||||
|
||||
## Using Thunderbird to Login
|
||||
|
||||
Download [Thunderbird](https://www.thunderbird.net/en-US/)
|
||||
|
||||
For password, enter the `email address credential`
|
||||
|
||||

|
||||
29
vitepress-docs/docs/en/guide/feature/google-ads.md
Normal file
29
vitepress-docs/docs/en/guide/feature/google-ads.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Adding Google Ads to Your Website
|
||||
|
||||
## Command Line Deployment
|
||||
|
||||
Modify the `.env.prod` file
|
||||
|
||||
Add the following two variables, refer to [Google AdSense](https://www.google.com/adsense/start/) for specific values
|
||||
|
||||
```txt
|
||||
VITE_GOOGLE_AD_CLIENT=ca-pub-123456
|
||||
VITE_GOOGLE_AD_SLOT=123456
|
||||
```
|
||||
|
||||
Then execute the following commands to redeploy pages.
|
||||
|
||||
```bash
|
||||
pnpm build --emptyOutDir
|
||||
# For first deployment, you'll be prompted to create a project, fill in production for the production branch
|
||||
pnpm run deploy
|
||||
```
|
||||
|
||||
## GitHub Action Deployment
|
||||
|
||||
Modify `FRONTEND_ENV`, add the following two variables, refer to [Google AdSense](https://www.google.com/adsense/start/) for specific values, then redeploy pages.
|
||||
|
||||
```txt
|
||||
VITE_GOOGLE_AD_CLIENT=ca-pub-123456
|
||||
VITE_GOOGLE_AD_SLOT=123456
|
||||
```
|
||||
68
vitepress-docs/docs/en/guide/feature/mail-api.md
Normal file
68
vitepress-docs/docs/en/guide/feature/mail-api.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# Mail API
|
||||
|
||||
## Viewing Emails via Mail API
|
||||
|
||||
This is a `python` example using the `requests` library to view emails.
|
||||
|
||||
```python
|
||||
limit = 10
|
||||
offset = 0
|
||||
res = requests.get(
|
||||
f"https://<your-worker-address>/api/mails?limit={limit}&offset={offset}",
|
||||
headers={
|
||||
"Authorization": f"Bearer {your-JWT-password}",
|
||||
# "x-custom-auth": "<your-website-password>", # If custom password is enabled
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Admin Mail API
|
||||
|
||||
Supports `address` filter
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
url = "https://<your-worker-address>/admin/mails"
|
||||
|
||||
querystring = {
|
||||
"limit":"20",
|
||||
"offset":"0",
|
||||
# address is optional parameter
|
||||
"address":"xxxx@awsl.uk"
|
||||
}
|
||||
|
||||
headers = {"x-admin-auth": "<your-Admin-password>"}
|
||||
|
||||
response = requests.get(url, headers=headers, params=querystring)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
**Note**: Keyword filtering has been removed from the backend API. If you need to filter emails by content, please use the frontend filter input in the UI, which filters the currently displayed page.
|
||||
|
||||
## User Mail API
|
||||
|
||||
Supports `address` filter
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
url = "https://<your-worker-address>/user_api/mails"
|
||||
|
||||
querystring = {
|
||||
"limit":"20",
|
||||
"offset":"0",
|
||||
# address is optional parameter
|
||||
"address":"xxxx@awsl.uk"
|
||||
}
|
||||
|
||||
headers = {"x-admin-auth": "<your-Admin-password>"}
|
||||
|
||||
response = requests.get(url, headers=headers, params=querystring)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
**Note**: Keyword filtering has been removed from the backend API. If you need to filter emails by content, please use the frontend filter input in the UI, which filters the currently displayed page.
|
||||
@@ -0,0 +1,82 @@
|
||||
# mail-parser-wasm-worker
|
||||
|
||||
> [!NOTE]
|
||||
> If you are using webhook forwarding or telegram bot to receive emails, but the email content is garbled or cannot be parsed, and you have higher requirements for parsing, you can use this feature.
|
||||
|
||||
## UI Deployment
|
||||
|
||||
1. Download [worker-with-wasm-mail-parser.zip](https://github.com/dreamhunter2333/cloudflare_temp_email/releases/latest/download/worker-with-wasm-mail-parser.zip)
|
||||
|
||||
2. Go back to `Overview`, find the worker you just created, click `Edit Code`, delete the original files, upload `worker.js` and files with `wasm` extension, click `Deploy`
|
||||
|
||||
> [!NOTE]
|
||||
> To upload, first click Explorer in the left menu,
|
||||
> Right-click in the file list window and find `Upload` in the context menu,
|
||||
> Please refer to the screenshot below
|
||||
>
|
||||
> Reference: [issues156](https://github.com/dreamhunter2333/cloudflare_temp_email/issues/156#issuecomment-2079453822)
|
||||
|
||||

|
||||

|
||||
|
||||
## CLI Deployment
|
||||
|
||||
### Modify Code
|
||||
|
||||
```bash
|
||||
cd worker
|
||||
pnpm add mail-parser-wasm-worker
|
||||
```
|
||||
|
||||
Edit `worker/src/common.ts`, uncomment this code to use mail-parser-wasm-worker to parse emails
|
||||
|
||||
```ts
|
||||
export const commonParseMail = async (raw_mail: string | undefined | null): Promise<{
|
||||
sender: string,
|
||||
subject: string,
|
||||
text: string,
|
||||
html: string
|
||||
} | undefined> => {
|
||||
if (!raw_mail) {
|
||||
return undefined;
|
||||
}
|
||||
// Uncomment this code to use mail-parser-wasm-worker to parse emails start
|
||||
// TODO: WASM parse email
|
||||
try {
|
||||
const { parse_message_wrapper } = await import('mail-parser-wasm-worker');
|
||||
|
||||
const parsedEmail = parse_message_wrapper(raw_mail);
|
||||
return {
|
||||
sender: parsedEmail.sender || "",
|
||||
subject: parsedEmail.subject || "",
|
||||
text: parsedEmail.text || "",
|
||||
headers: parsedEmail.headers || [],
|
||||
html: parsedEmail.body_html || "",
|
||||
};
|
||||
} catch (e) {
|
||||
console.error("Failed use mail-parser-wasm-worker to parse email", e);
|
||||
}
|
||||
// Uncomment this code to use mail-parser-wasm-worker to parse emails end
|
||||
try {
|
||||
const { default: PostalMime } = await import('postal-mime');
|
||||
const parsedEmail = await PostalMime.parse(raw_mail);
|
||||
return {
|
||||
sender: parsedEmail.from ? `${parsedEmail.from.name} <${parsedEmail.from.address}>` : "",
|
||||
subject: parsedEmail.subject || "",
|
||||
text: parsedEmail.text || "",
|
||||
html: parsedEmail.html || "",
|
||||
};
|
||||
}
|
||||
catch (e) {
|
||||
console.error("Failed use PostalMime to parse email", e);
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
||||
```bash
|
||||
cd worker
|
||||
pnpm run deploy
|
||||
```
|
||||
92
vitepress-docs/docs/en/guide/feature/new-address-api.md
Normal file
92
vitepress-docs/docs/en/guide/feature/new-address-api.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# Create New Email Address API
|
||||
|
||||
## Create Email Address via Admin API
|
||||
|
||||
This is a `python` example using the `requests` library to send emails.
|
||||
|
||||
```python
|
||||
res = requests.post(
|
||||
# Replace xxxx.xxxx with your worker domain
|
||||
"https://xxxx.xxxx/admin/new_address",
|
||||
json={
|
||||
# Enable prefix (True/False)
|
||||
"enablePrefix": True,
|
||||
"name": "<email_name>",
|
||||
"domain": "<email_domain>",
|
||||
},
|
||||
headers={
|
||||
'x-admin-auth': "<your_website_admin_password>",
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
)
|
||||
|
||||
# Returns {"jwt": "<Jwt>"}
|
||||
print(res.json())
|
||||
```
|
||||
|
||||
## Batch Create Random Username Email Addresses API Example
|
||||
|
||||
### Batch Create Email Addresses via Admin API
|
||||
|
||||
This is a `python` example using the `requests` library to send emails.
|
||||
|
||||
```python
|
||||
import requests
|
||||
import random
|
||||
import string
|
||||
from concurrent.futures import ThreadPoolExecutor, as_completed
|
||||
|
||||
|
||||
def generate_random_name():
|
||||
# Generate 5 lowercase letters
|
||||
letters1 = ''.join(random.choices(string.ascii_lowercase, k=5))
|
||||
# Generate 1-3 digits
|
||||
numbers = ''.join(random.choices(string.digits, k=random.randint(1, 3)))
|
||||
# Generate 1-3 lowercase letters
|
||||
letters2 = ''.join(random.choices(string.ascii_lowercase, k=random.randint(1, 3)))
|
||||
# Combine into final name
|
||||
return letters1 + numbers + letters2
|
||||
|
||||
|
||||
def fetch_email_data(name):
|
||||
try:
|
||||
res = requests.post(
|
||||
"https://<worker_domain>/admin/new_address",
|
||||
json={
|
||||
"enablePrefix": True,
|
||||
"name": name,
|
||||
"domain": "<email_domain>",
|
||||
},
|
||||
headers={
|
||||
'x-admin-auth': "<your_website_admin_password>",
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
)
|
||||
|
||||
if res.status_code == 200:
|
||||
response_data = res.json()
|
||||
email = response_data.get("address", "no address")
|
||||
jwt = response_data.get("jwt", "no jwt")
|
||||
return f"{email}----{jwt}\n"
|
||||
else:
|
||||
print(f"Request failed, status code: {res.status_code}")
|
||||
return None
|
||||
except requests.RequestException as e:
|
||||
print(f"Request error: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def generate_and_save_emails(num_emails):
|
||||
with ThreadPoolExecutor(max_workers=30) as executor, open('email.txt', 'a') as file:
|
||||
futures = [executor.submit(fetch_email_data, generate_random_name()) for _ in range(num_emails)]
|
||||
|
||||
for future in as_completed(futures):
|
||||
result = future.result()
|
||||
if result:
|
||||
file.write(result)
|
||||
|
||||
|
||||
# Generate 10 emails and append to existing file
|
||||
generate_and_save_emails(10)
|
||||
|
||||
```
|
||||
34
vitepress-docs/docs/en/guide/feature/s3-attachment.md
Normal file
34
vitepress-docs/docs/en/guide/feature/s3-attachment.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Configure S3 Attachments
|
||||
|
||||
## Configuration
|
||||
|
||||
> [!NOTE]
|
||||
> If you don't need S3 attachments, you can skip this step
|
||||
|
||||
Create an R2 bucket in Cloudflare. You can also use other S3 services (please submit an issue if you encounter bugs).
|
||||
|
||||
Reference: [Configure Cloudflare R2 cors](https://developers.cloudflare.com/r2/buckets/cors/#add-cors-policies-from-the-dashboard)
|
||||
|
||||
Reference: [Cloudflare R2 s3 token](https://developers.cloudflare.com/r2/api/s3/tokens/) to create a token, obtain `ENDPOINT`, `Access Key ID` and `Secret Access Key`, then execute the following commands to add them to secrets
|
||||
|
||||
> [!NOTE]
|
||||
> You can also add `secrets` in the Cloudflare worker UI interface
|
||||
|
||||
```bash
|
||||
cd worker
|
||||
pnpm wrangler secret put S3_ENDPOINT
|
||||
pnpm wrangler secret put S3_ACCESS_KEY_ID
|
||||
pnpm wrangler secret put S3_SECRET_ACCESS_KEY
|
||||
# Note: Replace bucket with your bucket name
|
||||
pnpm wrangler secret put S3_BUCKET
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Save attachment
|
||||
|
||||

|
||||
|
||||
Download attachment
|
||||
|
||||

|
||||
67
vitepress-docs/docs/en/guide/feature/send-mail-api.md
Normal file
67
vitepress-docs/docs/en/guide/feature/send-mail-api.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Send Email API
|
||||
|
||||
## Send Email via HTTP API
|
||||
|
||||
This is a `python` example using the `requests` library to send emails.
|
||||
|
||||
```python
|
||||
send_body = {
|
||||
"from_name": "Sender Name",
|
||||
"to_name": "Recipient Name",
|
||||
"to_mail": "Recipient Address",
|
||||
"subject": "Email Subject",
|
||||
"is_html": False, # Set whether it's HTML based on content
|
||||
"content": "<Email content: html or text>",
|
||||
}
|
||||
|
||||
res = requests.post(
|
||||
"http://localhost:8787/api/send_mail",
|
||||
json=send_body, headers={
|
||||
"Authorization": f"Bearer {your_JWT_password}",
|
||||
# "x-custom-auth": "<your_website_password>", # If custom password is enabled
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
)
|
||||
|
||||
# Using body authentication
|
||||
send_body = {
|
||||
"token": "<your_JWT_password>",
|
||||
"from_name": "Sender Name",
|
||||
"to_name": "Recipient Name",
|
||||
"to_mail": "Recipient Address",
|
||||
"subject": "Email Subject",
|
||||
"is_html": False, # Set whether it's HTML based on content
|
||||
"content": "<Email content: html or text>",
|
||||
}
|
||||
res = requests.post(
|
||||
"http://localhost:8787/external/api/send_mail",
|
||||
json=send_body, headers={
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
## Send Email via SMTP
|
||||
|
||||
Please first refer to [Configure SMTP Proxy](/en/guide/feature/config-smtp-proxy.html).
|
||||
|
||||
This is a `python` example using the `smtplib` library to send emails.
|
||||
|
||||
`JWT Token Password`: This is the email login password, which can be viewed in the password menu in the UI interface.
|
||||
|
||||
```python
|
||||
import smtplib
|
||||
|
||||
from email.mime.text import MIMEText
|
||||
from email.mime.multipart import MIMEMultipart
|
||||
|
||||
|
||||
with smtplib.SMTP('localhost', 8025) as smtp:
|
||||
smtp.login("jwt", "Enter your JWT token password here")
|
||||
message = MIMEMultipart()
|
||||
message['From'] = "Me <me@awsl.uk>"
|
||||
message['To'] = "Admin <admin@awsl.uk>"
|
||||
message['Subject'] = "Test Subject"
|
||||
message.attach(MIMEText("Test Content", 'html'))
|
||||
smtp.sendmail("me@awsl.uk", "admin@awsl.uk", message.as_string())
|
||||
```
|
||||
11
vitepress-docs/docs/en/guide/feature/subdomain.md
Normal file
11
vitepress-docs/docs/en/guide/feature/subdomain.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Configure Subdomain Email
|
||||
|
||||
::: warning Note
|
||||
Subdomain emails may not be able to send emails. It is recommended to use main domain emails for sending and subdomain emails only for receiving.
|
||||
|
||||
Mail channel is no longer supported. The reference below is limited to the receiving part only.
|
||||
:::
|
||||
|
||||
Reference
|
||||
|
||||
- [Configure Subdomain Email](https://github.com/dreamhunter2333/cloudflare_temp_email/issues/164#issuecomment-2082612710)
|
||||
85
vitepress-docs/docs/en/guide/feature/telegram.md
Normal file
85
vitepress-docs/docs/en/guide/feature/telegram.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Configure Telegram Bot
|
||||
|
||||
Try it here: [@cf_temp_mail_bot](https://t.me/cf_temp_mail_bot)
|
||||
|
||||
::: warning Note
|
||||
The default `worker.dev` domain certificate for worker is not supported by Telegram. Please use a custom domain when configuring Telegram Bot.
|
||||
:::
|
||||
|
||||
> [!NOTE]
|
||||
> If you want to use Telegram Bot, please bind `KV` first
|
||||
>
|
||||
> If you don't need Telegram Bot, you can skip this step
|
||||
>
|
||||
> If you want Telegram to have stronger email parsing capabilities, refer to [Configure worker to use wasm for email parsing](/en/guide/feature/mail_parser_wasm_worker)
|
||||
|
||||
## Telegram Bot Configuration
|
||||
|
||||
Please first create a Telegram Bot, obtain the `token`, then execute the following command to add the `token` to secrets
|
||||
|
||||
> [!NOTE]
|
||||
> If you find it troublesome, you can also put it in plain text under `[vars]` in `wrangler.toml`, but this is not recommended
|
||||
|
||||
If you deployed via UI, you can add it under `Variables and Secrets` in the Cloudflare UI interface
|
||||
|
||||
```bash
|
||||
# Switch to worker directory
|
||||
cd worker
|
||||
pnpm wrangler secret put TELEGRAM_BOT_TOKEN
|
||||
```
|
||||
|
||||
## Bot
|
||||
|
||||
- Can set whitelist users
|
||||
- Click `Initialize` to complete the configuration.
|
||||
- Click `View Status` to check the current configuration status.
|
||||
|
||||

|
||||
|
||||
## Language Switching
|
||||
|
||||
> [!NOTE]
|
||||
> This feature is available since v1.2.0
|
||||
|
||||
Telegram Bot supports Chinese and English switching. Users can set their language preference via the `/lang` command.
|
||||
|
||||
### Enable Language Switching
|
||||
|
||||
You need to configure `TG_ALLOW_USER_LANG = true` in worker variables to enable this feature.
|
||||
|
||||
### Usage
|
||||
|
||||
- `/lang zh` - Switch to Chinese
|
||||
- `/lang en` - Switch to English
|
||||
- `/lang` - View current language setting
|
||||
|
||||
Language preferences are saved to KV, and each user can set their preference independently.
|
||||
|
||||
## Mini App
|
||||
|
||||
Can be deployed via command line or UI interface
|
||||
|
||||
### UI Deployment
|
||||
|
||||
For other steps, refer to `Frontend and Backend Separation Deployment` in [UI Deployment](/en/guide/cli/pages)
|
||||
|
||||
> [!NOTE]
|
||||
> Download the zip from here, [telegram-frontend.zip](https://github.com/dreamhunter2333/cloudflare_temp_email/releases/latest/download/telegram-frontend.zip)
|
||||
>
|
||||
> Modify the index-xxx.js file in the zip, where xx is a random string
|
||||
>
|
||||
> Search for `https://temp-email-api.xxx.xxx`, replace it with your worker domain, then deploy the new zip file
|
||||
|
||||
### Command Line Deployment
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
pnpm install
|
||||
cp .env.example .env.prod
|
||||
# --project-name can create a separate pages for mini app, you can also share one pages, but may encounter js loading issues
|
||||
pnpm run deploy:telegram --project-name=<your_project_name>
|
||||
```
|
||||
|
||||
- After deployment, please fill in the web URL in the `Settings` -> `Telegram Mini App` page `Telegram Mini App URL` in the admin backend.
|
||||
- Please execute `/setmenubutton` in `@BotFather`, then enter your web address to set the `Open App` button in the lower left corner.
|
||||
- Please execute `/newapp` in `@BotFather` to create a new app and register the mini app.
|
||||
26
vitepress-docs/docs/en/guide/feature/user-oauth2.md
Normal file
26
vitepress-docs/docs/en/guide/feature/user-oauth2.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# OAuth2 Third-Party Login
|
||||
|
||||
> [!WARNING] Note
|
||||
> Third-party login will automatically register an account using the user's email (emails with the same address will be considered the same account)
|
||||
>
|
||||
> This account is the same as a registered account and can also set a password through the forgot password feature
|
||||
|
||||
## Register OAuth2 on Third-Party Platforms
|
||||
|
||||
### GitHub
|
||||
|
||||
- Please first create an OAuth App, then obtain the `Client ID` and `Client Secret`
|
||||
|
||||
Reference: [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
|
||||
|
||||
### Authentik
|
||||
|
||||
- [Authentik OAuth2 Provider](https://docs.goauthentik.io/docs/providers/oauth2/)
|
||||
|
||||
## Configure OAuth2 in Admin Backend
|
||||
|
||||

|
||||
|
||||
## Test User Login Page
|
||||
|
||||

|
||||
44
vitepress-docs/docs/en/guide/feature/webhook.md
Normal file
44
vitepress-docs/docs/en/guide/feature/webhook.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Configure Webhook
|
||||
|
||||
> [!NOTE]
|
||||
> If you want to use webhook, please bind `KV` first and configure the `worker` variable `ENABLE_WEBHOOK = true`
|
||||
>
|
||||
> If you want webhook to have stronger email parsing capabilities, refer to [Configure worker to use wasm for email parsing](/en/guide/feature/mail_parser_wasm_worker)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You need to set up your own `webhook service` or use a `third-party platform`. This service needs to be able to receive `POST` requests and parse `json` data.
|
||||
|
||||
This project uses [songquanpeng/message-pusher](https://github.com/songquanpeng/message-pusher) as an example webhook service.
|
||||
|
||||
- You can use the service provided by [msgpusher.com](https://msgpusher.com)
|
||||
- You can also self-host the `message-pusher` service, refer to [songquanpeng/message-pusher](https://github.com/songquanpeng/message-pusher)
|
||||
|
||||
## Admin Configure Global Webhook
|
||||
|
||||

|
||||
|
||||
## Admin Allow Email to Use Webhook
|
||||
|
||||

|
||||
|
||||
## Configure Webhook for a Specific Email
|
||||
|
||||

|
||||
|
||||
## Webhook Data Format
|
||||
|
||||
To get the url, you need to configure the worker's `FRONTEND_URL` to your frontend address, or you can construct the url yourself using `id` = `${FRONTEND_URL}?mail_id=${id}`
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "${id}",
|
||||
"url": "${url}",
|
||||
"from": "${from}",
|
||||
"to": "${to}",
|
||||
"subject": "${subject}",
|
||||
"raw": "${raw}",
|
||||
"parsedText": "${parsedText}",
|
||||
"parsedHtml": "${parsedHtml}",
|
||||
}
|
||||
```
|
||||
42
vitepress-docs/docs/en/guide/quick-start.md
Normal file
42
vitepress-docs/docs/en/guide/quick-start.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Quick Start
|
||||
|
||||
## Before You Begin
|
||||
|
||||
You need a `good network environment` and a `Cloudflare account`. Open the [Cloudflare Dashboard](https://dash.cloudflare.com/)
|
||||
|
||||
Please choose one of the three deployment methods below:
|
||||
|
||||
- [Deploy via Command Line](/en/guide/cli/pre-requisite)
|
||||
- [Deploy via User Interface](/en/guide/ui/d1)
|
||||
- [Deploy via Github Actions](/en/guide/actions/pre-requisite)
|
||||
|
||||
### You can also refer to detailed tutorials provided by the community
|
||||
|
||||
- [【Tutorial】Beginner-Friendly Guide to Building Your Own Cloudflare Temporary Email (Domain Email)](https://linux.do/t/topic/316819/1)
|
||||
|
||||
## Upgrade Process
|
||||
|
||||
First, confirm your current version, then visit the [Release page](https://github.com/dreamhunter2333/cloudflare_temp_email/releases/) and [CHANGELOG page](https://github.com/dreamhunter2333/cloudflare_temp_email/blob/main/CHANGELOG.md) to find your current version.
|
||||
|
||||
> [!WARNING] Warning
|
||||
> Pay attention to `Breaking Changes` which require `database SQL execution` or `configuration changes`.
|
||||
|
||||
Then review all changes from your current version onwards. Note that `Breaking Changes` require `database SQL execution` or `configuration changes`, while other feature updates can be configured as needed.
|
||||
|
||||
Then refer to the documentation below to use `CLI` or `UI` to redeploy the `worker` and `pages` over the previous deployment.
|
||||
|
||||
### CLI Deployment
|
||||
|
||||
- [Update D1 via Command Line](/en/guide/cli/d1)
|
||||
- [Deploy Worker via Command Line](/en/guide/cli/worker)
|
||||
- [Deploy Pages via Command Line](/en/guide/cli/pages)
|
||||
|
||||
### UI Deployment
|
||||
|
||||
- [Update D1 via User Interface](/en/guide/ui/d1)
|
||||
- [Deploy Worker via User Interface](/en/guide/ui/worker)
|
||||
- [Deploy Pages via User Interface](/en/guide/ui/pages)
|
||||
|
||||
### Github Actions Deployment
|
||||
|
||||
- [How to Configure Auto-Update with Github Actions](/en/guide/actions/auto-update)
|
||||
7
vitepress-docs/docs/en/guide/star-history.md
Normal file
7
vitepress-docs/docs/en/guide/star-history.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Star History
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=dreamhunter2333/cloudflare_temp_email&type=Date&theme=dark" />
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=dreamhunter2333/cloudflare_temp_email&type=Date" />
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=dreamhunter2333/cloudflare_temp_email&type=Date" />
|
||||
</picture>
|
||||
31
vitepress-docs/docs/en/guide/ui/d1.md
Normal file
31
vitepress-docs/docs/en/guide/ui/d1.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Initialize/Update D1 Database
|
||||
|
||||
## Create Database
|
||||
|
||||
Open the Cloudflare console, select `Storage & Databases` -> `D1 SQL Database` -> `Create Database`, and click to create the database.
|
||||
|
||||

|
||||
|
||||
After creation, we can see the D1 database in the Cloudflare console.
|
||||
|
||||
## Initialize Database
|
||||
|
||||
::: warning Note
|
||||
You can also skip initializing the database and after deployment is complete, go to the admin page's `Quick Setup` -> `Database` section and click the `Initialize Database` button to initialize the database.
|
||||
:::
|
||||
|
||||
Open the `Console` tab, enter the content from the [db/schema.sql](https://github.com/dreamhunter2333/cloudflare_temp_email/blob/main/db/schema.sql) file in the repository, and click `Execute` to run it.
|
||||
|
||||

|
||||
|
||||
## Update Database Schema
|
||||
|
||||
For `schema` updates, please confirm the version you previously deployed.
|
||||
|
||||
Check the [Changelog](https://github.com/dreamhunter2333/cloudflare_temp_email/blob/main/CHANGELOG.md)
|
||||
|
||||
Find the `patch` file that needs to be executed, for example: `db/2024-01-13-patch.sql`
|
||||
|
||||
Open the `Console` tab, enter the content of the `patch` file, and click `Execute` to run it.
|
||||
|
||||

|
||||
105
vitepress-docs/docs/en/guide/ui/pages.md
Normal file
105
vitepress-docs/docs/en/guide/ui/pages.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Cloudflare Pages Frontend
|
||||
|
||||
<script setup>
|
||||
import { ref } from 'vue'
|
||||
import JSZip from 'jszip';
|
||||
|
||||
const domain = ref("")
|
||||
const downloadUrl = ref("")
|
||||
const tip = ref("Download")
|
||||
|
||||
const generate = async () => {
|
||||
try {
|
||||
const response = await fetch("/ui_install/frontend.zip");
|
||||
const arrayBuffer = await response.arrayBuffer();
|
||||
var zip = new JSZip();
|
||||
await zip.loadAsync(arrayBuffer);
|
||||
let target_content = ""
|
||||
let target_path = ""
|
||||
const directory = zip.folder("assets");
|
||||
if (directory) {
|
||||
for (const [relativePath, zipEntry] of Object.entries(directory.files)) {
|
||||
console.log(relativePath);
|
||||
if (relativePath.startsWith("assets/index-") && relativePath.endsWith(".js")){
|
||||
let content = await zipEntry.async("string");
|
||||
content = content.replace("https://temp-email-api.xxx.xxx", domain.value);
|
||||
target_path = relativePath;
|
||||
zip.file(relativePath, content);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!target_path) {
|
||||
tip.value = "Generation failed";
|
||||
downloadUrl.value = '';
|
||||
}
|
||||
const blob = await zip.generateAsync({ type: "blob" });
|
||||
const url = window.URL.createObjectURL(blob);
|
||||
downloadUrl.value = url;
|
||||
} catch (error) {
|
||||
console.error("Error: ", error);
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
1. Click `Compute (Workers)` -> `Workers & Pages` -> `Create`
|
||||
|
||||

|
||||
|
||||
2. Select `Pages`, choose `Use direct upload`
|
||||
|
||||

|
||||
|
||||
3. Enter the address of the deployed worker. The address should not include a trailing `/`. Click generate, and if successful, a download button will appear. You will get a zip package.
|
||||
- The worker domain here is the backend API domain. For example, if I deployed at `https://temp-email-api.awsl.uk`, then fill in `https://temp-email-api.awsl.uk`
|
||||
- If your domain is `https://temp-email-api.xxx.workers.dev`, then fill in `https://temp-email-api.xxx.workers.dev`
|
||||
|
||||
> [!warning] Note
|
||||
> The `worker.dev` domain is not accessible in China, please use a custom domain.
|
||||
|
||||
<div :class="$style.container">
|
||||
<input :class="$style.input" type="text" v-model="domain" placeholder="Please enter address"></input>
|
||||
<button :class="$style.button" @click="generate">Generate</button>
|
||||
<a v-if="downloadUrl" :href="downloadUrl" download="frontend.zip">{{ tip }}</a>
|
||||
</div>
|
||||
|
||||
> [!NOTE]
|
||||
> You can also deploy manually. Download the zip from here: [frontend.zip](https://github.com/dreamhunter2333/cloudflare_temp_email/releases/latest/download/frontend.zip)
|
||||
>
|
||||
> Modify the index-xxx.js file in the archive, where xx is a random string
|
||||
>
|
||||
> Search for `https://temp-email-api.xxx.xxx` and replace it with your worker's domain, then deploy the new zip file
|
||||
|
||||
4. Select `Pages`, click `Create Pages`, modify the name, upload the downloaded zip package, and then click `Deploy`
|
||||
|
||||

|
||||
|
||||
5. Open the `Pages` you just deployed, click `Custom Domain`. Here you can add your own domain, or you can use the automatically generated `*.pages.dev` domain. If you can open the domain, the deployment is successful.
|
||||
|
||||

|
||||
|
||||
<style module>
|
||||
.container {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
height: 100%;
|
||||
}
|
||||
.input {
|
||||
border: 2px solid deepskyblue;
|
||||
margin-right: 10px;
|
||||
width: 75%;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
.button {
|
||||
background-color: deepskyblue;
|
||||
padding: 5px 10px;
|
||||
border-radius: 5px;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
.button:hover {
|
||||
background-color: green;
|
||||
}
|
||||
</style>
|
||||
107
vitepress-docs/docs/en/guide/ui/worker.md
Normal file
107
vitepress-docs/docs/en/guide/ui/worker.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# Cloudflare Workers Backend
|
||||
|
||||
> [!warning] Note
|
||||
> The `worker.dev` domain is not accessible in China, please use a custom domain.
|
||||
|
||||
1. Click `Compute (Workers)` -> `Workers & Pages` -> `Create`
|
||||
|
||||

|
||||
|
||||
2. Select `Worker`, click `Create Worker`, modify the name and then click `Deploy`
|
||||
|
||||

|
||||

|
||||
|
||||
3. Go back to `Workers & Pages`, find the worker you just created, click `Settings` -> `Runtime`, modify `Compatibility flags`, manually add `nodejs_compat`, and the compatibility date also needs to be later than the date shown in the image.
|
||||
|
||||

|
||||
|
||||
4. Download [worker.js](https://github.com/dreamhunter2333/cloudflare_temp_email/releases/latest/download/worker.js)
|
||||
|
||||
5. Go back to `Overview`, find the worker you just created, click `Edit Code`, delete the original file, upload `worker.js`, and click `Deploy`
|
||||
|
||||
> [!NOTE]
|
||||
> To upload, first click Explorer in the left menu,
|
||||
> then right-click in the file list window and find `Upload` in the context menu,
|
||||
> please refer to the screenshots below
|
||||
>
|
||||
> Reference: [issues156](https://github.com/dreamhunter2333/cloudflare_temp_email/issues/156#issuecomment-2079453822)
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
6. Click `Settings` -> `Variables and Secrets`, add variables as shown in the image
|
||||
|
||||

|
||||
|
||||
> [!NOTE] Note
|
||||
> For more variable configuration, please see [Worker Variables Documentation](/en/guide/worker-vars)
|
||||
>
|
||||
> Note that the outermost quotes are not needed for string format variables
|
||||
>
|
||||
> For `USER_ROLES`, please configure in this format: `[{"domains":["awsl.uk","dreamhunter2333.xyz"],"role":"vip","prefix":"vip"},{"domains":["awsl.uk","dreamhunter2333.xyz"],"role":"admin","prefix":""}]`
|
||||
|
||||
Recommended variable list
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| -------------------------- | ----------- | ---------------------------------------------------------------------- | ------------------------------------ |
|
||||
| `PREFIX` | Text | Default prefix for new email names, can be omitted if no prefix needed | `tmp` |
|
||||
| `DOMAINS` | JSON | All domains for temporary email, supports multiple domains | `["awsl.uk", "dreamhunter2333.xyz"]` |
|
||||
| `JWT_SECRET` | Text/Secret | Secret for generating JWT, JWT is used for login and authentication | `xxx` |
|
||||
| `ADMIN_PASSWORDS` | JSON | Admin console password, console access not allowed if not configured | `["123", "456"]` |
|
||||
| `ENABLE_USER_CREATE_EMAIL` | Text/JSON | Whether to allow users to create emails, not allowed if not configured | `true` |
|
||||
| `ENABLE_USER_DELETE_EMAIL` | Text/JSON | Whether to allow users to delete emails, not allowed if not configured | `true` |
|
||||
|
||||
7. Click `Settings` -> `Bindings`, click `Add Binding`, enter the name as shown, select the D1 database you just created, and click `Add Binding`
|
||||
|
||||
> [!NOTE] Important
|
||||
> Note that the binding name for `D1 Database` here must be `DB`
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
8. Click `Settings` -> `Triggers`, here you can add your own domain, or you can use the automatically generated `*.workers.dev` domain. Record this domain, as it will be needed when deploying the frontend later.
|
||||
|
||||
> [!NOTE]
|
||||
> Open the `worker` `url`, if it displays `OK`, the deployment is successful
|
||||
>
|
||||
> Open `/health_check`, if it displays `OK`, the deployment is successful
|
||||
|
||||

|
||||
|
||||
9. If you want to enable the user registration feature and need to send email verification, you need to create a `KV` cache. You can skip this step if not needed.
|
||||
|
||||
> [!NOTE] Important
|
||||
> If you want to enable the user registration feature and need to send email verification, you need to create a `KV` cache. You can skip this step if not needed.
|
||||
>
|
||||
> Note that the binding name for `KV` here must be `KV`
|
||||
|
||||
Click `Storage & Databases` -> `KV` -> `Create Namespace`, as shown in the image, click `Create Namespace`
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Then click `Settings` -> `Bindings`, click `Add Binding`, enter the name as shown, select the KV you just created, and click `Add Binding`
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
10. Telegram Bot Configuration
|
||||
|
||||
> [!NOTE]
|
||||
> If you don't need Telegram Bot, you can skip this step
|
||||
|
||||
Please first create a Telegram Bot, then get the `token`, add the `token` to `Variables and Secrets`, variable name: `TELEGRAM_BOT_TOKEN`
|
||||
|
||||
11. If you want to use the scheduled task to clean emails in the admin page, you need to add a scheduled task in `Settings` -> `Trigger Events` -> `Cron Triggers`.
|
||||
|
||||
> [!NOTE]
|
||||
> Select `cron` expression, enter `0 0 * * *` (this expression means run daily at midnight), click `Add` to add. Please adjust this expression according to your needs.
|
||||
7
vitepress-docs/docs/en/guide/what-is-temp-mail.md
Normal file
7
vitepress-docs/docs/en/guide/what-is-temp-mail.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Introduction to Temporary Email
|
||||
|
||||
## What is Temporary Email
|
||||
|
||||
A temporary email, also known as disposable email or temporary email address, is a virtual mailbox used for temporarily receiving emails. Unlike regular mailboxes, temporary emails are designed to provide an anonymous and temporary email receiving solution.
|
||||
|
||||
Temporary emails are often provided by websites or online service providers. Users can use temporary email addresses when they need to register or receive verification emails, without exposing their real email address. The benefit of this is to protect personal privacy.
|
||||
171
vitepress-docs/docs/en/guide/worker-vars.md
Normal file
171
vitepress-docs/docs/en/guide/worker-vars.md
Normal file
@@ -0,0 +1,171 @@
|
||||
# Worker Variables
|
||||
|
||||
> [!NOTE] Note
|
||||
> For CLI deployment syntax, please refer to `worker/wrangler.toml.template`
|
||||
|
||||
## Required Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| -------------------------- | ----------- | ---------------------------------------------------------------------- | ------------------------------------ |
|
||||
| `DOMAINS` | JSON | All domains for temporary email, supports multiple domains | `["awsl.uk", "dreamhunter2333.xyz"]` |
|
||||
| `JWT_SECRET` | Text/Secret | Secret key for generating JWT, used for login and authentication | `xxx` |
|
||||
| `ADMIN_PASSWORDS` | JSON | Admin console passwords, console access disabled if not configured | `["123", "456"]` |
|
||||
| `ENABLE_USER_CREATE_EMAIL` | Text/JSON | Whether to allow users to create mailboxes, disabled if not configured | `true` |
|
||||
| `ENABLE_USER_DELETE_EMAIL` | Text/JSON | Whether to allow users to delete emails, disabled if not configured | `true` |
|
||||
|
||||
## Console Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| ------------------------------ | --------- | ------------------------------------------------------- | ---------------- |
|
||||
| `PASSWORDS` | JSON | Website private passwords, required after configuration | `["123", "456"]` |
|
||||
| `DISABLE_ADMIN_PASSWORD_CHECK` | Text/JSON | Warning: Admin console without password or user check | `false` |
|
||||
|
||||
## Email Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| ------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
|
||||
| `PREFIX` | Text | Default prefix for new `email address` names, can be left unconfigured if no prefix needed | `tmp` |
|
||||
| `MIN_ADDRESS_LEN` | Number | Minimum length of `email address` name | `1` |
|
||||
| `MAX_ADDRESS_LEN` | Number | Maximum length of `email address` name | `30` |
|
||||
| `DISABLE_CUSTOM_ADDRESS_NAME` | Text/JSON | Disable custom email address names, if set to true, users cannot enter custom names and they will be auto-generated | `true` |
|
||||
| `ADDRESS_CHECK_REGEX` | Text | Regular expression for `email address` name, used for validation only | `^(?!.*admin).*` |
|
||||
| `ADDRESS_REGEX` | Text | Regular expression to replace illegal symbols in `email address` name, symbols not in the regex will be replaced. Default is `[^a-z0-9]` if not set. Use with caution as some symbols may prevent email reception | `[^a-z0-9]` |
|
||||
| `DEFAULT_DOMAINS` | JSON | Default domains available to users (not logged in or users without assigned roles) | `["awsl.uk", "dreamhunter2333.xyz"]` |
|
||||
| `CREATE_ADDRESS_DEFAULT_DOMAIN_FIRST` | Text/JSON | Whether to prioritize default domain when creating new addresses, if set to true, will use the first domain when no domain is specified, mainly for telegram bot scenarios | `false` |
|
||||
| `DOMAIN_LABELS` | JSON | For Chinese domains, you can use DOMAIN_LABELS to display Chinese names | `["中文.awsl.uk", "dreamhunter2333.xyz"]` |
|
||||
| `ENABLE_AUTO_REPLY` | Text/JSON | Allow automatic email replies | `true` |
|
||||
| `DEFAULT_SEND_BALANCE` | Text/JSON | Default email sending balance, will be 0 if not set | `1` |
|
||||
| `ENABLE_ADDRESS_PASSWORD` | Text/JSON | Enable address password feature, when enabled, passwords will be auto-generated for new addresses, supports password login and modification | `true` |
|
||||
|
||||
## Email Reception Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| ------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
||||
| `BLACK_LIST` | Text | Blacklist for filtering senders, comma separated | `gov.cn,edu.cn` |
|
||||
| `ENABLE_CHECK_JUNK_MAIL` | Text/JSON | Whether to enable junk mail checking, used with the following two lists | `false` |
|
||||
| `JUNK_MAIL_CHECK_LIST` | JSON | Junk mail check configuration, marked as junk if any item `exists` and `fails` | `["spf", "dkim", "dmarc"]` |
|
||||
| `JUNK_MAIL_FORCE_PASS_LIST` | JSON | Junk mail check configuration, marked as junk if any item `does not exist` or `fails` | `["spf", "dkim", "dmarc"]` |
|
||||
| `FORWARD_ADDRESS_LIST` | JSON | Global forward address list, disabled if not configured, all emails will be forwarded to listed addresses when enabled | `["xxx@xxx.com"]` |
|
||||
| `REMOVE_EXCEED_SIZE_ATTACHMENT` | Text/JSON | If attachment exceeds 2MB, remove it, email may lose some information due to parsing | `true` |
|
||||
| `REMOVE_ALL_ATTACHMENT` | Text/JSON | Remove all attachments, email may lose some information due to parsing | `true` |
|
||||
|
||||
> [!NOTE]
|
||||
> `Junk mail checking` and `attachment removal` require email parsing, free tier CPU is limited, may cause large email parsing timeout
|
||||
>
|
||||
> If you want stronger email parsing capabilities
|
||||
>
|
||||
> Refer to [Configure worker to use wasm for email parsing](/en/guide/feature/mail_parser_wasm_worker)
|
||||
|
||||
## Webhook Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| ---------------- | --------- | ------------------------------------------------- | ------------------ |
|
||||
| `ENABLE_WEBHOOK` | Text/JSON | Whether to enable webhook | `true` |
|
||||
| `FRONTEND_URL` | Text | Frontend URL, used for sending webhook email URLs | `https://xxxx.xxx` |
|
||||
|
||||
> [!NOTE]
|
||||
> Webhook functionality requires email parsing, free tier CPU is limited, may cause large email parsing timeout
|
||||
>
|
||||
> If you want stronger email parsing capabilities
|
||||
>
|
||||
> Refer to [Configure worker to use wasm for email parsing](/en/guide/feature/mail_parser_wasm_worker)
|
||||
|
||||
## User Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| ------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------- | --------- |
|
||||
| `USER_DEFAULT_ROLE` | Text | Default role for new users, only effective when email verification is enabled | `vip` |
|
||||
| `ADMIN_USER_ROLE` | Text | Admin role configuration, if user role equals ADMIN_USER_ROLE, user can access admin console | `admin` |
|
||||
| `USER_ROLES` | JSON | - | See below |
|
||||
| `DISABLE_ANONYMOUS_USER_CREATE_EMAIL` | Text/JSON | Disable anonymous user mailbox creation, if set to true, users can only create addresses after login | `true` |
|
||||
| `NO_LIMIT_SEND_ROLE` | Text | Roles that can send unlimited emails, multiple roles separated by comma `vip,admin` | `vip` |
|
||||
|
||||
> [!NOTE] USER_ROLES User Role Configuration
|
||||
>
|
||||
> - If `domains` is empty, `DEFAULT_DOMAINS` will be used
|
||||
> - If prefix is null, the default prefix will be used, if prefix is an empty string, no prefix will be used
|
||||
>
|
||||
> When deploying through UI, configure `USER_ROLES` in this format: `[{"domains":["awsl.uk","dreamhunter2333.xyz"],"role":"vip","prefix":"vip"},{"domains":["awsl.uk","dreamhunter2333.xyz"],"role":"admin","prefix":""}]`
|
||||
>
|
||||
> When deploying via CLI, refer to `worker/wrangler.toml.template` and configure `USER_ROLES` in this format: `[{ domains = ["awsl.uk", "dreamhunter2333.xyz"], role = "vip", prefix = "vip" }, { domains = ["awsl.uk", "dreamhunter2333.xyz"], role = "admin", prefix = "" }]`
|
||||
|
||||
## Web Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| -------------------------- | ----------- | ------------------------------------------------------------------------ | --------------------- |
|
||||
| `DEFAULT_LANG` | Text | Worker error message default language, zh/en | `zh` |
|
||||
| `TITLE` | Text | Custom frontend page website title, supports html | `Custom Title` |
|
||||
| `ANNOUNCEMENT` | Text | Custom frontend page announcement, supports html | `Custom Announcement` |
|
||||
| `ALWAYS_SHOW_ANNOUNCEMENT` | Text/JSON | Whether to always show announcement (even if unchanged), default `false` | `true` |
|
||||
| `COPYRIGHT` | Text | Custom frontend footer text, supports html | `Dream Hunter` |
|
||||
| `ADMIN_CONTACT` | Text | Admin contact information, can be any string, hidden if not configured | `xxx@gmail.com` |
|
||||
| `DISABLE_SHOW_GITHUB` | Text/JSON | Whether to show GitHub link | `true` |
|
||||
| `CF_TURNSTILE_SITE_KEY` | Text/Secret | Turnstile CAPTCHA configuration | `xxx` |
|
||||
| `CF_TURNSTILE_SECRET_KEY` | Text/Secret | Turnstile CAPTCHA configuration | `xxx` |
|
||||
|
||||
## Telegram Bot Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| -------------------- | --------- | --------------------------------------------------------------------------- | ------- |
|
||||
| `TG_MAX_ADDRESS` | Number | Maximum number of mailboxes that can be bound to telegram bot | `5` |
|
||||
| `TG_BOT_INFO` | Text | Optional, telegram BOT_INFO, predefined BOT_INFO can reduce webhook latency | `{}` |
|
||||
| `TG_ALLOW_USER_LANG` | Text/JSON | Allow users to switch language via `/lang` command, default `false` | `true` |
|
||||
|
||||
> [!NOTE]
|
||||
> Telegram functionality requires email parsing, free tier CPU is limited, may cause large email parsing timeout
|
||||
>
|
||||
> If you want stronger email parsing capabilities
|
||||
>
|
||||
> Refer to [Configure worker to use wasm for email parsing](/en/guide/feature/mail_parser_wasm_worker)
|
||||
|
||||
## Email Forwarding Related Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| --------------------------------- | ---- | ---------------------------------------------------------------------------------------- | --------- |
|
||||
| `SUBDOMAIN_FORWARD_ADDRESS_LIST` | JSON | Subdomain/rule forwarding configuration, supports filtering by domain and source regex | See below |
|
||||
|
||||
> [!NOTE] SUBDOMAIN_FORWARD_ADDRESS_LIST Configuration
|
||||
>
|
||||
> v1.2.0 added `sourcePatterns` and `sourceMatchMode` fields for filtering by sender address regex:
|
||||
>
|
||||
> - `domains`: Target domain list, matches all domains if empty
|
||||
> - `forward`: Forward destination address
|
||||
> - `sourcePatterns`: Source address regex list (optional)
|
||||
> - `sourceMatchMode`: Match mode, `any` (match any, default) or `all` (match all)
|
||||
>
|
||||
> Regex pattern max length is 200 characters to prevent ReDoS attacks
|
||||
>
|
||||
> ```toml
|
||||
> SUBDOMAIN_FORWARD_ADDRESS_LIST = """
|
||||
> [
|
||||
> {"domains":[""],"forward":"xxx1@xxx.com"},
|
||||
> {"domains":["subdomain-1.domain.com","subdomain-2.domain.com"],"forward":"xxx2@xxx.com"},
|
||||
> {"domains":["example.com"],"forward":"admin@xxx.com","sourcePatterns":[".*@github.com",".*@gitlab.com"],"sourceMatchMode":"any"}
|
||||
> ]
|
||||
> """
|
||||
> ```
|
||||
|
||||
## Other Variables
|
||||
|
||||
| Variable Name | Type | Description | Example |
|
||||
| ----------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
|
||||
| `ENABLE_ANOTHER_WORKER` | Text/JSON | Whether to enable other workers to process emails | `false` |
|
||||
| `ANOTHER_WORKER_LIST` | JSON | - Configuration for other workers to process emails, multiple workers can be configured <br/> - Filter by keywords, call the bound worker's method (default method name is rpcEmail)<br/> - keywords are required, otherwise the worker will not be triggered | See below |
|
||||
|
||||
> [!NOTE]
|
||||
> `ANOTHER_WORKER_LIST` configuration example
|
||||
>
|
||||
> ```toml
|
||||
> #ANOTHER_WORKER_LIST ="""
|
||||
> #[
|
||||
> # {
|
||||
> # "binding":"AUTH_INBOX",
|
||||
> # "method":"rpcEmail",
|
||||
> # "keywords":[
|
||||
> # "验证码","激活码","激活链接","确认链接","验证邮箱","确认邮件","账号激活","邮件验证","账户确认","安全码","认证码","安全验证","登陆码","确认码","启用账户","激活账户","账号验证","注册确认",
|
||||
> # "account","activation","verify","verification","activate","confirmation","email","code","validate","registration","login","code","expire","confirm"
|
||||
> # ]
|
||||
> # }
|
||||
> #]
|
||||
> #
|
||||
> ```
|
||||
@@ -3,22 +3,29 @@
|
||||
layout: home
|
||||
|
||||
hero:
|
||||
name: "Temporary mailbox document"
|
||||
tagline: "Build CloudFlare to send and receive free temporary domain name mailboxes"
|
||||
name: "Temporary Email Docs"
|
||||
tagline: "Build Free CloudFlare Temporary Domain Email with Send & Receive"
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Try it now
|
||||
link: https://mail.awsl.uk/en
|
||||
- theme: alt
|
||||
text: command line deployment
|
||||
link: /en/cli
|
||||
- theme: brand
|
||||
text: Try it now
|
||||
link: https://mail.awsl.uk/
|
||||
- theme: alt
|
||||
text: CLI Deployment
|
||||
link: /en/guide/quick-start
|
||||
- theme: alt
|
||||
text: Deploy via UI
|
||||
link: /en/guide/quick-start
|
||||
- theme: alt
|
||||
text: Deploy via Github Actions
|
||||
link: /en/guide/quick-start
|
||||
|
||||
features:
|
||||
- title: Free hosting on CloudFlare, no server required
|
||||
details: Cloudflare D1 database, Cloudflare Pages frontend, Cloudflare Workers backend, Cloudflare Email Routing
|
||||
- title: Only domain name required for private deployment
|
||||
details: Support password login email, access authorization can be used as a private site, support attachment function
|
||||
- title: Use rust wasm to parse emails
|
||||
details: Use rust wasm to parse emails, support various RFC standards for emails, support attachments, extremely fast
|
||||
- title: Support sending emails
|
||||
details: Support sending txt or html emails through domain name mailboxes,Support DKIM signature
|
||||
- title: Private deployment with only a domain name, free hosting on CloudFlare, no server required
|
||||
details: Support password login for mailboxes, user registration, access password for private sites, attachment support.
|
||||
- title: Email parsing using Rust WASM
|
||||
details: Parse emails with Rust WASM, support various RFC email standards, support attachments, extremely fast
|
||||
- title: Telegram Bot and Webhook support
|
||||
details: Forward emails to Telegram or webhook, Telegram Bot supports mailbox binding, view emails, Telegram Mini App
|
||||
- title: Send emails (UI/API/SMTP)
|
||||
details: Send txt or html emails via domain mailboxes, DKIM signature support, send via UI/API/SMTP
|
||||
---
|
||||
|
||||
6
vitepress-docs/docs/en/reference.md
Normal file
6
vitepress-docs/docs/en/reference.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# Reference
|
||||
|
||||
- https://developers.cloudflare.com/d1/
|
||||
- https://developers.cloudflare.com/pages/
|
||||
- https://developers.cloudflare.com/workers/
|
||||
- https://developers.cloudflare.com/email-routing/
|
||||
8
vitepress-docs/docs/en/status.md
Normal file
8
vitepress-docs/docs/en/status.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Service Status
|
||||
|
||||
[Status Link](https://uptime.aks.awsl.icu/status/temp-email)
|
||||
|
||||
| Service | Status |
|
||||
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [Backend](https://temp-email-api.awsl.uk/) |       |
|
||||
| [Frontend](https://mail.awsl.uk/) |       |
|
||||
@@ -46,6 +46,7 @@
|
||||
| `FRONTEND_ENV` | 前端配置文件,请复制 `frontend/.env.example` 的内容,[并参考此处修改](/zh/guide/cli/pages.html) |
|
||||
| `FRONTEND_NAME` | 你在 Cloudflare Pages 创建的项目名称,可通过 [用户界面](https://temp-mail-docs.awsl.uk/zh/guide/ui/pages.html) 或者 [命令行](https://temp-mail-docs.awsl.uk/zh/guide/cli/pages.html) 创建 |
|
||||
| `FRONTEND_BRANCH` | (可选) pages 部署的分支,可不配置,默认 `production` |
|
||||
| `PAGE_TOML` | (可选) 使用 page functions 转发后端请求时需要配置,请复制 `pages/wrangler.toml` 的内容,并根据实际情况修改 `service` 字段为你的 worker 后端名称 |
|
||||
| `TG_FRONTEND_NAME` | (可选) 你在 Cloudflare Pages 创建的项目名称,同 `FRONTEND_NAME`,如果需要 Telegram Mini App 功能,请填写 |
|
||||
|
||||
### 部署
|
||||
|
||||
74
vitepress-docs/docs/zh/guide/feature/ai-extract.md
Normal file
74
vitepress-docs/docs/zh/guide/feature/ai-extract.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# AI 邮件识别
|
||||
|
||||
> [!NOTE]
|
||||
> 此功能从 v1.1.0 版本开始支持
|
||||
>
|
||||
> 本功能参考自 [Alle 项目](https://github.com/bestruirui/Alle/blob/62e74629ded0c7966c12d4e1c54f0bcc2e54f12c/src/lib/email/extract.ts#L54)
|
||||
|
||||
## 功能说明
|
||||
|
||||
AI 邮件识别功能使用 Cloudflare Workers AI 自动分析收到的邮件内容,智能提取重要信息,包括:
|
||||
|
||||
- **验证码** (auth_code) - OTP、安全码、确认码等
|
||||
- **认证链接** (auth_link) - 登录、验证、激活、重置密码链接
|
||||
- **服务链接** (service_link) - GitHub、GitLab、部署通知等服务相关链接
|
||||
- **订阅管理链接** (subscription_link) - 退订、管理订阅等链接
|
||||
- **其他链接** (other_link) - 其他有价值的链接
|
||||
|
||||
提取结果会自动保存到数据库的 `metadata` 字段中,前端可以直接展示提取的验证码或链接。
|
||||
|
||||
## 配置变量
|
||||
|
||||
| 变量名 | 类型 | 说明 | 示例 |
|
||||
| ------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
|
||||
| `ENABLE_AI_EMAIL_EXTRACT` | 文本/JSON | 是否启用 AI 邮件识别功能 | `true` |
|
||||
| `AI_EXTRACT_MODEL` | 文本 | AI 模型名称,从[支持 JSON 模式的模型](https://developers.cloudflare.com/workers-ai/features/json-mode/#supported-models)中选择 | `@cf/meta/llama-3.1-8b-instruct` |
|
||||
|
||||
## 内容长度限制
|
||||
|
||||
为避免 AI 模型 token 限制,邮件内容最大处理长度为 **4000 字符**。超过此长度的邮件内容将被截断后再进行 AI 分析。
|
||||
|
||||
## Workers AI 绑定
|
||||
|
||||
需要在 `wrangler.toml` 中配置 Workers AI 绑定:
|
||||
|
||||
```toml
|
||||
[ai]
|
||||
binding = "AI"
|
||||
```
|
||||
|
||||
或在 Cloudflare Dashboard 的 Worker 设置中添加:
|
||||
- **Variable name**: `AI`
|
||||
- **Type**: Workers AI
|
||||
|
||||
## 地址白名单(可选)
|
||||
|
||||
为了控制成本和资源使用,可以在 Admin 控制台的 **AI 提取设置** 页面配置地址白名单:
|
||||
|
||||
### 配置说明
|
||||
|
||||
- **未启用白名单**:所有邮箱地址都可使用 AI 提取功能
|
||||
- **启用白名单**:仅白名单中的邮箱地址会进行 AI 提取
|
||||
|
||||
### 白名单格式
|
||||
|
||||
每行一个地址,支持通配符 `*` 匹配任意字符:
|
||||
|
||||
- **精确匹配**:`user@example.com` - 仅匹配该邮箱
|
||||
- **域名通配符**:`*@example.com` - 匹配 example.com 域名下的所有邮箱
|
||||
- **用户通配符**:`admin*@example.com` - 匹配 admin 开头的邮箱
|
||||
- **任意位置通配符**:`*test*@example.com` - 匹配包含 test 的邮箱
|
||||
- **多个通配符**:`admin*@*.com` - 匹配所有 .com 域名下 admin 开头的邮箱
|
||||
|
||||
### 配置示例
|
||||
|
||||
```text
|
||||
user@example.com
|
||||
*@mydomain.com
|
||||
admin*@company.com
|
||||
```
|
||||
|
||||
此配置将只对以下邮箱进行 AI 提取:
|
||||
- `user@example.com`(精确匹配)
|
||||
- 所有 `@mydomain.com` 的邮箱(如 `test@mydomain.com`、`admin@mydomain.com`)
|
||||
- 所有 `admin` 开头的 `@company.com` 邮箱(如 `admin@company.com`、`admin123@company.com`)
|
||||
@@ -19,7 +19,7 @@ res = requests.get(
|
||||
|
||||
## admin 邮件 API
|
||||
|
||||
支持 `address` filter 和 `keyword` filter
|
||||
支持 `address` 过滤
|
||||
|
||||
```python
|
||||
import requests
|
||||
@@ -29,9 +29,8 @@ url = "https://<你的worker地址>/admin/mails"
|
||||
querystring = {
|
||||
"limit":"20",
|
||||
"offset":"0",
|
||||
# adress 和 keyword 为可选参数
|
||||
"address":"xxxx@awsl.uk",
|
||||
"keyword":"xxxx"
|
||||
# address 为可选参数
|
||||
"address":"xxxx@awsl.uk"
|
||||
}
|
||||
|
||||
headers = {"x-admin-auth": "<你的Admin密码>"}
|
||||
@@ -41,9 +40,11 @@ response = requests.get(url, headers=headers, params=querystring)
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
**注意**:后端 API 已移除关键词过滤功能。如需按内容过滤邮件,请使用前端界面的过滤输入框,该功能可过滤当前显示的页面。
|
||||
|
||||
## user 邮件 API
|
||||
|
||||
支持 `address` filter 和 `keyword` filter
|
||||
支持 `address` 过滤
|
||||
|
||||
```python
|
||||
import requests
|
||||
@@ -53,9 +54,8 @@ url = "https://<你的worker地址>/user_api/mails"
|
||||
querystring = {
|
||||
"limit":"20",
|
||||
"offset":"0",
|
||||
# adress 和 keyword 为可选参数
|
||||
"address":"xxxx@awsl.uk",
|
||||
"keyword":"xxxx"
|
||||
# address 为可选参数
|
||||
"address":"xxxx@awsl.uk"
|
||||
}
|
||||
|
||||
headers = {"x-admin-auth": "<你的Admin密码>"}
|
||||
@@ -64,3 +64,5 @@ response = requests.get(url, headers=headers, params=querystring)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
**注意**:后端 API 已移除关键词过滤功能。如需按内容过滤邮件,请使用前端界面的过滤输入框,该功能可过滤当前显示的页面。
|
||||
|
||||
@@ -51,7 +51,7 @@ def generate_random_name():
|
||||
def fetch_email_data(name):
|
||||
try:
|
||||
res = requests.post(
|
||||
"https://<worker 域名>",
|
||||
"https://<worker 域名>/admin/new_address",
|
||||
json={
|
||||
"enablePrefix": True,
|
||||
"name": name,
|
||||
|
||||
@@ -36,6 +36,25 @@ pnpm wrangler secret put TELEGRAM_BOT_TOKEN
|
||||
|
||||

|
||||
|
||||
## 语言切换功能
|
||||
|
||||
> [!NOTE]
|
||||
> 此功能从 v1.2.0 版本开始支持
|
||||
|
||||
Telegram Bot 支持中英文切换,用户可以通过 `/lang` 命令设置语言偏好。
|
||||
|
||||
### 启用语言切换
|
||||
|
||||
需要在 worker 变量中配置 `TG_ALLOW_USER_LANG = true` 才能启用此功能。
|
||||
|
||||
### 使用方法
|
||||
|
||||
- `/lang zh` - 切换为中文
|
||||
- `/lang en` - 切换为英文
|
||||
- `/lang` - 查看当前语言设置
|
||||
|
||||
语言偏好会保存到 KV 中,每个用户可以独立设置。
|
||||
|
||||
## Mini App
|
||||
|
||||
可以通过命令行部署,或者 UI 界面部署
|
||||
|
||||
@@ -105,10 +105,11 @@
|
||||
|
||||
## Telegram Bot 相关变量
|
||||
|
||||
| 变量名 | 类型 | 说明 | 示例 |
|
||||
| ---------------- | ---- | ---------------------------------------------------------------------- | ---- |
|
||||
| `TG_MAX_ADDRESS` | 数字 | telegram bot 最多绑定邮箱数量 | `5` |
|
||||
| `TG_BOT_INFO` | 文本 | 可不配置,telegram BOT_INFO,预定义的 BOT_INFO 可以降低 webhook 的延迟 | `{}` |
|
||||
| 变量名 | 类型 | 说明 | 示例 |
|
||||
| ------------------- | --------- | ---------------------------------------------------------------------- | ----- |
|
||||
| `TG_MAX_ADDRESS` | 数字 | telegram bot 最多绑定邮箱数量 | `5` |
|
||||
| `TG_BOT_INFO` | 文本 | 可不配置,telegram BOT_INFO,预定义的 BOT_INFO 可以降低 webhook 的延迟 | `{}` |
|
||||
| `TG_ALLOW_USER_LANG`| 文本/JSON | 是否允许用户通过 `/lang` 命令切换语言,默认 `false` | `true`|
|
||||
|
||||
> [!NOTE]
|
||||
> Telegram 功能需要解析邮件,免费版 CPU 有限,可能会导致大邮件解析超时
|
||||
@@ -117,6 +118,33 @@
|
||||
>
|
||||
> 参考 [配置 worker 使用 wasm 解析邮件](/zh/guide/feature/mail_parser_wasm_worker)
|
||||
|
||||
## 邮件转发相关变量
|
||||
|
||||
| 变量名 | 类型 | 说明 | 示例 |
|
||||
| --------------------------------- | ---- | ---------------------------------------------------------------------------------------------------------- | ------ |
|
||||
| `SUBDOMAIN_FORWARD_ADDRESS_LIST` | JSON | 子域名/规则转发配置,支持按域名和来源地址正则过滤转发 | 见下方 |
|
||||
|
||||
> [!NOTE] SUBDOMAIN_FORWARD_ADDRESS_LIST 配置说明
|
||||
>
|
||||
> v1.2.0 新增 `sourcePatterns` 和 `sourceMatchMode` 字段,支持按发件人地址正则过滤转发:
|
||||
>
|
||||
> - `domains`: 目标域名列表,为空则匹配所有域名
|
||||
> - `forward`: 转发目标地址
|
||||
> - `sourcePatterns`: 来源地址正则表达式列表(可选)
|
||||
> - `sourceMatchMode`: 匹配模式,`any`(任一匹配,默认) 或 `all`(全部匹配)
|
||||
>
|
||||
> 正则表达式最大长度 200 字符,防止 ReDoS 攻击
|
||||
>
|
||||
> ```toml
|
||||
> SUBDOMAIN_FORWARD_ADDRESS_LIST = """
|
||||
> [
|
||||
> {"domains":[""],"forward":"xxx1@xxx.com"},
|
||||
> {"domains":["subdomain-1.domain.com","subdomain-2.domain.com"],"forward":"xxx2@xxx.com"},
|
||||
> {"domains":["example.com"],"forward":"admin@xxx.com","sourcePatterns":[".*@github.com",".*@gitlab.com"],"sourceMatchMode":"any"}
|
||||
> ]
|
||||
> """
|
||||
> ```
|
||||
|
||||
## 其他变量
|
||||
|
||||
| 变量名 | 类型 | 说明 | 示例 |
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "temp-mail-docs",
|
||||
"private": true,
|
||||
"version": "1.0.6",
|
||||
"version": "1.2.1",
|
||||
"type": "module",
|
||||
"devDependencies": {
|
||||
"@types/node": "^24.7.2",
|
||||
"@types/node": "^25.0.9",
|
||||
"vitepress": "^1.6.4",
|
||||
"wrangler": "^4.42.2"
|
||||
"wrangler": "^4.59.2"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "vitepress dev docs",
|
||||
|
||||
1527
vitepress-docs/pnpm-lock.yaml
generated
1527
vitepress-docs/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "cloudflare_temp_email",
|
||||
"version": "1.0.6",
|
||||
"version": "1.2.1",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
@@ -11,26 +11,26 @@
|
||||
"build": "wrangler deploy --dry-run --outdir dist --minify"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@cloudflare/workers-types": "^4.20251011.0",
|
||||
"@eslint/js": "9.18.0",
|
||||
"@cloudflare/workers-types": "^4.20260118.0",
|
||||
"@eslint/js": "9.39.1",
|
||||
"@simplewebauthn/types": "10.0.0",
|
||||
"@types/node": "^22.18.10",
|
||||
"eslint": "9.18.0",
|
||||
"globals": "^15.15.0",
|
||||
"typescript-eslint": "^8.46.0",
|
||||
"wrangler": "^4.42.2"
|
||||
"@types/node": "^25.0.9",
|
||||
"eslint": "9.39.1",
|
||||
"globals": "^16.5.0",
|
||||
"typescript-eslint": "^8.53.0",
|
||||
"wrangler": "^4.59.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@aws-sdk/client-s3": "3.888.0",
|
||||
"@aws-sdk/s3-request-presigner": "3.888.0",
|
||||
"@simplewebauthn/server": "10.0.1",
|
||||
"hono": "^4.9.11",
|
||||
"hono": "^4.11.4",
|
||||
"jsonpath-plus": "^10.3.0",
|
||||
"mimetext": "^3.0.27",
|
||||
"postal-mime": "^2.5.0",
|
||||
"resend": "^4.8.0",
|
||||
"postal-mime": "^2.7.3",
|
||||
"resend": "^6.7.0",
|
||||
"telegraf": "4.16.3",
|
||||
"worker-mailer": "^1.1.5"
|
||||
"worker-mailer": "^1.2.1"
|
||||
},
|
||||
"pnpm": {
|
||||
"patchedDependencies": {
|
||||
|
||||
2151
worker/pnpm-lock.yaml
generated
2151
worker/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -3,14 +3,12 @@ import { handleListQuery } from "../common";
|
||||
|
||||
export default {
|
||||
getMails: async (c: Context<HonoCustomType>) => {
|
||||
const { address, limit, offset, keyword } = c.req.query();
|
||||
const { address, limit, offset } = c.req.query();
|
||||
const addressQuery = address ? `address = ?` : "";
|
||||
const addressParams = address ? [address] : [];
|
||||
const keywordQuery = keyword ? `raw like ?` : "";
|
||||
const keywordParams = keyword ? [`%${keyword}%`] : [];
|
||||
const filterQuerys = [addressQuery, keywordQuery].filter((item) => item).join(" and ");
|
||||
const filterQuerys = [addressQuery].filter((item) => item).join(" and ");
|
||||
const finalQuery = filterQuerys.length > 0 ? `where ${filterQuerys}` : "";
|
||||
const filterParams = [...addressParams, ...keywordParams]
|
||||
const filterParams = [...addressParams]
|
||||
return await handleListQuery(c,
|
||||
`SELECT * FROM raw_mails ${finalQuery}`,
|
||||
`SELECT count(*) as count FROM raw_mails ${finalQuery}`,
|
||||
|
||||
@@ -14,23 +14,24 @@ export default {
|
||||
return c.json(settings)
|
||||
},
|
||||
saveSetting: async (c: Context<HonoCustomType>) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const value = await c.req.json();
|
||||
const settings = new UserSettings(value);
|
||||
if (settings.enableMailVerify && !c.env.KV) {
|
||||
return c.text("Please enable KV first if you want to enable mail verify", 403)
|
||||
return c.text(msgs.EnableKVForMailVerifyMsg, 403)
|
||||
}
|
||||
if (settings.enableMailVerify && !settings.verifyMailSender) {
|
||||
return c.text("Please provide verifyMailSender", 400)
|
||||
return c.text(msgs.VerifyMailSenderNotSetMsg, 400)
|
||||
}
|
||||
if (settings.enableMailVerify && settings.verifyMailSender) {
|
||||
const mailDomain = settings.verifyMailSender.split("@")[1];
|
||||
const domains = getDomains(c);
|
||||
if (!domains.includes(mailDomain)) {
|
||||
return c.text(`VerifyMailSender(${settings.verifyMailSender}) domain must in ${JSON.stringify(domains, null, 2)}`, 400)
|
||||
return c.text(`${msgs.VerifyMailDomainInvalidMsg} ${JSON.stringify(domains, null, 2)}`, 400)
|
||||
}
|
||||
}
|
||||
if (settings.maxAddressCount < 0) {
|
||||
return c.text("Invalid maxAddressCount", 400)
|
||||
return c.text(msgs.InvalidMaxAddressCountMsg, 400)
|
||||
}
|
||||
await saveSetting(c, CONSTANTS.USER_SETTINGS_KEY, JSON.stringify(settings));
|
||||
return c.json({ success: true })
|
||||
@@ -60,9 +61,10 @@ export default {
|
||||
);
|
||||
},
|
||||
createUser: async (c: Context<HonoCustomType>) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const { email, password } = await c.req.json();
|
||||
if (!email || !password) {
|
||||
return c.text("Invalid email or password", 400)
|
||||
return c.text(msgs.InvalidEmailOrPasswordMsg, 400)
|
||||
}
|
||||
// geo data
|
||||
const reqIp = c.req.raw.headers.get("cf-connecting-ip")
|
||||
@@ -77,14 +79,14 @@ export default {
|
||||
email, password, JSON.stringify(userInfo)
|
||||
).run();
|
||||
if (!success) {
|
||||
return c.text("Failed to register", 500)
|
||||
return c.text(msgs.FailedToRegisterMsg, 500)
|
||||
}
|
||||
} catch (e) {
|
||||
const errorMsg = (e as Error).message;
|
||||
if (errorMsg && errorMsg.includes("UNIQUE")) {
|
||||
return c.text("User already exists", 400)
|
||||
return c.text(msgs.UserAlreadyExistsMsg, 400)
|
||||
}
|
||||
return c.text(`Failed to register: ${errorMsg}`, 500)
|
||||
return c.text(`${msgs.FailedToRegisterMsg}: ${errorMsg}`, 500)
|
||||
}
|
||||
return c.json({ success: true })
|
||||
},
|
||||
@@ -99,7 +101,7 @@ export default {
|
||||
`DELETE FROM users_address WHERE user_id = ?`
|
||||
).bind(user_id).run();
|
||||
if (!success || !addressSuccess) {
|
||||
return c.text("Failed to delete user", 500)
|
||||
return c.text(msgs.FailedDeleteUserMsg, 500)
|
||||
}
|
||||
return c.json({ success: true })
|
||||
},
|
||||
@@ -114,28 +116,29 @@ export default {
|
||||
`UPDATE users SET password = ? WHERE id = ?`
|
||||
).bind(password, user_id).run();
|
||||
if (!success) {
|
||||
return c.text("Failed to reset password", 500)
|
||||
return c.text(msgs.FailedUpdatePasswordMsg, 500)
|
||||
}
|
||||
} catch (e) {
|
||||
return c.text(`Failed to reset password: ${(e as Error).message}`, 500)
|
||||
return c.text(`${msgs.FailedUpdatePasswordMsg}: ${(e as Error).message}`, 500)
|
||||
}
|
||||
return c.json({ success: true });
|
||||
},
|
||||
updateUserRoles: async (c: Context<HonoCustomType>) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const { user_id, role_text } = await c.req.json();
|
||||
if (!user_id) return c.text("Invalid user_id", 400);
|
||||
if (!user_id) return c.text(msgs.InvalidUserIdMsg, 400);
|
||||
if (!role_text) {
|
||||
const { success } = await c.env.DB.prepare(
|
||||
`DELETE FROM user_roles WHERE user_id = ?`
|
||||
).bind(user_id).run();
|
||||
if (!success) {
|
||||
return c.text("Failed to update user roles", 500)
|
||||
return c.text(msgs.FailedUpdateUserDefaultRoleMsg, 500)
|
||||
}
|
||||
return c.json({ success: true })
|
||||
}
|
||||
const user_roles = getUserRoles(c);
|
||||
if (!user_roles.find((r) => r.role === role_text)) {
|
||||
return c.text("Invalid role_text", 400)
|
||||
return c.text(msgs.InvalidRoleTextMsg, 400)
|
||||
}
|
||||
const { success } = await c.env.DB.prepare(
|
||||
`INSERT INTO user_roles (user_id, role_text)`
|
||||
@@ -143,7 +146,7 @@ export default {
|
||||
+ ` ON CONFLICT(user_id) DO UPDATE SET role_text = ?, updated_at = datetime('now')`
|
||||
).bind(user_id, role_text, role_text).run();
|
||||
if (!success) {
|
||||
return c.text("Failed to update user roles", 500)
|
||||
return c.text(msgs.FailedUpdateUserDefaultRoleMsg, 500)
|
||||
}
|
||||
return c.json({ success: true })
|
||||
},
|
||||
|
||||
27
worker/src/admin_api/ai_extract_settings.ts
Normal file
27
worker/src/admin_api/ai_extract_settings.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { Context } from "hono";
|
||||
import { CONSTANTS } from "../constants";
|
||||
import { getJsonSetting, saveSetting } from "../utils";
|
||||
|
||||
export type AiExtractSettings = {
|
||||
enableAllowList: boolean;
|
||||
allowList: string[];
|
||||
}
|
||||
|
||||
async function getAiExtractSettings(c: Context<HonoCustomType>): Promise<Response> {
|
||||
const settings = await getJsonSetting<AiExtractSettings>(c, CONSTANTS.AI_EXTRACT_SETTINGS_KEY) || {
|
||||
enableAllowList: false,
|
||||
allowList: []
|
||||
};
|
||||
return c.json(settings);
|
||||
}
|
||||
|
||||
async function saveAiExtractSettings(c: Context<HonoCustomType>): Promise<Response> {
|
||||
const settings = await c.req.json<AiExtractSettings>();
|
||||
await saveSetting(c, CONSTANTS.AI_EXTRACT_SETTINGS_KEY, JSON.stringify(settings));
|
||||
return c.json({ success: true })
|
||||
}
|
||||
|
||||
export default {
|
||||
getAiExtractSettings,
|
||||
saveAiExtractSettings,
|
||||
}
|
||||
@@ -3,16 +3,105 @@ import { Context } from 'hono';
|
||||
import { cleanup } from '../common';
|
||||
import { CONSTANTS } from '../constants';
|
||||
import { getJsonSetting, saveSetting } from '../utils';
|
||||
import { CleanupSettings } from '../models';
|
||||
import { CleanupSettings, CustomSqlCleanup } from '../models';
|
||||
import i18n from '../i18n';
|
||||
import { LocaleMessages } from '../i18n/type';
|
||||
|
||||
// SQL validation error types
|
||||
type SqlValidationError = 'empty' | 'too_long' | 'not_delete' | 'multiple_statements' | 'has_comments';
|
||||
|
||||
// Normalize SQL: trim and remove trailing semicolon
|
||||
const normalizeSql = (sql: string): string => {
|
||||
let normalized = sql.trim();
|
||||
if (normalized.endsWith(';')) {
|
||||
normalized = normalized.slice(0, -1).trim();
|
||||
}
|
||||
return normalized;
|
||||
};
|
||||
|
||||
// Get error message from error type
|
||||
const getValidationErrorMsg = (errorType: SqlValidationError, msgs: LocaleMessages): string => {
|
||||
switch (errorType) {
|
||||
case 'empty': return msgs.SqlEmptyMsg;
|
||||
case 'too_long': return msgs.SqlTooLongMsg;
|
||||
case 'not_delete': return msgs.SqlOnlyDeleteMsg;
|
||||
case 'multiple_statements': return msgs.SqlSingleStatementMsg;
|
||||
case 'has_comments': return msgs.SqlNoCommentsMsg;
|
||||
}
|
||||
};
|
||||
|
||||
// Validate custom SQL cleanup statement
|
||||
export const validateCustomSql = (sql: string): { valid: boolean; errorType?: SqlValidationError } => {
|
||||
if (!sql || !sql.trim()) {
|
||||
return { valid: false, errorType: 'empty' };
|
||||
}
|
||||
|
||||
const trimmedSql = normalizeSql(sql);
|
||||
|
||||
// Check SQL length (max 1000 characters)
|
||||
if (trimmedSql.length > 1000) {
|
||||
return { valid: false, errorType: 'too_long' };
|
||||
}
|
||||
|
||||
const sqlUpper = trimmedSql.toUpperCase();
|
||||
|
||||
// Only allow DELETE statements
|
||||
if (!sqlUpper.startsWith('DELETE ')) {
|
||||
return { valid: false, errorType: 'not_delete' };
|
||||
}
|
||||
|
||||
// Only allow single statement (no semicolons after trimming)
|
||||
if (trimmedSql.includes(';')) {
|
||||
return { valid: false, errorType: 'multiple_statements' };
|
||||
}
|
||||
|
||||
// Forbid SQL comments
|
||||
if (/--/.test(trimmedSql) || /\/\*/.test(trimmedSql)) {
|
||||
return { valid: false, errorType: 'has_comments' };
|
||||
}
|
||||
|
||||
return { valid: true };
|
||||
};
|
||||
|
||||
// Execute custom SQL cleanup
|
||||
export const executeCustomSqlCleanup = async (
|
||||
c: Context<HonoCustomType>,
|
||||
customSql: CustomSqlCleanup
|
||||
): Promise<{ success: boolean; rowsAffected?: number; error?: string }> => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
if (!customSql || !customSql.sql) {
|
||||
return { success: false, error: msgs.InvalidCleanupConfigMsg };
|
||||
}
|
||||
|
||||
const validation = validateCustomSql(customSql.sql);
|
||||
if (!validation.valid) {
|
||||
return { success: false, error: getValidationErrorMsg(validation.errorType!, msgs) };
|
||||
}
|
||||
|
||||
const sql = normalizeSql(customSql.sql);
|
||||
|
||||
try {
|
||||
console.log(`Executing custom SQL cleanup [${customSql.name}]: ${sql}`);
|
||||
const result = await c.env.DB.prepare(sql).run();
|
||||
const rowsAffected = result.meta?.changes ?? 0;
|
||||
console.log(`Custom SQL cleanup [${customSql.name}] completed, rows affected: ${rowsAffected}`);
|
||||
return { success: true, rowsAffected };
|
||||
} catch (error) {
|
||||
const errorMessage = (error as Error).message || "Unknown error";
|
||||
console.error(`Custom SQL cleanup [${customSql.name}] failed:`, errorMessage);
|
||||
return { success: false, error: errorMessage };
|
||||
}
|
||||
};
|
||||
|
||||
export default {
|
||||
cleanup: async (c: Context<HonoCustomType>) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const { cleanType, cleanDays } = await c.req.json();
|
||||
try {
|
||||
await cleanup(c, cleanType, cleanDays);
|
||||
} catch (error) {
|
||||
console.error(error);
|
||||
return c.text(`Failed to cleanup ${(error as Error).message}`, 500)
|
||||
return c.text(`${msgs.OperationFailedMsg}: ${(error as Error).message}`, 500)
|
||||
}
|
||||
return c.json({ success: true })
|
||||
},
|
||||
@@ -21,7 +110,22 @@ export default {
|
||||
return c.json(cleanupSetting)
|
||||
},
|
||||
saveCleanup: async (c: Context<HonoCustomType>) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const cleanupSetting = await c.req.json<CleanupSettings>();
|
||||
|
||||
// Validate custom SQL cleanup list
|
||||
if (cleanupSetting.customSqlCleanupList && cleanupSetting.customSqlCleanupList.length > 0) {
|
||||
for (const customSql of cleanupSetting.customSqlCleanupList) {
|
||||
if (customSql.sql) {
|
||||
const validation = validateCustomSql(customSql.sql);
|
||||
if (!validation.valid) {
|
||||
const errorMsg = getValidationErrorMsg(validation.errorType!, msgs);
|
||||
return c.text(`[${customSql.name || 'unnamed'}]: ${errorMsg}`, 400);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
await saveSetting(c, CONSTANTS.AUTO_CLEANUP_KEY, JSON.stringify(cleanupSetting));
|
||||
return c.json({ success: true })
|
||||
}
|
||||
|
||||
@@ -9,6 +9,7 @@ CREATE TABLE IF NOT EXISTS raw_mails (
|
||||
source TEXT,
|
||||
address TEXT,
|
||||
raw TEXT,
|
||||
metadata TEXT,
|
||||
created_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
|
||||
@@ -20,6 +21,7 @@ CREATE TABLE IF NOT EXISTS address (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name TEXT UNIQUE,
|
||||
password TEXT,
|
||||
source_meta TEXT,
|
||||
created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
|
||||
updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||
);
|
||||
@@ -30,6 +32,8 @@ CREATE INDEX IF NOT EXISTS idx_address_created_at ON address(created_at);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_address_updated_at ON address(updated_at);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_address_source_meta ON address(source_meta);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS auto_reply_mails (
|
||||
id INTEGER PRIMARY KEY,
|
||||
source_prefix TEXT,
|
||||
@@ -137,13 +141,44 @@ export default {
|
||||
},
|
||||
migrate: async (c: Context<HonoCustomType>) => {
|
||||
const version = await utils.getSetting(c, CONSTANTS.DB_VERSION_KEY);
|
||||
if (version == "v0.0.2") {
|
||||
// example migration from v0.0.2 to v0.0.3
|
||||
const query = `ALTER TABLE address ADD password TEXT;`
|
||||
await c.env.DB.exec(query);
|
||||
if (version && version <= "v0.0.2") {
|
||||
// migration to v0.0.3: add password column
|
||||
const tableInfo = await c.env.DB.prepare(
|
||||
`PRAGMA table_info(address)`
|
||||
).all();
|
||||
const hasPassword = tableInfo.results?.some(
|
||||
(col: any) => col.name === 'password'
|
||||
);
|
||||
if (!hasPassword) {
|
||||
await c.env.DB.exec(`ALTER TABLE address ADD COLUMN password TEXT;`);
|
||||
}
|
||||
}
|
||||
if (version && version <= "v0.0.3") {
|
||||
// migration to v0.0.4: add metadata column
|
||||
const tableInfo = await c.env.DB.prepare(
|
||||
`PRAGMA table_info(raw_mails)`
|
||||
).all();
|
||||
const hasMetadata = tableInfo.results?.some(
|
||||
(col: any) => col.name === 'metadata'
|
||||
);
|
||||
if (!hasMetadata) {
|
||||
await c.env.DB.exec(`ALTER TABLE raw_mails ADD COLUMN metadata TEXT;`);
|
||||
}
|
||||
}
|
||||
if (version && version <= "v0.0.4") {
|
||||
// migration to v0.0.5: add source_meta column
|
||||
const tableInfo = await c.env.DB.prepare(
|
||||
`PRAGMA table_info(address)`
|
||||
).all();
|
||||
const hasSourceMeta = tableInfo.results?.some(
|
||||
(col: any) => col.name === 'source_meta'
|
||||
);
|
||||
if (!hasSourceMeta) {
|
||||
await c.env.DB.exec(`ALTER TABLE address ADD COLUMN source_meta TEXT;`);
|
||||
await c.env.DB.exec(`CREATE INDEX IF NOT EXISTS idx_address_source_meta ON address(source_meta);`);
|
||||
}
|
||||
}
|
||||
if (version != CONSTANTS.DB_VERSION) {
|
||||
// TODO: Perform migration logic here
|
||||
// remove all \r and \n characters from the query string
|
||||
// split by ; and join with a ;\n
|
||||
const query = DB_INIT_QUERIES.replace(/[\r\n]/g, "")
|
||||
|
||||
@@ -14,6 +14,8 @@ import worker_config from './worker_config'
|
||||
import admin_mail_api from './admin_mail_api'
|
||||
import { sendMailbyAdmin } from './send_mail'
|
||||
import db_api from './db_api'
|
||||
import ip_blacklist_settings from './ip_blacklist_settings'
|
||||
import ai_extract_settings from './ai_extract_settings'
|
||||
import { EmailRuleSettings } from '../models'
|
||||
|
||||
export const api = new Hono<HonoCustomType>()
|
||||
@@ -43,10 +45,9 @@ api.get('/admin/address', async (c) => {
|
||||
|
||||
api.post('/admin/new_address', async (c) => {
|
||||
const { name, domain, enablePrefix } = await c.req.json();
|
||||
const lang = c.get("lang") || c.env.DEFAULT_LANG;
|
||||
const msgs = i18n.getMessages(lang);
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
if (!name) {
|
||||
return c.text("Please provide a name", 400)
|
||||
return c.text(msgs.RequiredFieldMsg, 400)
|
||||
}
|
||||
try {
|
||||
const res = await newAddress(c, {
|
||||
@@ -55,6 +56,7 @@ api.post('/admin/new_address', async (c) => {
|
||||
addressPrefix: null,
|
||||
checkAllowDomains: false,
|
||||
enableCheckNameRegex: false,
|
||||
sourceMeta: 'admin'
|
||||
});
|
||||
|
||||
return c.json(res);
|
||||
@@ -64,19 +66,20 @@ api.post('/admin/new_address', async (c) => {
|
||||
})
|
||||
|
||||
api.delete('/admin/delete_address/:id', async (c) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const { id } = c.req.param();
|
||||
const { success } = await c.env.DB.prepare(
|
||||
`DELETE FROM address WHERE id = ? `
|
||||
).bind(id).run();
|
||||
if (!success) {
|
||||
return c.text("Failed to delete address", 500)
|
||||
return c.text(msgs.OperationFailedMsg, 500)
|
||||
}
|
||||
const { success: mailSuccess } = await c.env.DB.prepare(
|
||||
`DELETE FROM raw_mails WHERE address IN`
|
||||
+ ` (select name from address where id = ?) `
|
||||
).bind(id).run();
|
||||
if (!mailSuccess) {
|
||||
return c.text("Failed to delete mails", 500)
|
||||
return c.text(msgs.OperationFailedMsg, 500)
|
||||
}
|
||||
const { success: sendAccess } = await c.env.DB.prepare(
|
||||
`DELETE FROM address_sender WHERE address IN`
|
||||
@@ -91,13 +94,14 @@ api.delete('/admin/delete_address/:id', async (c) => {
|
||||
})
|
||||
|
||||
api.delete('/admin/clear_inbox/:id', async (c) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const { id } = c.req.param();
|
||||
const { success: mailSuccess } = await c.env.DB.prepare(
|
||||
`DELETE FROM raw_mails WHERE address IN`
|
||||
+ ` (select name from address where id = ?) `
|
||||
).bind(id).run();
|
||||
if (!mailSuccess) {
|
||||
return c.text("Failed to clear inbox", 500)
|
||||
return c.text(msgs.OperationFailedMsg, 500)
|
||||
}
|
||||
return c.json({
|
||||
success: mailSuccess
|
||||
@@ -105,13 +109,14 @@ api.delete('/admin/clear_inbox/:id', async (c) => {
|
||||
})
|
||||
|
||||
api.delete('/admin/clear_sent_items/:id', async (c) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const { id } = c.req.param();
|
||||
const { success: sendboxSuccess } = await c.env.DB.prepare(
|
||||
`DELETE FROM sendbox WHERE address IN`
|
||||
+ ` (select name from address where id = ?) `
|
||||
).bind(id).run();
|
||||
if (!sendboxSuccess) {
|
||||
return c.text("Failed to clear sent items", 500)
|
||||
return c.text(msgs.OperationFailedMsg, 500)
|
||||
}
|
||||
return c.json({
|
||||
success: sendboxSuccess
|
||||
@@ -133,15 +138,16 @@ api.get('/admin/show_password/:id', async (c) => {
|
||||
})
|
||||
|
||||
api.post('/admin/address/:id/reset_password', async (c) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const { id } = c.req.param();
|
||||
const { password } = await c.req.json();
|
||||
// 检查功能是否启用
|
||||
if (!getBooleanValue(c.env.ENABLE_ADDRESS_PASSWORD)) {
|
||||
return c.text("Password management is disabled", 403);
|
||||
return c.text(msgs.PasswordChangeDisabledMsg, 403);
|
||||
}
|
||||
|
||||
if (!password) {
|
||||
return c.text("Password is required", 400);
|
||||
return c.text(msgs.NewPasswordRequiredMsg, 400);
|
||||
}
|
||||
|
||||
const hashedPassword = await hashPassword(password);
|
||||
@@ -150,7 +156,7 @@ api.post('/admin/address/:id/reset_password', async (c) => {
|
||||
).bind(hashedPassword, id).run();
|
||||
|
||||
if (!success) {
|
||||
return c.text("Failed to reset password", 500);
|
||||
return c.text(msgs.FailedUpdatePasswordMsg, 500);
|
||||
}
|
||||
|
||||
return c.json({ success: true });
|
||||
@@ -178,18 +184,19 @@ api.get('/admin/address_sender', async (c) => {
|
||||
})
|
||||
|
||||
api.post('/admin/address_sender', async (c) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
/* eslint-disable prefer-const */
|
||||
let { address, address_id, balance, enabled } = await c.req.json();
|
||||
/* eslint-enable prefer-const */
|
||||
if (!address_id) {
|
||||
return c.text("Invalid address_id", 400)
|
||||
return c.text(msgs.InvalidAddressIdMsg, 400)
|
||||
}
|
||||
enabled = enabled ? 1 : 0;
|
||||
const { success } = await c.env.DB.prepare(
|
||||
`UPDATE address_sender SET enabled = ?, balance = ? WHERE id = ? `
|
||||
).bind(enabled, balance, address_id).run();
|
||||
if (!success) {
|
||||
return c.text("Failed to update address sender", 500)
|
||||
return c.text(msgs.OperationFailedMsg, 500)
|
||||
}
|
||||
await sendAdminInternalMail(
|
||||
c, address, "Account Send Access Updated",
|
||||
@@ -288,16 +295,17 @@ api.get('/admin/account_settings', async (c) => {
|
||||
})
|
||||
|
||||
api.post('/admin/account_settings', async (c) => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
/** @type {{ blockList: Array<string>, sendBlockList: Array<string> }} */
|
||||
const {
|
||||
blockList, sendBlockList, noLimitSendAddressList,
|
||||
verifiedAddressList, fromBlockList, emailRuleSettings
|
||||
} = await c.req.json();
|
||||
if (!blockList || !sendBlockList || !verifiedAddressList) {
|
||||
return c.text("Invalid blockList or sendBlockList", 400)
|
||||
return c.text(msgs.InvalidInputMsg, 400)
|
||||
}
|
||||
if (!c.env.SEND_MAIL && verifiedAddressList.length > 0) {
|
||||
return c.text("Please enable SEND_MAIL to use verifiedAddressList", 400)
|
||||
return c.text(msgs.EnableSendMailMsg, 400)
|
||||
}
|
||||
await saveSetting(
|
||||
c, CONSTANTS.ADDRESS_BLOCK_LIST_KEY,
|
||||
@@ -312,7 +320,7 @@ api.post('/admin/account_settings', async (c) => {
|
||||
JSON.stringify(verifiedAddressList)
|
||||
)
|
||||
if (fromBlockList?.length > 0 && !c.env.KV) {
|
||||
return c.text("Please enable KV to use fromBlockList", 400)
|
||||
return c.text(msgs.EnableKVMsg, 400)
|
||||
}
|
||||
if (fromBlockList) {
|
||||
await c.env.KV.put(CONSTANTS.EMAIL_KV_BLACK_LIST, JSON.stringify(fromBlockList || []))
|
||||
@@ -372,3 +380,11 @@ api.post("/admin/send_mail", sendMailbyAdmin);
|
||||
api.get('admin/db_version', db_api.getVersion);
|
||||
api.post('admin/db_initialize', db_api.initialize);
|
||||
api.post('admin/db_migration', db_api.migrate);
|
||||
|
||||
// IP blacklist settings
|
||||
api.get("/admin/ip_blacklist/settings", ip_blacklist_settings.getIpBlacklistSettings);
|
||||
api.post("/admin/ip_blacklist/settings", ip_blacklist_settings.saveIpBlacklistSettings);
|
||||
|
||||
// AI extract settings
|
||||
api.get("/admin/ai_extract/settings", ai_extract_settings.getAiExtractSettings);
|
||||
api.post("/admin/ai_extract/settings", ai_extract_settings.saveAiExtractSettings);
|
||||
|
||||
108
worker/src/admin_api/ip_blacklist_settings.ts
Normal file
108
worker/src/admin_api/ip_blacklist_settings.ts
Normal file
@@ -0,0 +1,108 @@
|
||||
import { Context } from "hono";
|
||||
import { CONSTANTS } from "../constants";
|
||||
import { getJsonSetting, saveSetting } from "../utils";
|
||||
import { IpBlacklistSettings } from "../ip_blacklist";
|
||||
import i18n from "../i18n";
|
||||
|
||||
/**
|
||||
* Get IP blacklist settings from database
|
||||
*/
|
||||
async function getIpBlacklistSettings(c: Context<HonoCustomType>): Promise<Response> {
|
||||
const settings = await getJsonSetting<IpBlacklistSettings>(
|
||||
c, CONSTANTS.IP_BLACKLIST_SETTINGS_KEY
|
||||
);
|
||||
|
||||
// Return default settings if not found
|
||||
return c.json(settings || {
|
||||
enabled: false,
|
||||
blacklist: [],
|
||||
asnBlacklist: [],
|
||||
fingerprintBlacklist: [],
|
||||
enableDailyLimit: false,
|
||||
dailyRequestLimit: 1000
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Save IP blacklist settings to database
|
||||
*/
|
||||
async function saveIpBlacklistSettings(c: Context<HonoCustomType>): Promise<Response> {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
const settings = await c.req.json<IpBlacklistSettings>();
|
||||
|
||||
// Validate settings
|
||||
if (typeof settings.enabled !== 'boolean') {
|
||||
return c.text(`${msgs.InvalidIpBlacklistSettingMsg}: enabled`, 400);
|
||||
}
|
||||
|
||||
if (!Array.isArray(settings.blacklist)) {
|
||||
return c.text(`${msgs.InvalidIpBlacklistSettingMsg}: blacklist`, 400);
|
||||
}
|
||||
|
||||
if (!Array.isArray(settings.asnBlacklist)) {
|
||||
return c.text(`${msgs.InvalidIpBlacklistSettingMsg}: asnBlacklist`, 400);
|
||||
}
|
||||
|
||||
if (!Array.isArray(settings.fingerprintBlacklist)) {
|
||||
return c.text(`${msgs.InvalidIpBlacklistSettingMsg}: fingerprintBlacklist`, 400);
|
||||
}
|
||||
|
||||
if (typeof settings.enableDailyLimit !== 'boolean') {
|
||||
return c.text(`${msgs.InvalidIpBlacklistSettingMsg}: enableDailyLimit`, 400);
|
||||
}
|
||||
|
||||
const limit = Number(settings.dailyRequestLimit);
|
||||
if (isNaN(limit) || limit < 1 || limit > 1000000) {
|
||||
return c.text(`${msgs.InvalidIpBlacklistSettingMsg}: dailyRequestLimit (1-1000000)`, 400);
|
||||
}
|
||||
|
||||
// Add size limit
|
||||
const MAX_BLACKLIST_SIZE = 1000;
|
||||
if (settings.blacklist.length > MAX_BLACKLIST_SIZE) {
|
||||
return c.text(`${msgs.BlacklistExceedsMaxSizeMsg}: blacklist (${MAX_BLACKLIST_SIZE})`, 400);
|
||||
}
|
||||
|
||||
if (settings.asnBlacklist.length > MAX_BLACKLIST_SIZE) {
|
||||
return c.text(`${msgs.BlacklistExceedsMaxSizeMsg}: asnBlacklist (${MAX_BLACKLIST_SIZE})`, 400);
|
||||
}
|
||||
|
||||
if (settings.fingerprintBlacklist.length > MAX_BLACKLIST_SIZE) {
|
||||
return c.text(`${msgs.BlacklistExceedsMaxSizeMsg}: fingerprintBlacklist (${MAX_BLACKLIST_SIZE})`, 400);
|
||||
}
|
||||
|
||||
// Sanitize patterns (trim and remove empty strings)
|
||||
// Both regex and plain strings are allowed
|
||||
const sanitizedBlacklist = settings.blacklist
|
||||
.map(pattern => pattern.trim())
|
||||
.filter(pattern => pattern.length > 0);
|
||||
|
||||
const sanitizedAsnBlacklist = settings.asnBlacklist
|
||||
.map(pattern => pattern.trim())
|
||||
.filter(pattern => pattern.length > 0);
|
||||
|
||||
const sanitizedFingerprintBlacklist = settings.fingerprintBlacklist
|
||||
.map(pattern => pattern.trim())
|
||||
.filter(pattern => pattern.length > 0);
|
||||
|
||||
const sanitizedSettings: IpBlacklistSettings = {
|
||||
enabled: settings.enabled,
|
||||
blacklist: sanitizedBlacklist,
|
||||
asnBlacklist: sanitizedAsnBlacklist,
|
||||
fingerprintBlacklist: sanitizedFingerprintBlacklist,
|
||||
enableDailyLimit: settings.enableDailyLimit,
|
||||
dailyRequestLimit: settings.dailyRequestLimit
|
||||
};
|
||||
|
||||
await saveSetting(
|
||||
c,
|
||||
CONSTANTS.IP_BLACKLIST_SETTINGS_KEY,
|
||||
JSON.stringify(sanitizedSettings)
|
||||
);
|
||||
|
||||
return c.json({ success: true });
|
||||
}
|
||||
|
||||
export default {
|
||||
getIpBlacklistSettings,
|
||||
saveIpBlacklistSettings,
|
||||
}
|
||||
@@ -5,6 +5,7 @@ import { getBooleanValue, getDomains, getStringValue, getIntValue, getUserRoles,
|
||||
import { unbindTelegramByAddress } from './telegram_api/common';
|
||||
import { CONSTANTS } from './constants';
|
||||
import { AdminWebhookSettings, WebhookMail, WebhookSettings } from './models';
|
||||
import i18n from './i18n';
|
||||
|
||||
const DEFAULT_NAME_REGEX = /[^a-z0-9]/g;
|
||||
|
||||
@@ -123,6 +124,7 @@ export const newAddress = async (
|
||||
addressPrefix = null,
|
||||
checkAllowDomains = true,
|
||||
enableCheckNameRegex = true,
|
||||
sourceMeta = null,
|
||||
}: {
|
||||
name: string, domain: string | undefined | null,
|
||||
enablePrefix: boolean,
|
||||
@@ -130,8 +132,10 @@ export const newAddress = async (
|
||||
addressPrefix?: string | undefined | null,
|
||||
checkAllowDomains?: boolean,
|
||||
enableCheckNameRegex?: boolean,
|
||||
sourceMeta?: string | undefined | null,
|
||||
}
|
||||
): Promise<{ address: string, jwt: string, password?: string | null }> => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
// trim whitespace and remove special characters
|
||||
name = name.trim().replace(getNameRegex(c), '')
|
||||
// check name
|
||||
@@ -151,10 +155,10 @@ export const newAddress = async (
|
||||
);
|
||||
// check name length
|
||||
if (name.length < minAddressLength) {
|
||||
throw new Error(`Name too short (min ${minAddressLength})`);
|
||||
throw new Error(`${msgs.NameTooShortMsg} (min ${minAddressLength})`);
|
||||
}
|
||||
if (name.length > maxAddressLength) {
|
||||
throw new Error(`Name too long (max ${maxAddressLength})`);
|
||||
throw new Error(`${msgs.NameTooLongMsg} (max ${maxAddressLength})`);
|
||||
}
|
||||
// create address with prefix
|
||||
if (typeof addressPrefix === "string") {
|
||||
@@ -175,24 +179,35 @@ export const newAddress = async (
|
||||
}
|
||||
// check domain is valid
|
||||
if (!domain || !allowDomains.includes(domain)) {
|
||||
throw new Error("Invalid domain")
|
||||
throw new Error(msgs.InvalidDomainMsg)
|
||||
}
|
||||
// create address
|
||||
name = name + "@" + domain;
|
||||
try {
|
||||
const { success } = await c.env.DB.prepare(
|
||||
`INSERT INTO address(name) VALUES(?)`
|
||||
).bind(name).run();
|
||||
if (!success) {
|
||||
throw new Error("Failed to create address")
|
||||
// Try insert with source_meta field first
|
||||
const result = await c.env.DB.prepare(
|
||||
`INSERT INTO address(name, source_meta) VALUES(?, ?)`
|
||||
).bind(name, sourceMeta).run();
|
||||
if (!result.success) {
|
||||
throw new Error(msgs.FailedCreateAddressMsg)
|
||||
}
|
||||
await updateAddressUpdatedAt(c, name);
|
||||
} catch (e) {
|
||||
const message = (e as Error).message;
|
||||
if (message && message.includes("UNIQUE")) {
|
||||
throw new Error("Address already exists")
|
||||
// Fallback: source_meta field may not exist, try without it
|
||||
if (message && message.includes("source_meta")) {
|
||||
const result = await c.env.DB.prepare(
|
||||
`INSERT INTO address(name) VALUES(?)`
|
||||
).bind(name).run();
|
||||
if (!result.success) {
|
||||
throw new Error(msgs.FailedCreateAddressMsg)
|
||||
}
|
||||
await updateAddressUpdatedAt(c, name);
|
||||
} else if (message && message.includes("UNIQUE")) {
|
||||
throw new Error(msgs.AddressAlreadyExistsMsg)
|
||||
} else {
|
||||
throw new Error(msgs.FailedCreateAddressMsg)
|
||||
}
|
||||
throw new Error("Failed to create address")
|
||||
}
|
||||
const address_id = await c.env.DB.prepare(
|
||||
`SELECT id FROM address where name = ?`
|
||||
@@ -234,8 +249,9 @@ export const cleanup = async (
|
||||
cleanType: string | undefined | null,
|
||||
cleanDays: number | undefined | null
|
||||
): Promise<boolean> => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
if (!cleanType || typeof cleanDays !== 'number' || cleanDays < 0 || cleanDays > 1000) {
|
||||
throw new Error("Invalid cleanType or cleanDays")
|
||||
throw new Error(msgs.InvalidCleanupConfigMsg)
|
||||
}
|
||||
console.log(`Cleanup ${cleanType} before ${cleanDays} days`);
|
||||
switch (cleanType) {
|
||||
@@ -273,8 +289,15 @@ export const cleanup = async (
|
||||
DELETE FROM sendbox WHERE created_at < datetime('now', '-${cleanDays} day')`
|
||||
).run();
|
||||
break;
|
||||
case "emptyAddress":
|
||||
// Delete addresses that have no emails and were created more than N days ago
|
||||
await batchDeleteAddressWithData(
|
||||
c,
|
||||
`name NOT IN (SELECT DISTINCT address FROM raw_mails WHERE address IS NOT NULL) AND created_at < datetime('now', '-${cleanDays} day')`
|
||||
)
|
||||
break;
|
||||
default:
|
||||
throw new Error("Invalid cleanType")
|
||||
throw new Error(msgs.InvalidCleanTypeMsg)
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -316,11 +339,12 @@ export const deleteAddressWithData = async (
|
||||
address: string | undefined | null,
|
||||
address_id: number | undefined | null
|
||||
): Promise<boolean> => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
if (!getBooleanValue(c.env.ENABLE_USER_DELETE_EMAIL)) {
|
||||
throw new Error("Delete email is disabled")
|
||||
throw new Error(msgs.UserDeleteEmailDisabledMsg)
|
||||
}
|
||||
if (!address && !address_id) {
|
||||
throw new Error("Address or address_id required")
|
||||
throw new Error(msgs.RequiredFieldMsg)
|
||||
}
|
||||
// get address_id or address
|
||||
if (!address_id) {
|
||||
@@ -334,7 +358,7 @@ export const deleteAddressWithData = async (
|
||||
}
|
||||
// check address again
|
||||
if (!address || !address_id) {
|
||||
throw new Error("Can't find address");
|
||||
throw new Error(msgs.AddressNotFoundMsg);
|
||||
}
|
||||
// unbind telegram
|
||||
await unbindTelegramByAddress(c, address);
|
||||
@@ -358,7 +382,7 @@ export const deleteAddressWithData = async (
|
||||
`DELETE FROM address WHERE name = ? `
|
||||
).bind(address).run();
|
||||
if (!success || !mailSuccess || !sendboxSuccess || !addressSuccess || !sendAccess || !autoReplySuccess) {
|
||||
throw new Error("Failed to delete address")
|
||||
throw new Error(msgs.OperationFailedMsg)
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -369,6 +393,7 @@ export const handleListQuery = async (
|
||||
limit: string | number | undefined | null,
|
||||
offset: string | number | undefined | null
|
||||
): Promise<Response> => {
|
||||
const msgs = i18n.getMessagesbyContext(c);
|
||||
if (typeof limit === "string") {
|
||||
limit = parseInt(limit);
|
||||
}
|
||||
@@ -376,10 +401,10 @@ export const handleListQuery = async (
|
||||
offset = parseInt(offset);
|
||||
}
|
||||
if (!limit || limit < 0 || limit > 100) {
|
||||
return c.text("Invalid limit", 400)
|
||||
return c.text(msgs.InvalidLimitMsg, 400)
|
||||
}
|
||||
if (offset == null || offset == undefined || offset < 0) {
|
||||
return c.text("Invalid offset", 400)
|
||||
return c.text(msgs.InvalidOffsetMsg, 400)
|
||||
}
|
||||
const resultsQuery = `${query} order by id desc limit ? offset ?`;
|
||||
const { results } = await c.env.DB.prepare(resultsQuery).bind(
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
export const CONSTANTS = {
|
||||
VERSION: 'v' + '1.0.6',
|
||||
VERSION: 'v' + '1.1.0',
|
||||
|
||||
// DB Version
|
||||
DB_VERSION_KEY: 'db_version',
|
||||
DB_VERSION: "v0.0.3",
|
||||
DB_VERSION: "v0.0.5",
|
||||
|
||||
// DB settings
|
||||
ADDRESS_BLOCK_LIST_KEY: 'address_block_list',
|
||||
@@ -15,6 +15,8 @@ export const CONSTANTS = {
|
||||
NO_LIMIT_SEND_ADDRESS_LIST_KEY: 'no_limit_send_address_list',
|
||||
EMAIL_RULE_SETTINGS_KEY: 'email_rule_settings',
|
||||
ROLE_ADDRESS_CONFIG_KEY: 'role_address_config',
|
||||
IP_BLACKLIST_SETTINGS_KEY: 'ip_blacklist_settings',
|
||||
AI_EXTRACT_SETTINGS_KEY: 'ai_extract_settings',
|
||||
|
||||
// KV
|
||||
TG_KV_PREFIX: "temp-mail-telegram",
|
||||
|
||||
235
worker/src/email/ai_extract.ts
Normal file
235
worker/src/email/ai_extract.ts
Normal file
@@ -0,0 +1,235 @@
|
||||
/**
|
||||
* AI Email Extraction Module
|
||||
*
|
||||
* This module provides email content analysis using Cloudflare Workers AI.
|
||||
* It extracts important information like verification codes, authentication links,
|
||||
* service links, and subscription management links from email content.
|
||||
*/
|
||||
|
||||
import { commonParseMail } from "../common";
|
||||
import { getBooleanValue, getJsonSetting } from "../utils";
|
||||
import { CONSTANTS } from "../constants";
|
||||
import { Context } from "hono";
|
||||
import type { AiExtractSettings } from "../admin_api/ai_extract_settings";
|
||||
|
||||
// AI Prompt for email analysis
|
||||
const PROMPT = `
|
||||
You are an expert email analyzer. Your task is to first UNDERSTAND the email content, then EXTRACT the most relevant information based on priority.
|
||||
|
||||
# Step 1: UNDERSTAND the Email
|
||||
Read the entire email carefully and determine its:
|
||||
- Overall purpose (verification, marketing, notification, etc.)
|
||||
- Key context and situation
|
||||
- What the sender wants the recipient to do
|
||||
- Any security-sensitive content
|
||||
|
||||
# Step 2: EXTRACT Based on Priority
|
||||
After understanding, extract the most important item according to this priority order:
|
||||
|
||||
**Priority 1: auth_code (Authentication Code)**
|
||||
- Numeric or alphanumeric codes used for login verification
|
||||
- Keywords: verification code, OTP, security code, confirmation code, auth code, 验证码, 校验码
|
||||
- Extract ONLY the code itself (remove spaces, hyphens, etc.)
|
||||
- Example: "123456" from "Your verification code is 123-456"
|
||||
|
||||
**Priority 2: auth_link (Authentication Link)**
|
||||
- Links used for login, email verification, account activation, or password reset
|
||||
- Keywords: verify, confirm, activate, login, signin, signup, reset, 验证, 激活, 登录
|
||||
- Must be a real, complete URL (http:// or https://)
|
||||
- Never fabricate or infer links that don't exist in the content
|
||||
- Example: "https://example.com/verify?token=abc123"
|
||||
|
||||
**Priority 3: service_link (Service Link)**
|
||||
- Links related to specific services or actions
|
||||
- Keywords: commit, pull request, issue, repository, deployment, GitHub, GitLab, code review
|
||||
- Real URLs for technical or service-related notifications
|
||||
- Example: GitHub commit link, deployment notification link
|
||||
|
||||
**Priority 4: subscription_link (Subscription Management Link)**
|
||||
- Links for managing email subscriptions, typically unsubscribe
|
||||
- Keywords: unsubscribe, opt-out, manage preferences, 退订, 取消订阅
|
||||
- Usually found at the bottom of marketing emails
|
||||
- Real URLs for subscription control
|
||||
|
||||
**Priority 5: other_link (Other Valuable Link)**
|
||||
- Any other link that might be useful or important
|
||||
- Only extract if no higher-priority items exist
|
||||
- Must be a real, complete URL from the content
|
||||
|
||||
**Priority 6: none**
|
||||
- No relevant codes, links, or valuable content found
|
||||
- Email appears to be plain text or irrelevant
|
||||
|
||||
# Special Case: Markdown Link Format
|
||||
If the extracted content is in markdown link format [text](url):
|
||||
|
||||
- Extract the text inside the brackets as result_text
|
||||
- When brackets are empty, analyze the email context and language
|
||||
- Generate a concise, meaningful description (2-5 words) for result_text
|
||||
- Match the email's language (Chinese → Chinese description, English → English)
|
||||
|
||||
# Critical Rules
|
||||
1. **Understand First**: Always analyze the email's purpose before extracting
|
||||
2. **Single Selection**: Choose ONLY ONE type based on the highest priority match
|
||||
3. **Real Data Only**: Never invent, guess, or fabricate content
|
||||
4. **Complete URLs**: Links must be full, valid URLs as they appear in the email
|
||||
5. **Clean Extraction**: Return only the raw extracted content, no extra text
|
||||
|
||||
# Output Format (JSON only)
|
||||
{
|
||||
"type": "auth_code|auth_link|service_link|subscription_link|other_link|none",
|
||||
"result": "the extracted code/link OR empty string",
|
||||
"result_text": "the display text from markdown-format links."
|
||||
}
|
||||
|
||||
IMPORTANT: Return ONLY the JSON, no explanations or additional text.
|
||||
`;
|
||||
|
||||
/**
|
||||
* Extract important information from email content using Cloudflare Workers AI
|
||||
*
|
||||
* @param content - The email content to analyze (plain text or HTML)
|
||||
* @param env - Cloudflare Workers environment bindings
|
||||
* @returns Promise<ExtractResult> - The extracted information
|
||||
*/
|
||||
async function extractWithCloudflareAI(
|
||||
content: string,
|
||||
env: Bindings
|
||||
): Promise<ExtractResult> {
|
||||
// Get the AI model name from environment variable or use default
|
||||
const modelName = env.AI_EXTRACT_MODEL || '@cf/meta/llama-3.1-8b-instruct';
|
||||
|
||||
const result = await env.AI.run(modelName as keyof AiModels, {
|
||||
messages: [
|
||||
{ role: 'system', content: PROMPT },
|
||||
{ role: 'user', content },
|
||||
],
|
||||
response_format: {
|
||||
type: 'json_schema',
|
||||
json_schema: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
type: {
|
||||
type: 'string',
|
||||
enum: ['auth_code', 'auth_link', 'service_link', 'subscription_link', 'other_link', 'none']
|
||||
},
|
||||
result: { type: 'string' },
|
||||
result_text: { type: 'string' },
|
||||
},
|
||||
required: ['type', 'result', 'result_text'],
|
||||
},
|
||||
},
|
||||
stream: false,
|
||||
});
|
||||
|
||||
// @ts-expect-error result.response
|
||||
const response = result.response;
|
||||
|
||||
if (typeof response === 'string') {
|
||||
return JSON.parse(response) as ExtractResult;
|
||||
}
|
||||
|
||||
if (response && typeof response === 'object') {
|
||||
return response as ExtractResult;
|
||||
}
|
||||
|
||||
throw new Error('Unexpected response format from Cloudflare AI');
|
||||
}
|
||||
|
||||
/**
|
||||
* Main extraction function
|
||||
* Checks if AI extraction is enabled, processes the email content, and saves to database
|
||||
*
|
||||
* @param parsedEmailContext - The parsed email context
|
||||
* @param env - Cloudflare Workers environment bindings
|
||||
* @param message_id - The email message ID
|
||||
* @param address - The recipient email address
|
||||
* @returns Promise<void>
|
||||
*/
|
||||
export async function extractEmailInfo(
|
||||
parsedEmailContext: ParsedEmailContext,
|
||||
env: Bindings,
|
||||
message_id: string | null,
|
||||
address: string
|
||||
): Promise<void> {
|
||||
try {
|
||||
// Check if AI extraction is enabled via environment variable
|
||||
if (!getBooleanValue(env.ENABLE_AI_EMAIL_EXTRACT)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Ensure AI binding is available
|
||||
if (!env.AI) {
|
||||
console.error('AI binding not available');
|
||||
return;
|
||||
}
|
||||
|
||||
// Check allowlist if enabled
|
||||
const aiSettings = await getJsonSetting<AiExtractSettings>(
|
||||
{ env: env } as Context<HonoCustomType>,
|
||||
CONSTANTS.AI_EXTRACT_SETTINGS_KEY
|
||||
);
|
||||
|
||||
if (aiSettings?.enableAllowList && aiSettings.allowList?.length > 0) {
|
||||
const isAllowed = aiSettings.allowList.some(pattern => {
|
||||
// Support wildcard matching
|
||||
if (pattern.includes('*')) {
|
||||
// Escape special regex characters except *
|
||||
const escapedPattern = pattern
|
||||
.replace(/[.+?^${}()|[\]\\]/g, '\\$&')
|
||||
.replace(/\*/g, '.*');
|
||||
const regex = new RegExp('^' + escapedPattern + '$');
|
||||
return regex.test(address);
|
||||
}
|
||||
// Exact match
|
||||
return address === pattern;
|
||||
});
|
||||
|
||||
if (!isAllowed) {
|
||||
console.log(`AI extraction skipped for ${address}: not in allowlist`);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Parse email to get content
|
||||
const parsedEmail = await commonParseMail(parsedEmailContext);
|
||||
const emailContent = parsedEmail?.text || parsedEmail?.html || "";
|
||||
|
||||
if (!emailContent) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Truncate content if too long (max 4000 characters to avoid token limits)
|
||||
const truncatedContent = emailContent.length > 4000
|
||||
? emailContent.substring(0, 4000) + '...[truncated]'
|
||||
: emailContent;
|
||||
|
||||
const result = await extractWithCloudflareAI(truncatedContent, env);
|
||||
|
||||
// If extraction found something useful, save it to database
|
||||
if (result.type !== 'none' && result.result) {
|
||||
const metadata = JSON.stringify({
|
||||
ai_extract: result,
|
||||
extracted_at: new Date().toISOString()
|
||||
});
|
||||
|
||||
// Update the raw_mails record with metadata
|
||||
await env.DB.prepare(
|
||||
`UPDATE raw_mails SET metadata = ? WHERE message_id = ?`
|
||||
).bind(metadata, message_id).run();
|
||||
|
||||
console.log(`AI extraction completed for ${message_id}: ${result.type}`);
|
||||
}
|
||||
} catch (e) {
|
||||
console.error('AI email extraction error:', e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Type definition for extraction result
|
||||
*/
|
||||
export type ExtractResult = {
|
||||
type: 'auth_code' | 'auth_link' | 'service_link' | 'subscription_link' | 'other_link' | 'none';
|
||||
result: string;
|
||||
result_text: string;
|
||||
};
|
||||
139
worker/src/email/forward.ts
Normal file
139
worker/src/email/forward.ts
Normal file
@@ -0,0 +1,139 @@
|
||||
import { Context } from "hono";
|
||||
|
||||
import { getEnvStringList, getJsonObjectValue, getJsonSetting } from "../utils";
|
||||
import { EmailRuleSettings } from "../models";
|
||||
import { CONSTANTS } from "../constants";
|
||||
|
||||
// 正则表达式最大长度限制,防止 ReDoS 攻击
|
||||
const MAX_REGEX_PATTERN_LENGTH = 200;
|
||||
|
||||
/**
|
||||
* 安全地测试单个正则表达式
|
||||
*/
|
||||
function safeRegexTest(pattern: string, input: string): boolean {
|
||||
try {
|
||||
// 限制正则复杂度:最大长度限制
|
||||
if (pattern.length > MAX_REGEX_PATTERN_LENGTH) {
|
||||
console.warn("source pattern too long, skipped:", pattern.substring(0, 50) + "...");
|
||||
return false;
|
||||
}
|
||||
const regex = new RegExp(pattern, 'i');
|
||||
return regex.test(input);
|
||||
} catch (regexError) {
|
||||
console.error("regex test error for pattern:", pattern, regexError);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 检查来源地址是否匹配正则规则
|
||||
*/
|
||||
function matchSourcePatterns(
|
||||
from: string,
|
||||
sourcePatterns: string[] | undefined | null,
|
||||
sourceMatchMode: 'any' | 'all' | undefined
|
||||
): boolean {
|
||||
if (!sourcePatterns || sourcePatterns.length === 0) {
|
||||
// 未配置来源正则,默认匹配
|
||||
return true;
|
||||
}
|
||||
|
||||
const matchMode = sourceMatchMode || 'any';
|
||||
|
||||
if (matchMode === 'all') {
|
||||
// 全部匹配模式:所有正则都必须匹配
|
||||
return sourcePatterns.every(pattern => safeRegexTest(pattern, from));
|
||||
} else {
|
||||
// 任一匹配模式(默认):任一正则匹配即可
|
||||
return sourcePatterns.some(pattern => safeRegexTest(pattern, from));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 全局转发:转发到 FORWARD_ADDRESS_LIST 中的所有地址
|
||||
*/
|
||||
async function forwardToGlobalAddresses(
|
||||
message: ForwardableEmailMessage,
|
||||
env: Bindings
|
||||
): Promise<void> {
|
||||
try {
|
||||
const forwardAddressList = getEnvStringList(env.FORWARD_ADDRESS_LIST);
|
||||
for (const forwardAddress of forwardAddressList) {
|
||||
await message.forward(forwardAddress);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error("forward email error", error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 规则转发:根据域名和来源地址正则规则转发
|
||||
*/
|
||||
async function forwardByRules(
|
||||
message: ForwardableEmailMessage,
|
||||
env: Bindings
|
||||
): Promise<void> {
|
||||
try {
|
||||
// 获取环境变量配置
|
||||
const subdomainForwardAddressList = getJsonObjectValue<SubdomainForwardAddressList[]>(
|
||||
env.SUBDOMAIN_FORWARD_ADDRESS_LIST
|
||||
) || [];
|
||||
|
||||
// 获取数据库配置
|
||||
const emailRuleSettings = await getJsonSetting<EmailRuleSettings>(
|
||||
{ env: env } as Context<HonoCustomType>,
|
||||
CONSTANTS.EMAIL_RULE_SETTINGS_KEY
|
||||
);
|
||||
|
||||
// 合并两个配置,env 里的配置优先级更高
|
||||
const allRules = [
|
||||
...(subdomainForwardAddressList || []),
|
||||
...(emailRuleSettings?.emailForwardingList || []),
|
||||
];
|
||||
|
||||
for (const rule of allRules) {
|
||||
// 检查来源地址是否匹配正则
|
||||
if (!matchSourcePatterns(message.from, rule.sourcePatterns, rule.sourceMatchMode)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// 检查目标地址是否匹配域名,并转发
|
||||
// 保持原始逻辑:每个匹配的 domain 都会触发一次转发
|
||||
if (rule.domains && rule.domains.length > 0) {
|
||||
for (const domain of rule.domains) {
|
||||
if (message.to.endsWith(domain) && rule.forward) {
|
||||
await message.forward(rule.forward);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// 域名为空,转发所有邮件
|
||||
if (rule.forward) {
|
||||
await message.forward(rule.forward);
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error("forward by rules error", error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 执行所有转发逻辑
|
||||
*/
|
||||
async function forwardEmail(
|
||||
message: ForwardableEmailMessage,
|
||||
env: Bindings
|
||||
): Promise<void> {
|
||||
// 全局转发
|
||||
await forwardToGlobalAddresses(message, env);
|
||||
|
||||
// 规则转发
|
||||
await forwardByRules(message, env);
|
||||
}
|
||||
|
||||
export {
|
||||
forwardEmail,
|
||||
forwardToGlobalAddresses,
|
||||
forwardByRules,
|
||||
matchSourcePatterns,
|
||||
};
|
||||
@@ -1,12 +1,14 @@
|
||||
import { Context } from "hono";
|
||||
|
||||
import { getEnvStringList, getJsonObjectValue, getJsonSetting } from "../utils";
|
||||
import { getJsonSetting } from "../utils";
|
||||
import { sendMailToTelegram } from "../telegram_api";
|
||||
import { auto_reply } from "./auto_reply";
|
||||
import { isBlocked } from "./black_list";
|
||||
import { triggerWebhook, triggerAnotherWorker, commonParseMail } from "../common";
|
||||
import { check_if_junk_mail } from "./check_junk";
|
||||
import { remove_attachment_if_need } from "./check_attachment";
|
||||
import { extractEmailInfo } from "./ai_extract";
|
||||
import { forwardEmail } from "./forward";
|
||||
import { EmailRuleSettings } from "../models";
|
||||
import { CONSTANTS } from "../constants";
|
||||
|
||||
@@ -78,46 +80,7 @@ async function email(message: ForwardableEmailMessage, env: Bindings, ctx: Execu
|
||||
}
|
||||
|
||||
// forward email
|
||||
try {
|
||||
const forwardAddressList = getEnvStringList(env.FORWARD_ADDRESS_LIST)
|
||||
for (const forwardAddress of forwardAddressList) {
|
||||
await message.forward(forwardAddress);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error("forward email error", error);
|
||||
}
|
||||
|
||||
// forward subdomain email
|
||||
try {
|
||||
// 遍历 FORWARD_ADDRESS_LIST
|
||||
const subdomainForwardAddressList = getJsonObjectValue<SubdomainForwardAddressList[]>(env.SUBDOMAIN_FORWARD_ADDRESS_LIST) || [];
|
||||
const emailRuleSettings = await getJsonSetting<EmailRuleSettings>(
|
||||
{ env: env } as Context<HonoCustomType>, CONSTANTS.EMAIL_RULE_SETTINGS_KEY
|
||||
);
|
||||
// 合并两个配置, env 里的配置优先级更高
|
||||
const allSubdomainForwardAddressList = [
|
||||
...(subdomainForwardAddressList || []),
|
||||
...(emailRuleSettings?.emailForwardingList || []),
|
||||
];
|
||||
for (const subdomainForwardAddress of allSubdomainForwardAddressList) {
|
||||
// 检查邮件是否匹配 domains
|
||||
if (subdomainForwardAddress.domains && subdomainForwardAddress.domains.length > 0) {
|
||||
for (const domain of subdomainForwardAddress.domains) {
|
||||
if (message.to.endsWith(domain) && subdomainForwardAddress.forward) {
|
||||
// 转发邮件
|
||||
await message.forward(subdomainForwardAddress.forward);
|
||||
// 支持多邮箱转发收件,不进行截止
|
||||
// break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// 如果 domains 为空,则转发所有邮件
|
||||
await message.forward(subdomainForwardAddress.forward);
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error("subdomain forward email error", error);
|
||||
}
|
||||
await forwardEmail(message, env);
|
||||
|
||||
// send email to telegram
|
||||
try {
|
||||
@@ -155,6 +118,9 @@ async function email(message: ForwardableEmailMessage, env: Bindings, ctx: Execu
|
||||
|
||||
// auto reply email
|
||||
await auto_reply(message, env);
|
||||
|
||||
// AI email content extraction
|
||||
await extractEmailInfo(parsedEmailContext, env, message_id, message.to);
|
||||
}
|
||||
|
||||
export { email }
|
||||
|
||||
@@ -46,6 +46,129 @@ const messages: LocaleMessages = {
|
||||
PasswordLoginDisabledMsg: "Password login is disabled",
|
||||
EmailPasswordRequiredMsg: "Email and password are required",
|
||||
AddressNotFoundMsg: "Address not found",
|
||||
|
||||
// Common messages (merged similar ones)
|
||||
OperationFailedMsg: "Operation failed",
|
||||
RequiredFieldMsg: "Required field is missing",
|
||||
InvalidInputMsg: "Invalid input",
|
||||
|
||||
// Address related
|
||||
NameTooShortMsg: "Name is too short",
|
||||
NameTooLongMsg: "Name is too long",
|
||||
InvalidDomainMsg: "Invalid domain",
|
||||
AddressAlreadyExistsMsg: "Address already exists",
|
||||
MaxAddressCountReachedMsg: "Max address count reached",
|
||||
AddressNotBindedMsg: "Address is not binded",
|
||||
AddressAlreadyBindedMsg: "Address is already binded, please unbind first",
|
||||
TargetUserNotFoundMsg: "Target user not found",
|
||||
|
||||
// Send mail related
|
||||
NoBalanceMsg: "No balance",
|
||||
AddressBlockedMsg: "Address is blocked",
|
||||
SubjectEmptyMsg: "Subject is empty",
|
||||
ContentEmptyMsg: "Content is empty",
|
||||
AlreadyRequestedMsg: "Already requested",
|
||||
EnableResendOrSmtpMsg: "Please enable resend or smtp for this domain",
|
||||
EnableResendOrSmtpWithVerifiedMsg: "Please enable resend or smtp for this domain, or add recipient to verified address list",
|
||||
InvalidToMailMsg: "Invalid recipient address",
|
||||
|
||||
// Admin related
|
||||
InvalidAddressIdMsg: "Invalid address_id",
|
||||
EnableKVMsg: "Please enable KV first",
|
||||
EnableSendMailMsg: "Please enable SEND_MAIL first",
|
||||
InvalidCleanupConfigMsg: "Invalid cleanType or cleanDays",
|
||||
InvalidCleanTypeMsg: "Invalid cleanType",
|
||||
EnableKVForMailVerifyMsg: "Please enable KV first if you want to enable mail verify",
|
||||
VerifyMailDomainInvalidMsg: "VerifyMailSender domain must be in",
|
||||
InvalidMaxAddressCountMsg: "Invalid maxAddressCount",
|
||||
FailedDeleteUserMsg: "Failed to delete user",
|
||||
InvalidUserIdMsg: "Invalid user_id",
|
||||
InvalidRoleTextMsg: "Invalid role_text",
|
||||
|
||||
// SQL validation
|
||||
SqlEmptyMsg: "SQL statement is empty",
|
||||
SqlTooLongMsg: "SQL statement is too long (max 1000 characters)",
|
||||
SqlOnlyDeleteMsg: "Only DELETE statements are allowed",
|
||||
SqlSingleStatementMsg: "Only single SQL statement is allowed",
|
||||
SqlNoCommentsMsg: "SQL comments are not allowed",
|
||||
|
||||
// Passkey related
|
||||
InvalidPasskeyNameMsg: "Invalid passkey name",
|
||||
PasskeyNotFoundMsg: "Passkey not found",
|
||||
AuthenticationFailedMsg: "Authentication failed",
|
||||
RegistrationFailedMsg: "Registration failed",
|
||||
|
||||
// Auto reply related
|
||||
AutoReplyDisabledMsg: "Auto reply is disabled",
|
||||
InvalidAutoReplyMsg: "Invalid subject or message",
|
||||
SubjectOrMessageTooLongMsg: "Subject or message is too long",
|
||||
|
||||
// Bind address related
|
||||
NoAddressOrUserTokenMsg: "No address or user token",
|
||||
InvalidAddressOrUserTokenMsg: "Invalid address or user token",
|
||||
|
||||
// Pagination related
|
||||
InvalidLimitMsg: "Invalid limit",
|
||||
InvalidOffsetMsg: "Invalid offset",
|
||||
|
||||
// Clear inbox/sent items related
|
||||
FailedClearInboxMsg: "Failed to clear inbox",
|
||||
FailedClearSentItemsMsg: "Failed to clear sent items",
|
||||
|
||||
// Webhook related
|
||||
WebhookNotAllowedForUserMsg: "Webhook settings is not allowed for this user",
|
||||
|
||||
// IP blacklist related
|
||||
InvalidIpBlacklistSettingMsg: "Invalid IP blacklist setting",
|
||||
BlacklistExceedsMaxSizeMsg: "Blacklist exceeds maximum size",
|
||||
|
||||
// Telegram bot messages
|
||||
TgUnableGetUserInfoMsg: "Unable to get user info",
|
||||
TgNoPermissionMsg: "You don't have permission to use this bot",
|
||||
TgWelcomeMsg: "Welcome! You can open the mini app",
|
||||
TgCurrentPrefixMsg: "Current prefix enabled:",
|
||||
TgCurrentDomainsMsg: "Available domains:",
|
||||
TgAvailableCommandsMsg: "Available commands:",
|
||||
TgCreateSuccessMsg: "Address created successfully:",
|
||||
TgCreateFailedMsg: "Failed to create address:",
|
||||
TgBindSuccessMsg: "Binding successful:",
|
||||
TgBindFailedMsg: "Binding failed:",
|
||||
TgUnbindSuccessMsg: "Unbinding successful:",
|
||||
TgUnbindFailedMsg: "Unbinding failed:",
|
||||
TgDeleteSuccessMsg: "Deleted successfully:",
|
||||
TgDeleteFailedMsg: "Delete failed:",
|
||||
TgAddressListMsg: "Address list:",
|
||||
TgGetAddressFailedMsg: "Failed to get address list:",
|
||||
TgCleanSuccessMsg: "Invalid addresses cleaned:",
|
||||
TgCurrentAddressListMsg: "Current address list:",
|
||||
TgCleanFailedMsg: "Failed to clean invalid addresses:",
|
||||
TgNotBoundAddressMsg: "This address is not bound:",
|
||||
TgInvalidAddressMsg: "Invalid address",
|
||||
TgNoMoreMailsMsg: "No more mails",
|
||||
TgNoMailMsg: "No mail",
|
||||
TgGetMailFailedMsg: "Failed to get mail:",
|
||||
TgParseMailFailedMsg: "Failed to parse mail:",
|
||||
TgViewMailBtnMsg: "View Mail",
|
||||
TgPrevBtnMsg: "Prev",
|
||||
TgNextBtnMsg: "Next",
|
||||
TgPleaseInputCredentialMsg: "Please enter credential",
|
||||
TgPleaseInputAddressMsg: "Please enter address",
|
||||
TgAddressMsg: "Address:",
|
||||
TgPasswordMsg: "Password:",
|
||||
TgCredentialMsg: "Credential:",
|
||||
TgNoSenderMsg: "No sender",
|
||||
TgMsgTooLongMsg: "Message too long, please view in mini app",
|
||||
TgParseFailedViewInAppMsg: "Parse failed, please view in mini app",
|
||||
TgMaxAddressReachedMsg: "Maximum address limit reached",
|
||||
TgMaxAddressReachedCleanMsg: "Maximum address limit reached, please /cleaninvalidaddress first",
|
||||
TgInvalidCredentialMsg: "Invalid credential",
|
||||
TgAddressNotYoursMsg: "This address does not belong to you",
|
||||
TgLangSetSuccessMsg: "Language set successfully:",
|
||||
TgCurrentLangMsg: "Current language:",
|
||||
TgSelectLangMsg: "Please select language:",
|
||||
TgNoPermissionViewMailMsg: "No permission to view this mail",
|
||||
TgBotTokenRequiredMsg: "TELEGRAM_BOT_TOKEN is required",
|
||||
TgLangFeatureDisabledMsg: "Language setting feature is disabled. System default language is used.",
|
||||
}
|
||||
|
||||
export default messages;
|
||||
|
||||
@@ -17,7 +17,7 @@ export default {
|
||||
getMessagesbyContext: (
|
||||
c: Context<HonoCustomType>
|
||||
): LocaleMessages => {
|
||||
const locale = c.get("lang") || c.env.DEFAULT_LANG;
|
||||
const locale = c?.get?.("lang") || c.env?.DEFAULT_LANG;
|
||||
// multi-language support
|
||||
if (locale === "en") return en;
|
||||
if (locale === "zh") return zh;
|
||||
|
||||
@@ -44,4 +44,127 @@ export type LocaleMessages = {
|
||||
PasswordLoginDisabledMsg: string
|
||||
EmailPasswordRequiredMsg: string
|
||||
AddressNotFoundMsg: string
|
||||
|
||||
// Common messages (merged similar ones)
|
||||
OperationFailedMsg: string
|
||||
RequiredFieldMsg: string
|
||||
InvalidInputMsg: string
|
||||
|
||||
// Address related
|
||||
NameTooShortMsg: string
|
||||
NameTooLongMsg: string
|
||||
InvalidDomainMsg: string
|
||||
AddressAlreadyExistsMsg: string
|
||||
MaxAddressCountReachedMsg: string
|
||||
AddressNotBindedMsg: string
|
||||
AddressAlreadyBindedMsg: string
|
||||
TargetUserNotFoundMsg: string
|
||||
|
||||
// Send mail related
|
||||
NoBalanceMsg: string
|
||||
AddressBlockedMsg: string
|
||||
SubjectEmptyMsg: string
|
||||
ContentEmptyMsg: string
|
||||
AlreadyRequestedMsg: string
|
||||
EnableResendOrSmtpMsg: string
|
||||
EnableResendOrSmtpWithVerifiedMsg: string
|
||||
InvalidToMailMsg: string
|
||||
|
||||
// Admin related
|
||||
InvalidAddressIdMsg: string
|
||||
EnableKVMsg: string
|
||||
EnableSendMailMsg: string
|
||||
InvalidCleanupConfigMsg: string
|
||||
InvalidCleanTypeMsg: string
|
||||
EnableKVForMailVerifyMsg: string
|
||||
VerifyMailDomainInvalidMsg: string
|
||||
InvalidMaxAddressCountMsg: string
|
||||
FailedDeleteUserMsg: string
|
||||
InvalidUserIdMsg: string
|
||||
InvalidRoleTextMsg: string
|
||||
|
||||
// SQL validation
|
||||
SqlEmptyMsg: string
|
||||
SqlTooLongMsg: string
|
||||
SqlOnlyDeleteMsg: string
|
||||
SqlSingleStatementMsg: string
|
||||
SqlNoCommentsMsg: string
|
||||
|
||||
// Passkey related
|
||||
InvalidPasskeyNameMsg: string
|
||||
PasskeyNotFoundMsg: string
|
||||
AuthenticationFailedMsg: string
|
||||
RegistrationFailedMsg: string
|
||||
|
||||
// Auto reply related
|
||||
AutoReplyDisabledMsg: string
|
||||
InvalidAutoReplyMsg: string
|
||||
SubjectOrMessageTooLongMsg: string
|
||||
|
||||
// Bind address related
|
||||
NoAddressOrUserTokenMsg: string
|
||||
InvalidAddressOrUserTokenMsg: string
|
||||
|
||||
// Pagination related
|
||||
InvalidLimitMsg: string
|
||||
InvalidOffsetMsg: string
|
||||
|
||||
// Clear inbox/sent items related
|
||||
FailedClearInboxMsg: string
|
||||
FailedClearSentItemsMsg: string
|
||||
|
||||
// Webhook related
|
||||
WebhookNotAllowedForUserMsg: string
|
||||
|
||||
// IP blacklist related
|
||||
InvalidIpBlacklistSettingMsg: string
|
||||
BlacklistExceedsMaxSizeMsg: string
|
||||
|
||||
// Telegram bot messages
|
||||
TgUnableGetUserInfoMsg: string
|
||||
TgNoPermissionMsg: string
|
||||
TgWelcomeMsg: string
|
||||
TgCurrentPrefixMsg: string
|
||||
TgCurrentDomainsMsg: string
|
||||
TgAvailableCommandsMsg: string
|
||||
TgCreateSuccessMsg: string
|
||||
TgCreateFailedMsg: string
|
||||
TgBindSuccessMsg: string
|
||||
TgBindFailedMsg: string
|
||||
TgUnbindSuccessMsg: string
|
||||
TgUnbindFailedMsg: string
|
||||
TgDeleteSuccessMsg: string
|
||||
TgDeleteFailedMsg: string
|
||||
TgAddressListMsg: string
|
||||
TgGetAddressFailedMsg: string
|
||||
TgCleanSuccessMsg: string
|
||||
TgCurrentAddressListMsg: string
|
||||
TgCleanFailedMsg: string
|
||||
TgNotBoundAddressMsg: string
|
||||
TgInvalidAddressMsg: string
|
||||
TgNoMoreMailsMsg: string
|
||||
TgNoMailMsg: string
|
||||
TgGetMailFailedMsg: string
|
||||
TgParseMailFailedMsg: string
|
||||
TgViewMailBtnMsg: string
|
||||
TgPrevBtnMsg: string
|
||||
TgNextBtnMsg: string
|
||||
TgPleaseInputCredentialMsg: string
|
||||
TgPleaseInputAddressMsg: string
|
||||
TgAddressMsg: string
|
||||
TgPasswordMsg: string
|
||||
TgCredentialMsg: string
|
||||
TgNoSenderMsg: string
|
||||
TgMsgTooLongMsg: string
|
||||
TgParseFailedViewInAppMsg: string
|
||||
TgMaxAddressReachedMsg: string
|
||||
TgMaxAddressReachedCleanMsg: string
|
||||
TgInvalidCredentialMsg: string
|
||||
TgAddressNotYoursMsg: string
|
||||
TgLangSetSuccessMsg: string
|
||||
TgCurrentLangMsg: string
|
||||
TgSelectLangMsg: string
|
||||
TgNoPermissionViewMailMsg: string
|
||||
TgBotTokenRequiredMsg: string
|
||||
TgLangFeatureDisabledMsg: string
|
||||
}
|
||||
|
||||
@@ -46,6 +46,129 @@ const messages: LocaleMessages = {
|
||||
PasswordLoginDisabledMsg: "密码登录已禁用",
|
||||
EmailPasswordRequiredMsg: "邮箱和密码不能为空",
|
||||
AddressNotFoundMsg: "邮箱地址不存在",
|
||||
|
||||
// Common messages (merged similar ones)
|
||||
OperationFailedMsg: "操作失败",
|
||||
RequiredFieldMsg: "缺少必填字段",
|
||||
InvalidInputMsg: "输入无效",
|
||||
|
||||
// Address related
|
||||
NameTooShortMsg: "名称太短",
|
||||
NameTooLongMsg: "名称太长",
|
||||
InvalidDomainMsg: "无效的域名",
|
||||
AddressAlreadyExistsMsg: "邮箱地址已存在",
|
||||
MaxAddressCountReachedMsg: "已达到最大地址数量限制",
|
||||
AddressNotBindedMsg: "邮箱地址未绑定",
|
||||
AddressAlreadyBindedMsg: "邮箱地址已绑定, 请先解绑",
|
||||
TargetUserNotFoundMsg: "目标用户不存在",
|
||||
|
||||
// Send mail related
|
||||
NoBalanceMsg: "余额不足",
|
||||
AddressBlockedMsg: "地址已被屏蔽",
|
||||
SubjectEmptyMsg: "主题不能为空",
|
||||
ContentEmptyMsg: "内容不能为空",
|
||||
AlreadyRequestedMsg: "已经申请过了",
|
||||
EnableResendOrSmtpMsg: "请先为此域名启用 resend 或 smtp",
|
||||
EnableResendOrSmtpWithVerifiedMsg: "请先为此域名启用 resend 或 smtp,或将收件人添加到已验证地址列表",
|
||||
InvalidToMailMsg: "收件人地址无效",
|
||||
|
||||
// Admin related
|
||||
InvalidAddressIdMsg: "无效的 address_id",
|
||||
EnableKVMsg: "请先启用 KV",
|
||||
EnableSendMailMsg: "请先启用 SEND_MAIL",
|
||||
InvalidCleanupConfigMsg: "无效的 cleanType 或 cleanDays",
|
||||
InvalidCleanTypeMsg: "无效的 cleanType",
|
||||
EnableKVForMailVerifyMsg: "如果要启用邮件验证,请先启用 KV",
|
||||
VerifyMailDomainInvalidMsg: "验证邮件发送者域名必须在",
|
||||
InvalidMaxAddressCountMsg: "无效的 maxAddressCount",
|
||||
FailedDeleteUserMsg: "删除用户失败",
|
||||
InvalidUserIdMsg: "无效的 user_id",
|
||||
InvalidRoleTextMsg: "无效的 role_text",
|
||||
|
||||
// SQL validation
|
||||
SqlEmptyMsg: "SQL 语句为空",
|
||||
SqlTooLongMsg: "SQL 语句过长 (最大 1000 字符)",
|
||||
SqlOnlyDeleteMsg: "只允许 DELETE 语句",
|
||||
SqlSingleStatementMsg: "只允许单条 SQL 语句",
|
||||
SqlNoCommentsMsg: "不允许 SQL 注释",
|
||||
|
||||
// Passkey related
|
||||
InvalidPasskeyNameMsg: "无效的 passkey 名称",
|
||||
PasskeyNotFoundMsg: "Passkey 不存在",
|
||||
AuthenticationFailedMsg: "认证失败",
|
||||
RegistrationFailedMsg: "注册失败",
|
||||
|
||||
// Auto reply related
|
||||
AutoReplyDisabledMsg: "自动回复已禁用",
|
||||
InvalidAutoReplyMsg: "无效的主题或消息",
|
||||
SubjectOrMessageTooLongMsg: "主题或消息太长",
|
||||
|
||||
// Bind address related
|
||||
NoAddressOrUserTokenMsg: "缺少地址或用户令牌",
|
||||
InvalidAddressOrUserTokenMsg: "无效的地址或用户令牌",
|
||||
|
||||
// Pagination related
|
||||
InvalidLimitMsg: "无效的 limit 参数",
|
||||
InvalidOffsetMsg: "无效的 offset 参数",
|
||||
|
||||
// Clear inbox/sent items related
|
||||
FailedClearInboxMsg: "清空收件箱失败",
|
||||
FailedClearSentItemsMsg: "清空已发送邮件失败",
|
||||
|
||||
// Webhook related
|
||||
WebhookNotAllowedForUserMsg: "此用户不允许使用 Webhook 设置",
|
||||
|
||||
// IP blacklist related
|
||||
InvalidIpBlacklistSettingMsg: "无效的 IP 黑名单设置",
|
||||
BlacklistExceedsMaxSizeMsg: "黑名单超出最大条目限制",
|
||||
|
||||
// Telegram bot messages
|
||||
TgUnableGetUserInfoMsg: "无法获取用户信息",
|
||||
TgNoPermissionMsg: "您没有权限使用此机器人",
|
||||
TgWelcomeMsg: "欢迎使用本机器人, 您可以打开 mini app",
|
||||
TgCurrentPrefixMsg: "当前已启用前缀:",
|
||||
TgCurrentDomainsMsg: "当前可用域名:",
|
||||
TgAvailableCommandsMsg: "请使用以下命令:",
|
||||
TgCreateSuccessMsg: "创建地址成功:",
|
||||
TgCreateFailedMsg: "创建地址失败:",
|
||||
TgBindSuccessMsg: "绑定成功:",
|
||||
TgBindFailedMsg: "绑定失败:",
|
||||
TgUnbindSuccessMsg: "解绑成功:",
|
||||
TgUnbindFailedMsg: "解绑失败:",
|
||||
TgDeleteSuccessMsg: "删除成功:",
|
||||
TgDeleteFailedMsg: "删除失败:",
|
||||
TgAddressListMsg: "地址列表:",
|
||||
TgGetAddressFailedMsg: "获取地址列表失败:",
|
||||
TgCleanSuccessMsg: "清理无效地址成功:",
|
||||
TgCurrentAddressListMsg: "当前地址列表:",
|
||||
TgCleanFailedMsg: "清理无效地址失败:",
|
||||
TgNotBoundAddressMsg: "未绑定此地址:",
|
||||
TgInvalidAddressMsg: "无效地址",
|
||||
TgNoMoreMailsMsg: "已经没有邮件了",
|
||||
TgNoMailMsg: "无邮件",
|
||||
TgGetMailFailedMsg: "获取邮件失败:",
|
||||
TgParseMailFailedMsg: "解析邮件失败:",
|
||||
TgViewMailBtnMsg: "查看邮件",
|
||||
TgPrevBtnMsg: "上一条",
|
||||
TgNextBtnMsg: "下一条",
|
||||
TgPleaseInputCredentialMsg: "请输入凭证",
|
||||
TgPleaseInputAddressMsg: "请输入地址",
|
||||
TgAddressMsg: "地址:",
|
||||
TgPasswordMsg: "密码:",
|
||||
TgCredentialMsg: "凭证:",
|
||||
TgNoSenderMsg: "无发件人",
|
||||
TgMsgTooLongMsg: "消息过长请到 mini app 查看",
|
||||
TgParseFailedViewInAppMsg: "解析失败,请打开 mini app 查看",
|
||||
TgMaxAddressReachedMsg: "绑定地址数量已达上限",
|
||||
TgMaxAddressReachedCleanMsg: "绑定地址数量已达上限, 请先 /cleaninvalidaddress",
|
||||
TgInvalidCredentialMsg: "无效凭证",
|
||||
TgAddressNotYoursMsg: "此地址不属于您",
|
||||
TgLangSetSuccessMsg: "语言设置成功:",
|
||||
TgCurrentLangMsg: "当前语言:",
|
||||
TgSelectLangMsg: "请选择语言:",
|
||||
TgNoPermissionViewMailMsg: "无权查看此邮件",
|
||||
TgBotTokenRequiredMsg: "需要设置 TELEGRAM_BOT_TOKEN",
|
||||
TgLangFeatureDisabledMsg: "语言设置功能已禁用,使用系统默认语言",
|
||||
}
|
||||
|
||||
export default messages;
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user