Quick start

Requirements

• Rust stable (with wasm32-unknown-unknown) and worker-build 0.8.5
• Node.js 22+ (Wrangler)
• Cloudflare account (for production)
• An API key for your chosen provider (Brevo by default; see Plugins and Configuration)

Install and run

git clone https://github.com/InnoNestX/Custom-Mail.git
cd Custom-Mail
npm install
cp .dev.vars.example .dev.vars

Edit .dev.vars:

ADMIN_PASSWORD=your-strong-password
BREVO_API_KEY=your-brevo-key
# or MAIL_PROVIDER=resend and RESEND_API_KEY=...
# optional: MAIL_THEME=nord  MAIL_LAYOUT=compact  MAIL_LOGO=monogram
ALLOW_ANY_HOST=1

Start the local Worker:

npm run dev

Open http://localhost:8790 and sign in with ADMIN_PASSWORD. Then see Console for compose, preview, attachments, and history.

Other ways to run

Path	When to use
Docker	No Rust toolchain. docker run or Compose on port 8787.
OpenClaw skill	An agent starts the container: clawhub install custom-mail-skill.
Deploy	Production on Cloudflare Workers.

Pick plugins

Drop files under plugins/ (themes, layouts, logos, provider metadata) and set the active ids in config/mail.json. Unused sections stay hidden. Details: Plugins.

Docs site (optional)

cd docs-site
npm install
npm run docs:dev

Next

• Tune branding in Configuration
• Ship to production with Deploy