⚡ Ferroma
中文

Ferroma Documentation

A from-scratch, Rust-native self-hosted mail platform with a cross-platform official client.

Documents

  • Architecture — Crate graph, layering rule, request lifecycle, event bus
  • HTTP API — Management API, Client API (FCP), endpoints, error envelope
  • Client Protocol (FCP) — Sync cursor, realtime events, chunked uploads
  • SMTP — Inbound, submission, outbound delivery, reply codes
  • IMAP — Commands, UIDs, flags, Maildir++ mapping, compatibility
  • Storage — PostgreSQL schema, Maildir, attachments, backup
  • Synchronisation — change_log, tombstones, conflict resolution
  • Security — Threat model, password hashing, TLS, limits
  • Deployment — Docker Compose, DNS, TLS, Let's Encrypt
  • Official Client — Shared core, SQLite cache, Outbox, sync engine

Quick links