Zmail Documentation

This folder is the source of truth for Zmail product, API, CLI, webhooks, and operations.

Docs Index

• [Product Guide](./product.md)
• [API Reference](./api-reference.md)
• [Webhooks Guide](./webhooks.md)
• [CLI Guide](./cli.md)
• [Deployment and Operations](./deployment-operations.md)
• [Documentation Maintenance](./maintenance.md)

Audience Map

• Product and UX context: product.md
• Integrators and agent builders: api-reference.md, webhooks.md
• CLI users and operators: cli.md
• Infra and reliability owners: deployment-operations.md
• Maintainers and release owners: maintenance.md

Scope

Zmail includes:

• Public marketing and product app (/, /app, /login)
• Admin control plane (/admin/*, /admin/login)
• API-key server APIs (/mailboxes, /inbox, /messages/*, /send)
• Session-based product APIs (/app/api/*) used by web and cli/zmail
• SMTP inbound and direct SMTP outbound
• Multi-tenant workspaces, mailbox isolation, and event webhooks

Versioning Policy

Docs in this folder track main and must reflect deployed behavior. When code changes behavior, docs must be updated in the same PR/commit.