mailflare README

The project's README from github.com/hieunc229/mailflare. As one markdown file: README.md.

Mailflare

Mailflare

Mailflare is a self-hosted email inbox for custom domains, built on Cloudflare. Supports Resend, or AWS SES

Deploy to Cloudflare

Screenshots

Inbox
Inbox		 Manage domains
Manage domains		 Manage inboxes
Manage inboxes
Sequenzy Drivemug

Want to support the mailflare? Start sponsoring

What you can do

How it works

Mailflare runs in your Cloudflare account. By default, Cloudflare Email Routing delivers incoming mail to the app, and Cloudflare's email service sends outgoing mail. Each domain can also receive or send through Resend or Amazon SES. Cloudflare still manages the DNS.

Your mail stays in your own D1 database, and attachments stay in your own R2 bucket, whichever provider you use. See Sending and receiving providers.

Cost

You can set up Mailflare, receive mail, and send mail for free. Receiving with Cloudflare Email Routing is free. For sending, use the free tier of Resend or Amazon SES. Cloudflare's own email sending needs a paid Worker plan.

Send with Free tier After that
Resend 3,000 emails a month (100 a day), 3 domains From $20/month for 50,000 emails
Amazon SES $200 AWS credit for new accounts (about 2 million emails). The free plan lasts 6 months and credits expire after 12. $0.10 per 1,000 emails
Cloudflare Email Sending None Needs a Paid Worker plan ($5/month)

Receiving costs:

New SES accounts start in a sandbox that only delivers to verified addresses. Request production access in the AWS console to lift this.

You choose the provider per domain and can switch anytime (see Sending and receiving providers). Prices change, so check Resend, Amazon SES, and Cloudflare first.

Deploy

  1. Deploy the app. Click Deploy to Cloudflare. Keep the app name mailflare. Other Worker names will break the app.
  2. Finish setup. Open the deployed app and follow /setup to check the install and create your admin account.
  3. Connect a domain. Add a domain from the same Cloudflare account and choose which service receives its mail. Mailflare sets up Email Routing, or guides you through Resend or Amazon SES. Then create your first mailbox. Add Resend or AWS credentials on the domain page when you need them.

⚠️ CF_TOKEN is required during deployment. Create a scoped Cloudflare API token with these permissions for the domains you want to connect:

Deploy with an AI coding agent

Paste the prompt below into an agent with terminal access. Give it your Cloudflare account ID and two separate scoped API tokens through the agent's secret input. Never put them in a public chat, repository, or committed file.

Install Mailflare from https://github.com/hieunc229/mailflare in my Cloudflare account.
Ask me for my Cloudflare account ID, a scoped deployment API token, and a separate
runtime CF_TOKEN through a secret input. Never print, commit, or place either token
in a command argument or a tracked file. Use the deployment token only for Wrangler
authentication (CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID).

Read README.md, docs/deployment.md, and wrangler.jsonc first. Keep the Worker name
exactly mailflare. In the selected account, create or reuse the D1 database
mailflare, R2 bucket mailflare-raw, and Queues mailflare-inbound,
mailflare-outbound, and mailflare-agent. Set the D1 database_id in the local
Wrangler config without committing that account-specific ID. Install dependencies,
run npm run deploy, and set the runtime CF_TOKEN as a Worker secret. Do not run
remote D1 migrations manually; the /setup flow initializes the database.

Give me the deployed URL and any remaining Cloudflare account actions. I will
open /setup, create the first admin account, and connect my domain there.

See the deployment guide for permissions, manual deployment, backups, and updates.

Self-host with Docker

Mailflare also runs as one container on any server. It uses SQLite and local files instead of D1 and R2.

cp .env.docker.example .env.docker
docker compose up -d --build

See docs/self-hosting.md.

Local development

cp .dev.vars.example .dev.vars
npm install
npm run db:migrate:local
npm run dev

Add your Cloudflare credentials to .dev.vars, then open http://localhost:3000. To load sample data, run npm run db:seed while the dev server is running.

The Cloudflare app uses vinext and the Cloudflare Vite plugin, with local D1, R2, Queues, and Durable Objects. Remote bindings are off by default. To use Workers AI locally, log in with Wrangler, set CLOUDFLARE_ACCOUNT_ID, and run CLOUDFLARE_REMOTE_BINDINGS=true npm run dev.

The Node/Docker runtime still uses Next.js with build:node, start:node, and dev:node.

Documentation

License

See LICENSE.

mailflare (hieunc229/mailflare)

Searching Database…

5.1K ·GitHub
Mailflare
What is this?Mailflare is a self-hosted email inbox for custom domains, built on Cloudflare, with support for sending/receiving through Cloudflare, Resend, or Amazon SES.
Is this a Cloudflare Worker app or a Docker container I run on my own server?Both: it deploys as a Cloudflare Worker using D1 and R2, or it runs as a single Docker container on any server using SQLite and local files instead.
How do I deploy it?Click 'Deploy to Cloudflare' (keep the app name 'mailflare'), open the deployed app and follow /setup to create your admin account, then connect a domain and create your first mailbox.
What do I need from Cloudflare before deploying?You need a Cloudflare account with a domain, and a scoped CFTOKEN API token with Email Sending, DNS Settings, Email Routing Addresses, DNS, Email Routing Rules, and Zone Settings edit permissions.
Any catch with the Worker deployment name or sending costs?You must keep the deployed Worker named 'mailflare' or the app breaks, and sending mail through Cloudflare's own email service requires a paid Worker plan ($5/month) since there's no free tier for it.
Can I run it on a VPS instead of Cloudflare Workers?Yes, the Docker version runs as a single container on any server using SQLite and local files, with a built-in SMTP listener for inbound mail.
Where does my mail and attachments actually get stored?Your mail stays in your own Cloudflare D1 database and attachments stay in your own R2 bucket (or local SQLite/files in the Docker self-hosted version), regardless of which sending provider you use.
What's included besides email: does it have a calendar?Yes, Mailflare includes a calendar for scheduling recurring events with time zones and attendees, plus public booking pages so others can book free slots.
Can AI tools interact with my inbox?Yes, there's a built-in AI assistant to search mail, draft replies, and manage calendar events, plus MCP access so external AI clients can connect with scoped API key permissions.
How much does it actually cost to run?Receiving mail via Cloudflare Email Routing is free; sending is free using Resend's (3,000 emails/month) or Amazon SES's free tiers, while Cloudflare's own sending needs a $5/month paid Worker plan.
What admin controls are available?Admins can manage users, permissions, API keys, webhooks, audit logs, and backups, plus set routing rules to store, forward, reject, or sort incoming mail automatically.
What are similar projects?cloudflare_temp_email, nodewarden, mail2telegram, edgeever, ResolveHQ, DoulorCloud, open-compute, cloud-mail
Which topics is it in?cloudflare-r2, cloudflare-d1, smtp, self-hosted-ai, webhooks, cloudflare-workers, serverless, backup, email, cloudflare, agent-memory, nextjs
Creator
hieunc229
Size
68.7 MB
Stars
5.1K
Updated
CommitOct 16
Age
4mo
Commits · 90 Days