KaisouMail Docs#

Reading order#

1. Configure runtime and deploy tokens in Cloudflare Token Permissions.
2. Configure Worker, Pages, and runtime variables in Deployment & Environment.
3. Start with Domain onboarding overview to choose the right path.
4. If you want to onboard the domain manually in Cloudflare first, read Manually bind the domain in Cloudflare and enable it in KaisouMail.
5. If you want to bind a brand-new apex domain directly from /domains, read Bind a new domain directly from the project.
6. Use API Reference for endpoint discovery, then open /api-keys/docs inside the control plane for runtime-aware examples.

Documentation map#

• Quick Start
• Deployment & Environment
• Cloudflare Token Permissions
• Domain onboarding overview
• Manually bind the domain in Cloudflare and enable it in KaisouMail
• Bind a new domain directly from the project
• API Reference
• FAQ & Troubleshooting
• Open Storybook

Key points#

• cloudflareDomainLifecycleEnabled=true means the project can already manage zones that exist in Cloudflare.
• cloudflareDomainBindingEnabled=true is required before the project can create brand-new Cloudflare zones directly.
• A domain does not enter GET /api/meta or the random mailbox pool until it becomes active in /domains.