🚀 ZMAIL - 24-hour Temporary Email Service

English | 中文

If you find this project helpful, please consider giving it a ⭐️ Star ⭐️. Your support is greatly appreciated!

💌 Secure, Simple, Disposable Email Service

🌐 Live Demo • ✨ Features • 🚀 Deployment • 💻 Development • 🔧 Tech Stack

---

📹 Video Tutorial

1. Project Introduction and Feature Demonstration
2. Detailed Steps for Integrated Worker Deployment to Cloudflare
3. How to Fork the Project and Customize Configuration
4. Configuring Cloudflare Email Routing
5. Setting up Environment Variables and D1 Database

---

✨ Features

✨ Instant Creation

Get a temporary email address instantly, no registration required

🔒 Privacy Protection

Protect your real email from spam and data leaks

⚡ Real-time Reception

Receive emails in real-time without refreshing the page

🌐 Global Availability

Built on Cloudflare's global edge network for fast access worldwide

🔄 Auto-refresh

Automatically check for new emails, never miss important messages

📱 Responsive Design

Perfect fit for all devices, from mobile to desktop

---

🚀 Quick Deployment

ZMAIL now adopts a brand new integrated deployment approach, with frontend and backend integrated into a single Cloudflare Worker, making deployment even simpler!

🎯 Deployment Options

We provide two deployment methods, you can choose according to your needs:

Option 1: One-Click Deployment (Recommended for Beginners)

✅ Advantages:

• Simple deployment, one-click completion
• No need to modify configuration files
• Perfect for quick testing

❌ Disadvantages:

• Cannot receive subsequent code updates
• Need to manually bind custom domain

📋 Deployment Steps:

1. Click the "Deploy to Cloudflare" button above
2. Follow the page instructions to connect your GitHub account
3. Fill in application name and database name
4. In Advanced Settings -> Build Variables, set:
   • VITE_EMAIL_DOMAIN: Your domain list, separated by ',' (e.g., mdzz.uk,zaunist.com)
5. Click "Create and Deploy"
6. After deployment, bind custom domain in Cloudflare Workers dashboard
7. Configure Cloudflare Email routing to forward emails to your Worker

Option 2: Fork and Custom Deployment (Recommended for Advanced Users)

✅ Advantages:

• Can receive subsequent code updates
• Fully customizable configuration
• Better version control

❌ Disadvantages:

• Need to manually modify configuration files
• Requires some technical knowledge
• Need to manually create database

📋 Deployment Steps:

1. Fork this project to your GitHub account
2. Create a D1 database in Cloudflare Dashboard, remember the database name and id
3. Modify the wrangler.toml file in the root directory:
   • Modify name to your application name (optional)
   • Modify routes with your custom domain (required! Default worker.dev domain is not accessible in mainland China)
   • Modify database_name and database_id to your D1 database information (required!)
   • Modify VITE_EMAIL_DOMAIN to your domain list (optional, just for convenient copy-paste of email addresses on the webpage, doesn't affect email reception)
4. In Cloudflare Dashboard, select "Workers & Pages"
5. Click "Create application" -> "Pages" -> "Connect to Git"
6. Select your forked repository
7. Configure build settings (usually auto-detected)
8. Click "Save and Deploy"
9. Configure Cloudflare Email routing to forward emails to your Worker

📧 Configure Email Routing

Regardless of which deployment method you choose, you need to configure Cloudflare Email routing:

1. Find your domain in the Cloudflare dashboard
2. Go to "Email" -> "Email Routing"
3. Enable Email Routing
4. Add routing rules:
   • Match type: "Catch-all address"
   • Action: "Send to a Worker"
   • Select your deployed Worker
5. If you have multiple domains, repeat the above steps for each domain

---

💻 Local Development

🚀 Development

# install dependencies
pnpm install

# start frontend development server
pnpm dev:frontend

# start backend development server
pnpm dev:backend

⚙️ Deployment

# deploy
pnpm run deploy

---

🔧 Tech Stack

🎨 Frontend

• React - UI library
• TypeScript - Type-safe JavaScript
• Tailwind CSS - Utility-first CSS framework
• Vite - Modern frontend build tool

⚙️ Backend

• Cloudflare Workers - Edge computing platform
• Cloudflare D1 - Edge SQL database
• Cloudflare Email Workers - Email processing service

---

👥 Contributing

Contributions via Pull Requests or Issues are welcome!

⭐ Support This Project

If this project has been helpful to you, or if you like it, please give it a Star ⭐️

Your support motivates me to make continuous improvements!

📄 License

MIT License