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…

Что это?Mailflare — это self-hosted почтовый ящик для собственных доменов, построенный на Cloudflare, с поддержкой отправки/получения через Cloudflare, Resend или Amazon SES.
Это приложение Cloudflare Worker или Docker-контейнер для запуска на своём сервере?И то и другое: разворачивается как Cloudflare Worker с использованием D1 и R2 или работает единым Docker-контейнером на любом сервере, где вместо них используются SQLite и локальные файлы.
Как его развернуть?Нажмите 'Deploy to Cloudflare' (сохраните имя приложения 'mailflare'), откройте развёрнутое приложение и пройдите /setup, чтобы создать аккаунт администратора, затем подключите домен и создайте первый почтовый ящик.
Что мне нужно от Cloudflare перед развёртыванием?Нужен аккаунт Cloudflare с доменом и API-токен CFTOKEN с ограниченными правами на редактирование Email Sending, DNS Settings, Email Routing Addresses, DNS, Email Routing Rules и Zone Settings.
Есть ли подвох с именем деплоя Worker или со стоимостью отправки?Развёрнутый Worker должен называться 'mailflare', иначе приложение ломается, а отправка почты через собственный почтовый сервис Cloudflare требует платного плана Worker ($5/месяц), так как бесплатного тарифа для него нет.
Можно ли запустить его на VPS вместо Cloudflare Workers?Да, Docker-версия работает единым контейнером на любом сервере, используя SQLite и локальные файлы, со встроенным SMTP-слушателем для входящей почты.
Где на самом деле хранятся моя почта и вложения?Ваша почта остаётся в вашей собственной базе Cloudflare D1, а вложения — в вашем собственном бакете R2 (или в локальных SQLite/файлах в self-hosted Docker-версии) независимо от того, каким провайдером отправки вы пользуетесь.
Что входит, кроме почты: есть ли календарь?Да, в Mailflare есть календарь для планирования повторяющихся событий с часовыми поясами и участниками, плюс публичные страницы бронирования, чтобы другие могли занимать свободные слоты.
Могут ли ИИ-инструменты взаимодействовать с моим ящиком?Да, есть встроенный ИИ-ассистент для поиска по почте, черновиков ответов и управления событиями календаря, плюс доступ через MCP, чтобы внешние ИИ-клиенты могли подключаться с ограниченными правами API-ключа.
Сколько на деле стоит его использование?Получение почты через Cloudflare Email Routing бесплатно; отправка бесплатна на бесплатных тарифах Resend (3 000 писем/месяц) или Amazon SES, а собственная отправка Cloudflare требует платного плана Worker за $5/месяц.
Какие админ-возможности доступны?Администраторы могут управлять пользователями, правами, API-ключами, вебхуками, журналами аудита и резервными копиями, а также задавать правила маршрутизации, чтобы автоматически сохранять, пересылать, отклонять или сортировать входящую почту.
Creator
hieunc229
Size
68.8 MB
Stars
5.1K
Updated
CommitOct 18
Age
4mo
Commits · 90 Days