Skip to content

Email for professionals and teams

Update readme

Hieu Nguyen (Jack)411e9faebc0f
diff --git a/README.md b/README.md
index 9c2064a..1fadcd5 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,13 @@
-# Email Platform
+# Mailflare
-[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/hieunc229/mailflare)
+A self-hosted, AI-powered email inbox with custom domains, powered by Cloudflare
-TypeScript email service on **Cloudflare Workers** (OpenNext + Next.js), **Drizzle/D1**, and **Cloudflare Email Service**.
+[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/hieunc229/mailflare)
-## Model
+![](/screenshot.png)
-- **No organizations** — one user account owns domains, mailboxes, and API keys.
-- **First visit:** register → **onboarding** (add domain + first mailbox) → inbox.
-- **Domains:** added via **Cloudflare API** (zone must exist on your account).
-### Features
+### Roadmap
- [x] Domain onboarding through Cloudflare, including inbound Email Routing DNS and sending DNS setup.
- [x] Domain removal cleanup for linked Cloudflare routing rules and sending subdomain resources.
@@ -19,12 +16,22 @@ TypeScript email service on **Cloudflare Workers** (OpenNext + Next.js), **Drizz
- [x] Inbox, sent, drafts, spam, and trash folders backed by a shared mail list component.
- [x] Popup composer with autosaved drafts and draft resume from the drafts folder.
- [x] Outbound send API, API keys, message read status, spam/trash moves, and seeded demo data.
-- [] Advanced routing rules for catch-all addresses, forwarding, reject/block rules, and priorities.
-- [] Webhook management UI and delivery retry visibility.
-- [] Search, filtering, and richer mailbox/folder counts.
-- [] Attachment support and richer compose formatting.
+- [x] Search, filtering, and richer mailbox/folder counts.
+- [ ] Advanced routing rules for catch-all addresses, forwarding, reject/block rules, and priorities.
+- [ ] Webhook management UI and delivery retry visibility.
+- [ ] Attachment support and richer compose formatting.
+
+#### Email agent
+
+- [ ] Message intelligence with summaries, intent classification, urgency scoring, and extracted entities.
+- [ ] Agent task queue for proposed replies, follow-ups, triage actions, and missing-information requests.
+- [ ] Human-approved actions for draft replies, folder moves, forwarding, contact creation, and webhook calls.
+- [ ] Agent rules for learned post-receipt policies such as prioritization, auto-triage, and reply templates.
+- [ ] Agent inbox view organized by action state, including needs reply, waiting on me, waiting on them, FYI, auto-handled, and needs approval.
+- [ ] Thread and contact memory for prior summaries, user preferences, relationship notes, commitments, and open loops.
+- [ ] Tool execution for trusted actions such as sending email, creating drafts, updating message status, calling webhooks, and creating contacts.
-## Domain API (yes, programmatic)
+## Domain API
Domains are **not** dashboard-only. This app calls Cloudflare when you add/remove a domain:
@@ -67,6 +74,9 @@ curl -X POST http://localhost:3000/api/seed
### One-click Cloudflare deploy
+
+[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/hieunc229/mailflare)
+
Publish this repository to GitHub, then replace `hieunc229/mailflare` in the button at the top of this README with the public repository path.
The deploy flow reads `wrangler.jsonc`, provisions the Worker bindings, prompts for values from `.dev.vars.example`, runs D1 migrations, builds the OpenNext Worker, and deploys it.
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 0000000..fbc4a58
Binary files /dev/null and b/screenshot.png differ