Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 1.83 KB

README_en.md

File metadata and controls

67 lines (44 loc) · 1.83 KB
Raw

𝐕𝐌𝐀𝐈𝐋.𝐃𝐄𝐕

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