Mimeo documentation

Mimeo is email automation you own: self-hosted, single-tenant software. One install, one customer — yours. These docs cover both halves of how you run it: the web UI you click through, and the API your coding agent talks to.

A note on names: when these docs say Mimeo, they mean your Mimeo — your own instance of the app, holding only your data. It runs on your own server, on the domain you choose.

New here? Start with Getting started — download the software, set up sending, and prepare your first audience. Then How it fits together is the five-minute map of the pieces, and the glossary has every term. Prices, what the license includes and what you need to run it are on the Pricing page. What changed in each release is in the changelog and the release notes.

Browse the docs

• Getting startedDownload Mimeo and Mimeo Manager from your account, connect sending and media, and test your setup.
• Deploy MimeoRun the Rails app on your server with Hatchbox and DigitalOcean, or use another Rails host.
• Migrating from another email platformPreserve suppressions, move engaged cohorts first, and transition over three newsletters without duplicate sends.
• UsageWorking in the app: people, CSV import, authoring emails, and connecting a sending provider.
• APIThe HTTP interface your agent and your app use: events, people, flows, emails, sequences, broadcasts and the manager repo's definition files.
• MCP serverA native tool surface for coding agents, running on your Mimeo. Add it to Claude Code with one command.
• Let an AI agent run your email without accidental sendsPrompts for your agent, rehearsals, guards and test sends, with real screens from a local install.
• Move from Mailchimp or Kit without emailing people who opted outImport your opt-outs first, then your list, with nothing triggered, tested on a local install.
• Manager repoYour whole operation as files in a git repo you own — pulled, edited and pushed back by the bundled CLI, never by git.

How Mimeo is put together

Your Mimeo instance owns the data and the logic — people, custom fields, tags, events, money history, emails, templates, tracking, and the send log all live in your own database. A pluggable sending provider handles delivery to the inbox. The Sending & domains section starts with Set up sending: connect Resend, the simplest starting point, or Postmark, then put the links inside every message on your own connected sending domain.

Everything that enters Mimeo from outside — a signup, a purchase, a renewal, an opt-in — arrives as an event. That one endpoint upserts the person, records first-touch attribution, appends to their timeline, and writes the money tables. If you learn one thing about the API, learn the event contract.

What Mimeo includes

Mimeo includes people management and GDPR tooling, CSV import, custom fields and tags, the email library and editor with templates and previews, open and click tracking, the event API, and the subscription-management API — plus the whole automation engine: sequences, flows with dry runs and versions, the scheduled queue, guards, send windows, and the flow API.

And the daily-driver console: segments with watchdogs, broadcasts, reporting across emails, sequences, flows and broadcasts, the activity feed and event registry, the dashboard, and keyboard-first navigation.

The agent surface is here too: the CLI and a manager repo for anything you want reviewed as a diff, the MCP server for questions and one-off changes, the manager repo that carries both, and the reference section — the flow schema, the event contract, the repo layout and how to write your own sending adapter — written so an agent can operate a Mimeo from the docs alone.