logo
0
0
WeChat Login
Dream Hunter<dreamhunter2333@gmail.com>
docs: update English README and add English CHANGELOG (#792)

Cloudflare Temp Email - Free Temporary Email Service

docs MIT License GitHub contributors GitHub top language

Featured|HelloGitHub

🇨🇳 中文文档 | 🇺🇸 English Document

This project is for learning and personal use only. Please do not use it for any illegal activities, or you will be responsible for the consequences.

🎉 A fully-featured temporary email service!

  • 🆓 Completely Free - Built on Cloudflare's free services with zero cost
  • High Performance - Rust WASM email parsing for extremely fast response
  • 🎨 Modern UI - Responsive design with multi-language support and easy operation
  • 🔐 Address Password - Support setting individual passwords for email addresses to enhance security (enabled via ENABLE_ADDRESS_PASSWORD)

📚 Deployment Documentation - Quick Start

📖 Documentation | 🚀 Github Action Deployment Guide

Deploy to Cloudflare Workers

📝 Changelog

See CHANGELOG for the latest updates.

🎯 Live Demo

Try it now → https://mail.awsl.uk/

📊 Service Status Monitoring (Click to expand/collapse)
BackendDeploy Backend Production
FrontendDeploy Frontend
⭐ Star History (Click to expand/collapse) Star History Chart
📖 Table of Contents (Click to expand/collapse)

✨ Core Features

✨ Core Features Details (Click to expand/collapse)

📧 Email Processing

  • Use rust wasm to parse emails, with fast parsing speed. Almost all emails can be parsed. Even emails that Node.js parsing modules fail to parse can be successfully parsed by rust wasm
  • AI Email Recognition - Use Cloudflare Workers AI to automatically extract verification codes, authentication links, service links and other important information from emails
  • Support sending emails with DKIM verification
  • Support multiple sending methods such as SMTP and Resend
  • Add attachment viewing feature with support for displaying attachment images
  • Support S3 attachment storage and deletion
  • Spam detection and blacklist/whitelist configuration
  • Email forwarding feature with global forwarding address support

👥 User Management

  • Use credentials to log in to previously used mailboxes
  • Add complete user registration and login functionality. Users can bind email addresses and automatically obtain email JWT credentials to switch between different mailboxes after binding
  • Support OAuth2 third-party login (Github, Authentik, etc.)
  • Support Passkey passwordless login
  • User role management with support for multi-role domain and prefix configuration
  • User inbox viewing with address and keyword filtering support

🔧 Admin Features

  • Complete admin console
  • Create mailboxes without prefix in admin backend
  • Admin user management page with user address viewing feature
  • Scheduled cleanup function with support for multiple cleanup strategies
  • Get mailboxes with custom names, admin can configure blacklist
  • Add access password for use as a private site

🌐 Multi-language & Interface

  • Both frontend and backend support multi-language
  • Modern UI design with responsive layout
  • Google Ads integration support
  • Use shadow DOM to prevent style pollution
  • Support URL JWT parameter auto-login

🤖 Integration & Extensions

  • Complete Telegram Bot support, Telegram push notifications, and Telegram Bot mini app
  • Add SMTP proxy server supporting SMTP for sending emails and IMAP for viewing emails
  • Webhook support and message push integration
  • Support CF Turnstile CAPTCHA verification
  • Rate limiting configuration to prevent abuse

🏗️ Technical Architecture

🏗️ Technical Architecture Details (Click to expand/collapse)

🏛️ System Architecture

  • Database: Cloudflare D1 as the main database
  • Frontend Deployment: Deploy frontend using Cloudflare Pages
  • Backend Deployment: Deploy backend using Cloudflare Workers
  • Email Routing: Use Cloudflare Email Routing

🛠️ Tech Stack

  • Frontend: Vue 3 + Vite + TypeScript
  • Backend: TypeScript + Cloudflare Workers
  • Email Parsing: Rust WASM (mail-parser-wasm)
  • Database: Cloudflare D1 (SQLite)
  • Storage: Cloudflare KV + R2 (optional S3)
  • Proxy Service: Python SMTP/IMAP Proxy Server

📦 Main Components

  • Worker: Core backend service
  • Frontend: Vue 3 user interface
  • Mail Parser WASM: Rust email parsing module
  • SMTP Proxy Server: Python email proxy service
  • Pages Functions: Cloudflare Pages middleware
  • Documentation: VitePress documentation site

Important Notes

  • When adding domain records in Resend, if your DNS provider is hosting your 3rd level domain a.b.com, please remove the 2nd level domain prefix b from the default name generated by Resend, otherwise it will add a.b.b.com, causing verification to fail. After adding the record, you can verify it using:
nslookup -qt="mx" a.b.com 1.1.1.1

🌟 Join the Community