CodeCow/vmail
1
0
Fork 0
mirror of https://github.com/oiov/vmail.git synced 2026-06-05 21:03:00 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
📫 An open source temporary email tool. 只需一个域名部署临时邮箱，支持多域名后缀，密码找回。
59 Commits 3 Branches 4 Tags 4.3 MiB
TypeScript 96.8%
CSS 2.1%
JavaScript 0.6%
HTML 0.5%
64be43e6df
Go to file
oiov 64be43e6df docs: upd sql create step
2024-05-13 13:32:55 +08:00
apps upd contact email 2024-05-10 20:06:16 +08:00
docs docs: upd sql create step 2024-05-13 13:32:55 +08:00
packages feat: save password 2024-04-10 11:11:39 +08:00
.dockerignore transfer repo 2024-04-04 12:20:51 +08:00
.gitignore transfer repo 2024-04-04 12:20:51 +08:00
.npmrc chore 2024-04-09 13:23:02 +08:00
.prettierignore transfer repo 2024-04-04 12:20:51 +08:00
Dockerfile transfer repo 2024-04-04 12:20:51 +08:00
LICENSE transfer repo 2024-04-04 12:20:51 +08:00
package.json upd header svg 2024-04-18 20:18:32 +08:00
pnpm-lock.yaml close form after sending 2024-04-07 10:50:32 +08:00
pnpm-workspace.yaml transfer repo 2024-04-04 12:20:51 +08:00
prettierrc.json transfer repo 2024-04-04 12:20:51 +08:00
README_en.md upd docs and add title for domain selector 2024-04-13 19:54:45 +08:00
README.md docs: upd sql create step 2024-05-13 13:32:55 +08:00

README_en.md

𝐕𝐌𝐀𝐈𝐋.𝐃𝐄𝐕

Discord · English | 简体中文

Temporary email service build with email worker.

Features

  • 🎯 Privacy-friendly, no registration required, out-of-the-box
  • ✈️ Support email sending and receiving
  • ✨ Support saving passwords and retrieving email addresses
  • 😄 Support multiple domain name suffixes
  • 🚀 100% open source, quick deployment, no server required

Principles：

  • Receiving emails (email worker)
  • Display email (remix)
  • Mail Storage (sqlite)
  • Nodejs >= 18

Worker receives email -> saves to database -> client queries email

Self-hosted Tutorial

Requirements

  • Cloudflare account and a domain name hosted on Cloudflare
  • turso sqlite (a free plan available for personal use)
  • Vercel or fly.io to deploy Remix app

Receiving Emails steps

See receive-tutorial-en.md

Sending Emails steps

See send-tutorial-en.md

Local development

copy apps/remix/.env.example to apps/remix/.env and fill in the necessary environment variables.

git clone https://github.com/oiov/vmail
cd vmail
pnpm install

# run on localhost:3000
pnpm run remix:dev

Community Group

License

GNU General Public License v3.0

Star History

Star History Chart

Inspired by smail.pw & email.ml