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…

这是什么东西?Cloud Mail 是一个基于 Cloudflare 的极简邮件服务:只需要一个域名,就能创建多个邮箱,效果和大邮箱平台差不多,但运行在你自己的 Cloudflare Workers 上,成本很低。
这是需要注册使用的在线服务,还是我自己搭建的?是自己搭建的——一个部署到你自己的 Cloudflare 账户的无服务器网页应用(前端用 Vue 3,后端是运行在 Workers 上的 Hono),不是在别人家平台注册账号。可以先试用在线演示。
要跑起自己的实例需要准备什么?只需要你自己的域名和一个 Cloudflare 账户。部署按照项目文档操作即可——仓库自带 deploy-cloudflare.yml GitHub Actions 工作流——而且完全运行在 Workers 上,不需要 VPS。
它也能发邮件,还是只能收信?可以发信,不过发出去的邮件要通过集成的 Resend 账户发送:支持群发、内嵌图片、附件,以及查看投递状态。
手机上能用吗,还是只能在电脑上用?它是一个响应式网页应用:页面布局会自动适配电脑和大多数手机浏览器,不用安装任何东西,手机上直接用就行。
它能自动从收到的邮件里提取验证码吗?能——它用 Cloudflare Workers AI 自动识别收到的邮件中的验证码,注册、OTP 这类场景用起来很方便。
新邮件能转发到别的地方吗,比如 Telegram?可以——收到的邮件可以转发到 Telegram 机器人,也可以转发到其他邮箱服务商的邮箱。
有方便自动化的 API 吗?有,开放 API 支持批量创建用户,还能按多种筛选条件查询邮件。
它怎么防止机器人批量注册账号?注册接入了 Cloudflare Turnstile 人机验证来防护。
有管理后台吗?有——管理员可以管理用户和邮件,并带有 RBAC 权限控制,可以按角色限制功能和资源用量。
网站外观可以自定义吗?可以——可以自定义网站标题、登录页背景和透明度,还有 ECharts 图表展示系统统计和邮箱增长情况。
Creator
maillab
Size
28.7 MB
Stars
14.7K
Age
1y
Commits · 90 Days