From 498ffe1b1882d5d66a1861fff0116d8564734700 Mon Sep 17 00:00:00 2001 From: shumengya Date: Wed, 24 Jun 2026 22:10:22 +0800 Subject: [PATCH] chore: sync local changes to Gitea --- README.md | 364 +- mail-vue/index.html | 4 +- mail-vue/package-lock.json | 8095 +++++++++++++++++++++++++++ mail-vue/public/favicon.ico | Bin 0 -> 90600 bytes mail-vue/public/logo.png | Bin 0 -> 2892070 bytes mail-vue/src/layout/aside/index.vue | 7 +- mail-vue/vite.config.js | 2 +- mail-worker/package-lock.json | 6501 +++++++++++++++++++++ mail-worker/wrangler-action.toml | 53 - mail-worker/wrangler-dev.toml | 44 - mail-worker/wrangler-test.toml | 45 - 11 files changed, 14871 insertions(+), 244 deletions(-) create mode 100644 mail-vue/package-lock.json create mode 100644 mail-vue/public/favicon.ico create mode 100644 mail-vue/public/logo.png create mode 100644 mail-worker/package-lock.json delete mode 100644 mail-worker/wrangler-action.toml delete mode 100644 mail-worker/wrangler-dev.toml delete mode 100644 mail-worker/wrangler-test.toml diff --git a/README.md b/README.md index b0a5764..0f29d6a 100644 --- a/README.md +++ b/README.md @@ -3,156 +3,324 @@

Cloud Mail

基于 Cloudflare 的简约响应式邮箱服务，支持邮件发送、附件收发 🎉

- 简体中文 | English + 简体中文 | English

- - - - + + license + + releases - - + + issues - + stargazers - - + + forks

- - trendshift + + trendshift

+--- -## 项目简介 +## 📖 项目简介 -只需要一个域名，就可以创建多个不同的邮箱，类似各大邮箱平台，本项目支持署到 Cloudflare Workers ，降低服务器成本，搭建自己的邮箱服务 +Cloud Mail 是一个基于 Cloudflare 生态构建的轻量级邮箱服务。只需一个域名，即可创建多个邮箱账号，实现类似 Gmail、QQ 邮箱等主流平台的收发邮件功能。 -## 项目展示 +本项目采用前后端分离架构，后端部署在 Cloudflare Workers，前端为 Vue3 单页应用，无需传统服务器，大幅降低运维成本。 -- [在线演示](https://skymail.ink)
-- [部署文档](https://doc.skymail.ink)
+- 🌐 [在线演示](https://skymail.ink) +- 📚 [部署文档](https://doc.skymail.ink) +- 💬 [Telegram 交流群](https://t.me/cloud_mail_tg) -| ![](/doc/demo/demo1.png) | ![](/doc/demo/demo2.png) | -|-----------------------|-----------------------| -| ![](/doc/demo/demo3.png) | ![](/doc/demo/demo4.png) | +## 📸 项目展示 +| ![首页](doc/demo/demo1.png) | ![收件箱](doc/demo/demo2.png) | +|:--:|:--:| +| ![写邮件](doc/demo/demo3.png) | ![管理后台](doc/demo/demo4.png) | +## ✨ 功能特性 +- **💰 零成本部署** - 基于 Cloudflare 免费套餐，无需购买服务器 +- **💻 响应式设计** - 完美适配 PC、平板和移动设备 +- **📧 邮件收发** - 集成 Resend 实现邮件发送，支持群发、附件、内嵌图片 +- **📦 附件管理** - 使用 Cloudflare R2 存储附件，支持大文件上传下载 +- **🛡️ 权限管理** - RBAC 权限控制，支持用户分级和资源限制 +- **🔔 消息推送** - 邮件到达后自动推送到 Telegram 机器人 +- **📡 开放 API** - 提供 RESTful API，支持批量操作用户和邮件 +- **🔢 验证码识别** - 集成 Workers AI 自动识别邮件中的验证码 +- **📊 数据可视化** - 使用 ECharts 展示系统数据和使用统计 +- **🎨 个性化** - 支持自定义网站标题、登录页背景、透明度等 +- **🤖 人机验证** - 集成 Cloudflare Turnstile 防止恶意注册 -## 功能介绍 +## 🚀 快速开始 -- **💰 低成本使用**： 可部署到 Cloudflare Workers 降低服务器成本 +### 环境要求 -- **💻 响应式设计**：响应式布局自动适配PC和大部分手机端浏览器 +- [Node.js](https://nodejs.org/) 18+ +- [npm](https://www.npmjs.com/) 或 [pnpm](https://pnpm.io/) +- [Cloudflare 账号](https://dash.cloudflare.com/) +- [Resend 账号](https://resend.com/)（用于发送邮件） -- **📧 邮件发送**：集成Resend发送邮件，支持群发，内嵌图片和附件发送，发送状态查看 +### 安装依赖 -- **🛡️ 管理员功能**：可以对用户，邮件进行管理，RABC权限控制对功能及使用资源限制 +```bash +# 克隆项目 +git clone https://github.com/maillab/cloud-mail.git +cd cloud-mail -- **📦 附件收发**：支持收发附件，使用R2对象存储保存和下载文件 +# 安装后端依赖 +cd mail-worker +npm install -- **🔔 邮件推送**：接收邮件后可以转发到TG机器人或其他服务商邮箱 +# 安装前端依赖 +cd ../mail-vue +npm install +``` -- **📡 开放API**：支持使用API批量生成用户，多条件查询邮件 +### 本地开发 -- **🔢 验证码识别**：使用Workers AI，自动识别邮件验证码 +**1. 配置后端** -- **📈 数据可视化**：使用ECharts对系统数据详情，用户邮件增长可视化显示 +```bash +cd mail-worker -- **🎨 个性化设置**：可以自定义网站标题，登录背景，透明度 +# 创建开发环境配置 +cp wrangler.toml.example wrangler-dev.toml -- **🤖 人机验证**：集成Turnstile人机验证，防止人机批量注册 +# 编辑配置（填入你的 Cloudflare 账号信息） +# 参见下方「配置说明」章节 +``` -- **📜 更多功能**：正在开发中... +**2. 启动后端开发服务器** +```bash +npm run dev +# 或使用 wrangler 命令 +wrangler dev --config wrangler-dev.toml +``` +**3. 启动前端开发服务器** -## 技术栈 +```bash +cd mail-vue +npm run dev +``` -- **平台**：[Cloudflare Workers](https://developers.cloudflare.com/workers/) +前端默认运行在 `http://localhost:5173`，后端在 `http://localhost:8787`。 -- **Web框架**：[Hono](https://hono.dev/) +## 🛠️ 技术栈 -- **ORM：**[Drizzle](https://orm.drizzle.team/) +| 层级 | 技术 | 说明 | +|:---|:---|:---| +| **运行平台** | [Cloudflare Workers](https://workers.cloudflare.com/) | 边缘计算平台 | +| **Web 框架** | [Hono](https://hono.dev/) | 轻量级 Web 框架 | +| **ORM** | [Drizzle ORM](https://orm.drizzle.team/) | 类型安全的 ORM | +| **数据库** | [Cloudflare D1](https://developers.cloudflare.com/d1/) | SQLite 边缘数据库 | +| **缓存** | [Cloudflare KV](https://developers.cloudflare.com/kv/) | 键值存储 | +| **文件存储** | [Cloudflare R2](https://developers.cloudflare.com/r2/) | 对象存储 | +| **前端框架** | [Vue 3](https://vuejs.org/) | 渐进式 JS 框架 | +| **UI 组件** | [Element Plus](https://element-plus.org/) | Vue 3 组件库 | +| **状态管理** | [Pinia](https://pinia.vuejs.org/) | Vue 官方状态管理 | +| **图表** | [ECharts](https://echarts.apache.org/) | 数据可视化 | +| **邮件服务** | [Resend](https://resend.com/) | 现代化邮件 API | -- **前端框架**：[Vue3](https://vuejs.org/) - -- **UI框架**：[Element Plus](https://element-plus.org/) - -- **邮件推送：** [Resend](https://resend.com/) - -- **缓存**：[Cloudflare KV](https://developers.cloudflare.com/kv/) - -- **数据库**：[Cloudflare D1](https://developers.cloudflare.com/d1/) - -- **文件存储**：[Cloudflare R2](https://developers.cloudflare.com/r2/) - -## 目录结构 +## 📁 项目结构 ``` -cloud-mail -├── mail-worker # worker后端项目 -│ ├── src -│ │ ├── api # api接口层 -│ │ ├── const # 项目常量 -│ │ ├── dao # 数据访问层 -│ │ ├── email # 邮件处理接收 -│ │ ├── entity # 数据库实体 -│ │ ├── error # 自定义异常 -│ │ ├── hono # web框架配置、拦截器、全局异常等 -│ │ ├── i18n # 语言国际化 -│ │ ├── init # 数据库缓存初始化 -│ │ ├── model # 响应体数据封装 -│ │ ├── security # 身份权限认证 -│ │ ├── service # 业务服务层 -│ │ ├── template # 消息模板 -│ │ ├── utils # 工具类 -│ │ └── index.js # 入口文件 -│ ├── pageckge.json # 项目依赖 -│ └── wrangler.toml # 项目配置 +cloud-mail/ +├── mail-worker/ # 后端 Worker 项目 +│ ├── src/ +│ │ ├── api/ # API 接口层 +│ │ ├── const/ # 常量定义 +│ │ ├── dao/ # 数据访问层 +│ │ ├── email/ # 邮件收发处理 +│ │ ├── entity/ # 数据库实体 +│ │ ├── error/ # 异常定义 +│ │ ├── hono/ # Web 框架配置 +│ │ ├── i18n/ # 国际化 +│ │ ├── init/ # 初始化逻辑 +│ │ ├── model/ # 数据模型 +│ │ ├── security/ # 权限认证 +│ │ ├── service/ # 业务逻辑层 +│ │ ├── template/ # 邮件模板 +│ │ ├── utils/ # 工具函数 +│ │ └── index.js # 入口文件 +│ ├── package.json +│ └── wrangler.toml # 部署配置 │ -├── mail-vue # vue前端项目 -│ ├── src -│ │ ├── axios # axios配置 -│ │ ├── components # 自定义组件 -│ │ ├── echarts # echarts组件导入 -│ │ ├── i18n # 语言国际化 -│ │ ├── init # 入站初始化 -│ │ ├── layout # 主体布局组件 -│ │ ├── perm # 权限认证 -│ │ ├── request # api接口 -│ │ ├── router # 路由配置 -│ │ ├── store # 全局状态管理 -│ │ ├── utils # 工具类 -│ │ ├── views # 页面组件 -│ │ ├── app.vue # 入口组件 -│ │ ├── main.js # 入口js -│ │ └── style.css # 全局css -│ ├── package.json # 项目依赖 -└── └── env.release # 项目配置 +├── mail-vue/ # 前端 Vue 项目 +│ ├── src/ +│ │ ├── axios/ # Axios 配置 +│ │ ├── components/ # 公共组件 +│ │ ├── echarts/ # 图表组件 +│ │ ├── i18n/ # 国际化 +│ │ ├── init/ # 初始化 +│ │ ├── layout/ # 布局组件 +│ │ ├── perm/ # 权限管理 +│ │ ├── request/ # API 请求封装 +│ │ ├── router/ # 路由配置 +│ │ ├── store/ # 状态管理 +│ │ ├── utils/ # 工具函数 +│ │ ├── views/ # 页面视图 +│ │ ├── app.vue # 根组件 +│ │ ├── main.js # 入口文件 +│ │ └── style.css # 全局样式 +│ ├── package.json +│ └── vite.config.js # Vite 配置 +│ +├── doc/ # 文档和演示图片 +├── LICENSE # MIT 许可证 +└── README.md # 本文件 ``` -## 赞助 +## ⚙️ 配置说明 - - +### 后端配置 (mail-worker/wrangler.toml) + +```toml +name = "cloud-mail" +main = "src/index.js" +compatibility_date = "2024-01-01" + +# D1 数据库绑定 +[[d1_databases]] +binding = "DB" +database_name = "cloud-mail-db" +database_id = "your-database-id" + +# KV 缓存绑定 +[[kv_namespaces]] +binding = "CACHE" +id = "your-kv-id" + +# R2 存储绑定 +[[r2_buckets]] +binding = "STORAGE" +bucket_name = "cloud-mail-storage" + +# 环境变量 +[vars] +RESEND_API_KEY = "your-resend-api-key" +JWT_SECRET = "your-jwt-secret" +ADMIN_EMAIL = "admin@yourdomain.com" +``` + +### 前端配置 (mail-vue/.env) + +```env +# 开发环境 +VITE_API_BASE_URL=http://localhost:8787 + +# 生产环境 +VITE_API_BASE_URL=https://your-worker.your-subdomain.workers.dev +``` + +## 🚢 部署指南 + +### 部署后端 + +```bash +cd mail-worker + +# 测试环境部署 +npm run test + +# 生产环境部署 +npm run deploy +``` + +### 部署前端 + +前端需要构建后部署到任意静态托管服务（如 Cloudflare Pages、Vercel、Netlify 等）： + +```bash +cd mail-vue + +# 构建生产版本 +npm run build + +# 构建结果在 dist/ 目录，可直接部署 +``` + +### 推荐使用 Cloudflare Pages 部署前端 + +1. 在 Cloudflare Dashboard 创建 Pages 项目 +2. 连接 GitHub 仓库 +3. 构建设置： + - 构建命令：`cd mail-vue && npm run build` + - 构建输出目录：`mail-vue/dist` +4. 添加环境变量（参考上方配置说明） + +## 📝 开发脚本 + +### 后端 (mail-worker) + +| 命令 | 说明 | +|:---|:---| +| `npm run dev` | 本地开发模式 | +| `npm run start` | 启动开发服务器（同 dev） | +| `npm run test` | 部署到测试环境 | +| `npm run deploy` | 部署到生产环境 | + +### 前端 (mail-vue) + +| 命令 | 说明 | +|:---|:---| +| `npm run dev` | 本地开发模式 | +| `npm run remote` | 使用远程 API 开发 | +| `npm run build` | 构建生产版本 | +| `npm run eo` | 构建 EO 环境 | +| `npm run preview` | 预览构建结果 | + +## 🤝 贡献指南 + +欢迎提交 Issue 和 Pull Request！ + +1. Fork 本仓库 +2. 创建特性分支：`git checkout -b feature/amazing-feature` +3. 提交更改：`git commit -m 'Add amazing feature'` +4. 推送分支：`git push origin feature/amazing-feature` +5. 创建 Pull Request + +## ❓ 常见问题 + +**Q: 项目完全免费吗？** +A: 基于 Cloudflare 免费套餐可以运行基本功能，但如果邮件量大或附件多，可能需要升级到付费套餐。 + +**Q: 支持自定义域名吗？** +A: 支持，可以在 Cloudflare 中为 Workers 和 Pages 绑定自定义域名。 + +**Q: 如何接收邮件？** +A: 需要在域名 DNS 中添加 MX 记录指向 Cloudflare Email Routing，具体参见部署文档。 + +## 💖 赞助支持 + +如果本项目对你有帮助，欢迎赞助支持开发者： + + + 赞助 -## 许可证 +## 📄 许可证 -本项目采用 [MIT](LICENSE) 许可证 +本项目基于 [MIT](LICENSE) 许可证开源。 +## 💬 社区交流 -## 交流 - -[Telegram](https://t.me/cloud_mail_tg) - +- [Telegram 群组](https://t.me/cloud_mail_tg) +- [GitHub Issues](https://github.com/maillab/cloud-mail/issues) +--- +

+ Made with ❤️ by Cloud Mail Team +

diff --git a/mail-vue/index.html b/mail-vue/index.html index 185aff1..606a722 100644 --- a/mail-vue/index.html +++ b/mail-vue/index.html @@ -6,7 +6,7 @@ Cloud Mail - +