# OxiMail

## Docs

- [Architecture at a glance](https://docs.oximail.ch/architecture.md): How OxiMail fits into one Rust binary: processes, crate layers, request paths, and the storage model.
- [Architecture reference](https://docs.oximail.ch/architecture/overview.md): A detailed reference to OxiMail's internal architecture and crate boundaries.
- [oximail-core](https://docs.oximail.ch/architecture/oximail-core.md): The JMAP Core foundation crate: session, method dispatch, capabilities, push, blob plumbing, errors, and the cross-domain EventBus.
- [oximail-mail](https://docs.oximail.ch/architecture/oximail-mail.md): The JMAP Mail domain crate: Mailbox, Email, Thread, EmailSubmission, Identity and VacationResponse, the ingestion path, and the column-projection read path.
- [oximail-smtp](https://docs.oximail.ch/architecture/oximail-smtp.md): The SMTP layer: separate inbound (port 25) and authenticated submission (port 587) code paths, the inbound auth + spam pipeline, the outbound delivery queue, DSN generation, and the backup-MX path.
- [oximail-store](https://docs.oximail.ch/architecture/oximail-store.md): The storage core: the SqlBackend trait over a pooled SQLite database, versioned auto-applied migrations, the Tantivy full-text index, and the content-addressed filesystem blob store.
- [Core concepts](https://docs.oximail.ch/concepts.md): A short glossary of the ideas the rest of the manual builds on: organizations, accounts, IDs, blobs, capabilities, and fail-loud.
- [Admin REST API](https://docs.oximail.ch/developer/admin-api.md): The administrative REST endpoints for bans, overrides, and provisioning.
- [Calendar](https://docs.oximail.ch/developer/jmap-calendar.md): The JMAP Calendar methods for events, calendars, and scheduling.
- [Chat](https://docs.oximail.ch/developer/jmap-chat.md): The chat-over-JMAP methods and the WebSocket transport.
- [Contacts](https://docs.oximail.ch/developer/jmap-contacts.md): The JMAP Contacts methods for address books and contact cards.
- [JMAP Core](https://docs.oximail.ch/developer/jmap-core.md): The RFC 8620 Core surface as OxiMail implements it: the session resource, authentication, batched requests, back-references, capabilities, and push.
- [Files](https://docs.oximail.ch/developer/jmap-files.md): The JMAP File Storage methods for files and directory nodes.
- [Mail](https://docs.oximail.ch/developer/jmap-mail.md): The JMAP Mail methods for working with emails, mailboxes, and threads.
- [Sharing](https://docs.oximail.ch/developer/jmap-sharing.md): The JMAP Sharing methods for granting access across accounts.
- [Tasks](https://docs.oximail.ch/developer/jmap-tasks.md): The JMAP Tasks methods for task lists and to-do items.
- [JMAP v2 modernized](https://docs.oximail.ch/developer/jmap-v2.md): OxiMail's modernized JMAP v2 surface and how it differs from the v1 methods.
- [First boot & setup wizard](https://docs.oximail.ch/first-boot.md): Run the oximail setup wizard to provision the first organization, admin account, DKIM key, config file, and systemd service, then verify the server is up.
- [Introduction](https://docs.oximail.ch/index.md): OxiMail is a JMAP-first mail and collaboration server: one Rust binary for mail, calendar, contacts, tasks, files, and chat.
- [Installation](https://docs.oximail.ch/installation.md): Install OxiMail on a fresh Debian 13 host: requirements, ports, building the binary, and running it under systemd.
- [Anti-spam & anti-abuse](https://docs.oximail.ch/operator/anti-spam.md): The spam pipeline, rate limiting, and the built-in fail2ban replacement.
- [CLI reference](https://docs.oximail.ch/operator/cli.md): Every OxiMail command-line subcommand and its arguments.
- [Configuration reference](https://docs.oximail.ch/operator/configuration.md): How OxiMail configuration works: a TOML file as the boot baseline, with optional database overrides for runtime tuning, and where each setting must live.
- [Email authentication & security](https://docs.oximail.ch/operator/email-auth-security.md): Setting up DKIM, SPF, DMARC, ARC, MTA-STS, and DANE for your domains.
- [Encryption at rest](https://docs.oximail.ch/operator/encryption-at-rest.md): How OxiMail encrypts stored mail with its LUKS-style key hierarchy.
- [Groupware](https://docs.oximail.ch/operator/groupware.md): Operating calendars, contacts, tasks, files, and sharing across accounts.
- [Legacy protocols & clients](https://docs.oximail.ch/operator/legacy-protocols.md): Enabling IMAP, CalDAV, and CardDAV access for traditional mail clients.
- [Mail & SMTP](https://docs.oximail.ch/operator/mail-and-smtp.md): Configuring inbound and submission SMTP, queues, and outbound delivery.
- [Mailboxes & storage](https://docs.oximail.ch/operator/mailboxes-storage.md): How mailboxes, blobs, and the SQLite backend store mail on disk.
- [Migration](https://docs.oximail.ch/operator/migration.md): Migrating mail and accounts from an existing server into OxiMail.
- [Multi-tenancy & provisioning](https://docs.oximail.ch/operator/multi-tenancy.md): Isolating organizations and provisioning domains, accounts, and quotas.
- [Operations](https://docs.oximail.ch/operator/operations.md): Day-to-day operations: logs, backups, monitoring, and upgrades.
- [Sieve & Rules](https://docs.oximail.ch/operator/sieve-rules.md): Writing and managing Sieve scripts for server-side mail filtering.
- [TLS & ACME](https://docs.oximail.ch/operator/tls-acme.md): Configuring TLS certificates and automatic renewal through ACME.
- [ADR index](https://docs.oximail.ch/reference/adr-index.md): An index of the Architecture Decision Records that shape OxiMail.
- [Changelog](https://docs.oximail.ch/reference/changelog.md): A summary of notable changes across OxiMail releases.
- [Glossary](https://docs.oximail.ch/reference/glossary.md): Definitions of the terms used throughout the OxiMail documentation.
- [IETF drafts](https://docs.oximail.ch/reference/ietf-drafts.md): The IETF drafts OxiMail authors and tracks for JMAP standardization.
- [RFC compliance matrix](https://docs.oximail.ch/reference/rfc-compliance.md): Which RFCs OxiMail implements and how completely each one is covered.