{"id":13453331,"url":"https://github.com/oiov/vmail","last_synced_at":"2026-04-02T22:58:23.056Z","repository":{"id":231800653,"uuid":"782503959","full_name":"oiov/vmail","owner":"oiov","description":"📫 只需一个域名部署临时邮箱到 Cloudflare Worker，使用 D1 保存数据，支持多域名后缀，密码找回，开放API接口。","archived":false,"fork":false,"pushed_at":"2026-02-11T09:07:41.000Z","size":3992,"stargazers_count":1220,"open_issues_count":1,"forks_count":275,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-11T16:21:57.675Z","etag":null,"topics":["cloudflare-workers","d1-database","email","email-sender","temporary-email"],"latest_commit_sha":null,"homepage":"https://vmail.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oiov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-05T12:27:51.000Z","updated_at":"2026-02-11T13:35:52.000Z","dependencies_parsed_at":"2025-10-19T04:26:00.330Z","dependency_job_id":"073f7fd1-3851-43e9-a275-a08dd4d52936","html_url":"https://github.com/oiov/vmail","commit_stats":null,"previous_names":["oiov/vmail"],"tags_count":2,"template":true,"template_full_name":null,"purl":"pkg:github/oiov/vmail","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oiov%2Fvmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oiov%2Fvmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oiov%2Fvmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oiov%2Fvmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oiov","download_url":"https://codeload.github.com/oiov/vmail/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oiov%2Fvmail/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29929362,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"online","status_checked_at":"2026-02-28T02:00:07.010Z","response_time":90,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudflare-workers","d1-database","email","email-sender","temporary-email"],"created_at":"2024-07-31T08:00:38.197Z","updated_at":"2026-04-02T22:58:23.051Z","avatar_url":"https://github.com/oiov.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","📧 邮箱服务","E-Mail"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\r\n  \u003ca href=\"https://trendshift.io/repositories/8681\" target=\"_blank\"\u003e\u003cimg src=\"https://trendshift.io/api/badge/repositories/8681\" alt=\"yesmore%2Fvmail | Trendshift\" style=\"width: 250px; height: 55px;\" width=\"250\" height=\"55\"/\u003e\u003c/a\u003e\r\n  \u003ch1\u003e𝐕𝐌𝐀𝐈𝐋.𝐃𝐄𝐕\u003c/h1\u003e\r\n  \u003cp\u003e\u003ca href=\"/docs/github-action-tutorial.md\"\u003e部署教程\u003c/a\u003e  ·  \u003ca href=\"/docs/ai-deploy.md\"\u003eAI帮你部署\u003c/a\u003e  ·\r\n  \u003ca href=\"https://vmail.dev/api-docs\" target=\"_blank\"\u003eAPI 文档\u003c/a\u003e · \u003ca href=\"https://github.com/oiov/vmail/blob/main/README_en.md\"\u003eEnglish\u003c/a\u003e | 简体中文\u003c/p\u003e\r\n  \u003cp\u003e使用 Cloudflare Email Worker 实现的临时电子邮件服务\u003c/p\u003e\r\n\u003c/div\u003e\n\n\u003e 🌟 本项目作者提供 **Claude Code** 稳定 API 渠道：[www.aicentos.com](https://www.aicentos.com/register?aff=Dptp) ，支持 claude-opus-4-6 等主流 AI Coding 大模型🥳\r\n\r\n## 🌈 特点\r\n\r\n- 🎯 隐私友好，无需注册，开箱即用\r\n- ✈️ 支持邮件收发\r\n- ✨ 支持保存密码，找回邮箱\r\n- 😄 支持多域名后缀\r\n- 🔌 **开放 RESTful API**，支持程序化调用\r\n- 🚀 快速部署，纯 Cloudflare 方案，无需服务器\r\n\r\n原理：\r\n\r\n- Email worker 接收电子邮件\r\n- 前端 (Vite + React) 显示电子邮件\r\n- 邮件存储 (Cloudflare D1)\r\n- 发信使用 MailChannels API\r\n\r\n## 👋 自部署教程\r\n\r\n本项目已完全基于 Cloudflare Pages 和 Cloudflare D1 构建，大大简化了部署流程。您只需要一个托管在 Cloudflare 上的域名即可。\r\n\r\n### 准备工作\r\n\r\n- [Cloudflare](https://dash.cloudflare.com/) 账户与托管在 Cloudflare 上的域名\r\n- 本地安装 [Node.js](https://nodejs.org) 环境 (版本 \u003e= 18.x) 和 [pnpm](https://pnpm.io/installation)\r\n\r\n### 自动部署 (推荐)\r\n\r\n本项目已包含一个预先配置好的 GitHub Action 工作流，可以帮助您自动将 Vmail 应用部署到 Cloudflare。\r\n\r\n详细步骤请参考 [GitHub Action 自动部署教程](/docs/github-action-tutorial.md)。\r\n\r\n### 手动部署步骤\r\n\r\n1.  **克隆项目到本地**\r\n    ```bash\r\n    git clone https://github.com/oiov/vmail\r\n    cd vmail\r\n    pnpm install\r\n    ```\r\n\r\n2.  **创建 Cloudflare D1 数据库**\r\n    在 Cloudflare 控制台或使用 Wrangler CLI 创建一个 D1 数据库。\r\n\r\n3.  **配置 `wrangler.toml`**\r\n    将根目录下的 `wrangler.toml` 文件中的 `${...}` 占位符替换为您的 Cloudflare 和 D1 配置信息。您也可以通过 Cloudflare Pages 的环境变量来设置这些值。\r\n\r\n4.  **构建和部署**\r\n    ```bash\r\n    # 构建前端应用\r\n    pnpm run build\r\n    \r\n    # 部署到 Cloudflare\r\n    pnpm run deploy\r\n    ```\r\n    Wrangler 将会自动处理前端静态资源和 Worker 的部署，并根据配置应用数据库迁移。\r\n\r\n5.  **配置电子邮件路由**\r\n    在您的 Cloudflare 域名管理界面，进入 `Email` -\u003e `Email Routing` -\u003e `Routes`，设置一个 `Catch-all` 规则，将所有发送到您域名的邮件 `Send to a Worker`，选择您刚刚部署的 Worker。\r\n\r\n### 环境变量\r\n\r\n在部署到 Cloudflare Pages 时，您需要配置以下环境变量：\r\n\r\n-   `DATABASE_NAME`: 您的 D1 数据库名称。\r\n-   `DATABASE_ID`: 您的 D1 数据库 ID。\r\n-   `COOKIES_SECRET`: 用于签名 Cookie 的密钥。\r\n-   `EMAIL_DOMAIN`: 您的邮箱域名，例如 `example.com,example.net`。\r\n-   `TURNSTILE_KEY`: 您的 Turnstile 站点密钥，可选。\r\n-   `TURNSTILE_SECRET`: 您的 Turnstile 密钥，可选。\r\n-   `PASSWORD`: 站点访问密码（可选）。\r\n-   `API_RATE_LIMIT_PER_MINUTE`: API 每分钟请求限制（可选，默认 100）。\r\n\r\n## 🔨 本地运行调试\r\n\r\n1.  **复制环境变量文件**\r\n    ```bash\r\n    # 此命令会创建一个本地环境变量文件，wrangler dev 会自动加载\r\n    cp .env.example .env\r\n    ```\r\n\r\n2.  **填写本地环境变量**\r\n    在 `.env` 文件中填写必要的环境变量，特别是 `D1_DATABASE_ID` 等。您需要先在 Cloudflare 创建一个 D1 数据库用于本地开发。\r\n\r\n3.  **启动开发服务器**\r\n    ```bash\r\n    pnpm run dev\r\n    ```\r\n    该命令会同时启动前端 Vite 开发服务器和本地的 Wrangler Worker 环境。\r\n\r\n## 📖 API 文档\r\n\r\nVmail 提供完整的 RESTful API，支持通过程序化方式创建临时邮箱、查询收件箱。\r\n\r\n### 获取 API Key\r\n\r\n访问 [API 文档页面](https://vmail.dev/api-docs) 创建免费的 API Key。\r\n\r\n### API 端点\r\n\r\n| 方法     | 端点                                        | 说明                   |\r\n| -------- | ------------------------------------------- | ---------------------- |\r\n| `POST`   | `/api/v1/mailboxes`                         | 创建临时邮箱           |\r\n| `GET`    | `/api/v1/mailboxes/:id`                     | 获取邮箱信息           |\r\n| `GET`    | `/api/v1/mailboxes/:id/messages`            | 获取收件箱（支持分页） |\r\n| `GET`    | `/api/v1/mailboxes/:id/messages/:messageId` | 获取邮件详情           |\r\n| `DELETE` | `/api/v1/mailboxes/:id/messages/:messageId` | 删除邮件               |\r\n\r\n### 快速开始\r\n\r\n```bash\r\n# 1. 创建临时邮箱\r\ncurl -X POST https://vmail.dev/api/v1/mailboxes \\\r\n  -H \"X-API-Key: your-api-key\" \\\r\n  -H \"Content-Type: application/json\"\r\n\r\n# 响应: { \"data\": { \"id\": \"abc123\", \"address\": \"random@domain.com\", ... } }\r\n\r\n# 2. 查询收件箱\r\ncurl https://vmail.dev/api/v1/mailboxes/abc123/messages \\\r\n  -H \"X-API-Key: your-api-key\"\r\n\r\n# 3. 获取邮件详情\r\ncurl https://vmail.dev/api/v1/mailboxes/abc123/messages/msg_001 \\\r\n  -H \"X-API-Key: your-api-key\"\r\n```\r\n\r\n完整文档请访问：[https://vmail.dev/api-docs](https://vmail.dev/api-docs)\r\n\r\n## 📝 License\r\n\r\nGNU General Public License v3.0\r\n\r\n## Star History\r\n\r\n[![Star History Chart](https://api.star-history.com/svg?repos=oiov/vmail\u0026type=Date)](https://star-history.com/#oiov/vmail\u0026Date)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foiov%2Fvmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foiov%2Fvmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foiov%2Fvmail/lists"}