cloud-mail README

The project's README from github.com/maillab/cloud-mail. As one markdown file: README.md.

Cloud Mail

基于 Cloudflare 的简约响应式邮箱服务,支持邮件发送、附件收发 🎉

简体中文 | English

releases issues stargazers forks

trendshift

项目简介

只需要一个域名,就可以创建多个不同的邮箱,类似各大邮箱平台,本项目支持署到 Cloudflare Workers ,降低服务器成本,搭建自己的邮箱服务

项目展示

功能介绍

技术栈

目录结构

cloud-mail
├── mail-worker				    # worker后端项目
│   ├── src                  
│   │   ├── api	 			    # api接口层			
│   │   ├── const  			    # 项目常量
│   │   ├── dao                 # 数据访问层
│   │   ├── email			    # 邮件处理接收
│   │   ├── entity			    # 数据库实体
│   │   ├── error			    # 自定义异常
│   │   ├── hono			    # web框架配置、拦截器、全局异常等
│   │   ├── i18n			    # 语言国际化
│   │   ├── init			    # 数据库缓存初始化
│   │   ├── model			    # 响应体数据封装
│   │   ├── security			# 身份权限认证
│   │   ├── service			    # 业务服务层
│   │   ├── template			# 消息模板
│   │   ├── utils			    # 工具类
│   │   └── index.js			# 入口文件
│   ├── pageckge.json			# 项目依赖
│   └── wrangler.toml			# 项目配置
│
├── mail-vue				    # vue前端项目
│   ├── src
│   │   ├── axios 			    # axios配置
│   │   ├── components			# 自定义组件
│   │   ├── echarts			    # echarts组件导入
│   │   ├── i18n			    # 语言国际化
│   │   ├── init			    # 入站初始化
│   │   ├── layout			    # 主体布局组件
│   │   ├── perm			    # 权限认证
│   │   ├── request			    # api接口
│   │   ├── router			    # 路由配置
│   │   ├── store			    # 全局状态管理
│   │   ├── utils			    # 工具类
│   │   ├── views			    # 页面组件
│   │   ├── app.vue			    # 入口组件
│   │   ├── main.js			    # 入口js
│   │   └── style.css			# 全局css
│   ├── package.json			# 项目依赖
└── └── env.release				# 项目配置

赞助

许可证

本项目采用 MIT 许可证

交流

Telegram

cloud-mail (maillab/cloud-mail)

Searching Database…

What is this?Cloud Mail is a minimalist email service built on Cloudflare: with just one domain you can create multiple mailboxes, like the big mail platforms but running on your own Cloudflare Workers at low cost.
Is this a hosted service I sign up for, or something I run myself?Something you run yourself — a serverless web app deployed to your own Cloudflare account (Vue 3 frontend, Hono backend on Workers), not an account on someone else's service. An online demo is available to try first.
What do I need to get my own instance running?Your own domain and a Cloudflare account. Deployment follows the project's docs — the repo ships a deploy-cloudflare.yml GitHub Actions workflow — and it runs entirely on Workers, so no VPS is required.
Can it send outgoing mail too, or only receive?It can send, but outbound mail goes through an integrated Resend account: bulk sends, inline images, attachments and delivery-status viewing are all supported.
Can I use it from my phone, or is it desktop-only?It's a responsive web app: the layout adapts to PC and most mobile browsers automatically, so it works from a phone without installing anything.
Can it automatically pull verification codes out of incoming emails?Yes — it uses Cloudflare Workers AI to recognize verification codes in received mail automatically, which is handy for sign-up and OTP flows.
Can new mail be forwarded somewhere else, like Telegram?Yes — incoming mail can be forwarded to a Telegram bot or to mailboxes at other email providers.
Is there an API for automation?Yes, an open API supports batch-creating users and querying mail with multiple filter conditions.
How does it stop bots from mass-registering accounts?Registration is protected by integrated Cloudflare Turnstile human verification.
Does it have an admin panel?Yes — admins can manage users and emails, with RBAC permission controls that restrict features and resource usage per role.
Can I customize how the site looks?Yes — you can set a custom site title, login background and transparency, and ECharts dashboards visualize system stats and mailbox growth.
Creator
maillab
Size
28.7 MB
Stars
14.7K
Age
1y
Commits · 90 Days