mimux documentation

mimux is a fast, keyboard-driven email client you run yourself. Point it at the mailboxes you already have and read, search, triage and send from one unified inbox — in the browser or as an installed app on your phone. Your mail, your credentials, your machine.

One docker compose up. One SQLite file holds everything. Under the hood it is a single Go binary serving htmx + Alpine.js + Tailwind, talking IMAP and SMTP.

docker compose up
# then open http://localhost:8083

There is no configuration to write. The first visit walks you through creating your admin account; everything after that is edited in Settings and stored in the database.

Where to go

• How mimux worksThe model: one binary, one file, the mailboxes you already have. What mimux is and what it is not.
• ArchitectureSync, storage, threading, search, filters, and the build-tag split between the free client and the pro layer.
• InstallationDocker Compose, prebuilt binaries, environment variables, OAuth, HTTPS, upgrading, backup.
• Web UI, PWA, notificationsKeyboard shortcuts, installing mimux as an app, Web Push and ntfy.
• Command lineEvery subcommand the binary has — which is fewer than you would expect, on purpose.
• The automation layerAPI tokens, scopes, rate limits, the licence key and the trial. Start here before the API.
• REST API guideAuth, envelopes, pagination, idempotency and the common flows, in prose.
• API referenceThe generated OpenAPI reference: every endpoint, every field, request samples in six languages.
• MCP serverConnect an agent over streamable HTTP or the stdio bridge. Nine tools, gated by scope.
• WebhooksSigned deliveries, the retry ladder, auto-disable, and the delivery log with replay.

Free and paid, in one paragraph

The mail client is free, AGPL-3.0, and complete — forever. Multi-account unified inbox, sync, threading, search, compose, filters, keyboard shortcuts, PWA, push. Nothing in it is held back, time-limited or behind a licence key.

The paid layer is automation only. A REST API, an MCP server for AI agents, and webhooks. The rule: if a human drives mimux, that is free; if something else drives it, that is mimux pro. AI compose is human-driven, so it stays free. The full mapping of directory to licence is in LICENSING.md.

Getting help

Support is GitHub issues, best effort, from one person with a day job. Bug reports, questions and suggestions are the most useful thing you can send — start with make diagnose, which prints a sanitised environment dump to paste into the report. See CONTRIBUTING.md, and SECURITY.md for anything that should not be filed in public.