RustMailDocumentation

Install RustMail, catch email in dev, and assert on it in CI.

Quick Start

Start RustMail with Docker, Homebrew or a binary, point your app at localhost:1025 and open the inbox.

The GitHub Action, rustmail assert and REST assertions that fail the build when an email is wrong.

Live inbox, HTML preview at desktop or phone width, auth results, attachments and flagged links.

rustmail tui and the Neovim plugin: the same inbox and search without leaving the terminal.

CLI flags, RUSTMAIL_* environment variables and the TOML file, with their precedence.

Every REST endpoint for listing, reading, exporting, releasing and deleting captured emails.