https://github.com/oiov/vmail

📫 An open source temporary email tool. 只需一个域名部署临时邮箱，支持收发邮件，多域名邮箱配置，密码找回。
https://github.com/oiov/vmail

Last synced: about 1 month ago
JSON representation

📫 An open source temporary email tool. 只需一个域名部署临时邮箱，支持收发邮件，多域名邮箱配置，密码找回。

• Host: GitHub
• URL: https://github.com/oiov/vmail
• Owner: oiov
• License: gpl-3.0
• Created: 2024-04-05T12:27:51.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-13T11:54:47.000Z (8 months ago)
• Last Synced: 2024-04-14T01:16:04.838Z (8 months ago)
• Language: TypeScript
• Homepage: https://vmail.dev
• Size: 449 KB
• Stars: 130
• Watchers: 2
• Forks: 29
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cloudflare - vmail

README

        


  
𝐕𝐌𝐀𝐈𝐋.𝐃𝐄𝐕

  
Discord · English | 简体中文

  
使用 Cloudflare email worker 实现的临时电子邮件服务

  

  



## 🌈 特点

- 🎯 隐私友好，无需注册，开箱即用

- ✈️ 支持邮件收发

- ✨ 支持保存密码，找回邮箱

- 😄 支持多域名后缀

- 🚀 快速部署，无需服务器

原理：

- Email worker 接收电子邮件

- 前端显示电子邮件（remix）

- 邮件存储（sqlite）

- 发信使用 MailChannel API

## 👋 自部署教程

### 准备工作

- [Cloudflare](https://dash.cloudflare.com/) 账户与托管在 Cloudflare 上的域名

- [turso](https://turso.tech) sqlite 数据库（个人免费计划足够）

- [Vercel](https://vercel.com) 或 [fly.io](https://fly.io) 账号部署前端用户界面

- 本地安装 [Nodejs](https://nodejs.org) 环境 (版本 >= 18.x)

### 接收邮件教程

查看 [receive-tutorial.md](/docs/receive-tutorial.md)

### 发送邮件教程

```JSON

注意：不再建议使用此方法，原因参考 issue#17，vmail.dev 将下线发件功能

```

查看 [send-tutorial.md](/docs/send-tutorial.md)

## 🔨 本地运行调试

```bash

git clone https://github.com/oiov/vmail

cd vmail

# 安装依赖

pnpm install

# 运行端口 localhost:3000

pnpm run remix:dev

```

运行前复制 `apps/remix/.env.example` 文件并重命名为 `apps/remix/.env`，填写必要的环境变量。

## 🌈 下一步计划

- [ ] 使用 [Cloudflare D1](https://developers.cloudflare.com/d1/) 数据库重构，简化部署流程

## ❤️ 交流群

有任何问题或意见，欢迎加入交流群讨论。

- 添加微信 `yesmore_cc` (**备注你的职业**) 拉讨论群

- Discord: https://discord.gg/d68kWCBDEs

## 🎨 Inspired By

Please check out these previous works that helped inspire the creation of vmail. 🙏

- [akazwz/smail](https://github.com/akazwz/smail)

- [email.ml](email.ml)

## 📝 License

GNU General Public License v3.0

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=oiov/vmail&type=Date)](https://star-history.com/#oiov/vmail&Date)