Skip to content
Get packs

Guide · Open source

How to use cloud-mail: deploy your own email on Cloudflare

Updated · written with AI from the project's own documentation and checked against our catalogue data

Cloud Mail (maillab/cloud-mail) is a web-based email platform that runs on Cloudflare Workers. With one domain, you can create several mailboxes, similar to large email providers, without running a traditional mail server. This guide explains what you need before you start, how to get the code, what the project contains, and where it fits compared with other options.

Cloud Mailmaillab/cloud-mail · ★ 15.3k · MIT

Quick start

  1. 1Check prerequisites. Confirm you have a Cloudflare account, Node.js installed, and a domain you control.
  2. 2Clone the repository. Run the git clone command to download maillab/cloud-mail to your machine.
  3. 3Review the configuration. Open wrangler.toml in mail-worker and env.release in mail-vue to see what needs to match your Cloudflare resources.
  4. 4Follow the deployment docs. Use the deployment documentation at docs.skymail.ink for the full build and deploy steps, which the README excerpt does not include.
  5. 5Set up Cloudflare services. Prepare the D1 database, KV cache and R2 storage that the project uses, as described in the deployment documentation.
  6. 6Create mailboxes. After deployment, use the web interface to create mailboxes on your domain, or use the open API for bulk user creation.

What you need before you start

cloud-mail is self-deployed, so you need your own setup. The project's README lists a Cloudflare account and Node.js as prerequisites. The README excerpt does not state which Node.js version is required, so check the project's deployment documentation for that.

The project uses several Cloudflare services: Workers for the backend, D1 for the database, KV for caching, and R2 for attachment storage. You should be comfortable with Cloudflare accounts and configuration before you begin.

  • A Cloudflare account
  • Node.js (version not stated in the README excerpt)
  • A domain you control, since the service creates mailboxes on one domain
  • Familiarity with Cloudflare Workers, D1, KV and R2 helps

Get the cloud-mail code

The first step in the README is to clone the repository. Cloning downloads the source code to your computer so you can build and deploy it.

git clone https://github.com/maillab/cloud-mail

Understand the project structure

The repository is split into two projects. mail-worker is the backend that runs on Cloudflare Workers. mail-vue is the Vue front end with the web interface. Configuration for the backend lives in wrangler.toml, and dependencies are listed in package.json in each project.

The front end includes an env.release file for project configuration. Check these files before you deploy so the settings match your Cloudflare resources.

  • mail-worker: backend, with src/api, src/dao, src/email, src/service and src/index.js as the entry file
  • mail-vue: front end, with src/views, src/router, src/request and src/main.js
  • wrangler.toml: backend project configuration
  • env.release: front-end project configuration

Know the features you can use

The README lists features including sending email through Cloudflare Email or Resend (with group sending), attachment handling stored in R2, forwarding received mail to a Telegram bot or another mailbox, and an open API for batch user creation and filtered email queries.

Other listed features include automatic verification code recognition using Workers AI, admin controls with role-based permissions, Turnstile human verification for sign-ups, and customizable site title and login background. The README also notes that more features are in development.

  • Create multiple mailboxes on one domain
  • Send mail via Cloudflare Email or Resend, including group sending
  • Store and download attachments using R2
  • Forward incoming mail to a Telegram bot or another mailbox
  • Batch-create users and query email through the open API
  • Recognize verification codes with Workers AI
  • Use Turnstile to limit bulk registration

Where to find deployment details

The README links to a deployment documentation site at docs.skymail.ink, a live demo, and a Telegram group for discussion. The README excerpt you have does not include the full deployment steps, so use the documentation for those. The project is licensed under MIT.

What people use it for

  • Running a personal email service on a domain you own
  • Giving a small team separate mailboxes on one domain
  • Batch-creating users through the API for a project or community
  • Forwarding incoming mail to a Telegram bot for alerts
  • Using Workers AI to extract verification codes from incoming mail

Frequently asked questions

Is cloud-mail free to use?

cloud-mail is released under the MIT licence, which the README names. The project itself is open source. Your costs depend on your Cloudflare usage, and the README does not give pricing, so check Cloudflare's pricing for the services you use.

What do I need to install cloud-mail?

The README lists a Cloudflare account and Node.js as prerequisites. The install method is cloning the repository and building it. The README excerpt does not state a Node.js version, so check the deployment docs.

How do I install cloud-mail?

Start by running git clone https://github.com/maillab/cloud-mail. The full build and deployment steps are in the documentation at docs.skymail.ink, which the README links to.

Is cloud-mail better than Cloudflare Email Routing?

The sources do not include a comparison. Cloud Mail is a web-based platform with mailboxes, an API and a web interface that you self-deploy. Cloudflare Email Routing is a Cloudflare service. Pick based on whether you need a full mailbox interface, which cloud-mail provides.

What are alternatives to cloud-mail?

The project lists Cloudflare Email Routing, Mailu and Postal as comparable projects. Mailu and Postal are self-hosted mail systems, while Cloudflare Email Routing is a Cloudflare service. The README does not compare them in detail.

Can cloud-mail guarantee email delivery?

No. The README does not discuss deliverability, so do not assume delivery is guaranteed. Test your setup with real mail before you rely on it.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

cloud-mail suits people who want their own multi-mailbox email service on a domain they control, especially if they already use Cloudflare Workers, D1, KV or R2. It is a poor fit if you want a managed service with no setup, need guaranteed deliverability, or are not comfortable with Cloudflare configuration.

Install options & downloads