my-email-api

MyEmailAPI

Account-scoped email infrastructure tied to your registered domains. Mailboxes belong to domains; sending and receiving work without per-org plumbing. Templates are org-scoped.

Capabilities

<!-- llm:start -->

Email is built around mailboxes. Each mailbox lives on a registered domain (e.g. [email protected]) and must be activated for sending before transactional sends work — newly-created mailboxes can receive but not send.

Templates are AI-generated HTML emails (org-scoped). Warmup is a separate flow that gradually ramps a mailbox's send rate to build inbox reputation before high-volume sending.

A registered domain via mydomainapi is the prerequisite — mailboxes need a domain to live on.

<!-- llm:end -->

Commands

<!-- generated:start -->

Namespace	Subcommands	Purpose
email mailbox	create, list, activate-sending	Create and manage mailboxes
email message	send, status, sent, inbox, outbox, get	Transactional send + read
email warmup	start, stats, pause, resume, stop	IP/domain warmup for sending reputation
email template	generate, list, get, preview, edit, send-test, delete	AI-generated HTML templates

<!-- generated:end -->

Examples

<!-- llm:start -->

# 1. Create a mailbox + activate sending
myapi email mailbox create [email protected] --display-name "Hello"
myapi email mailbox activate-sending --address [email protected]

# 2. Send a transactional email
myapi email message send \
  --from [email protected] --to [email protected] \
  --subject "Hi" --body "Test message"

# 3. Read inbox / outbox
myapi email message inbox  [email protected]
myapi email message outbox [email protected]

# 4. Generate + use a template
myapi email template generate welcome-v1 \
  --prompt "A welcome email with our brand colors and a CTA to /onboarding"
myapi email template list
myapi email template preview <id>            # public preview URL — share with stakeholders
myapi email template send-test <id> --to [email protected]
myapi email template edit <id> --prompt "Make the CTA larger and red"

# 5. Warm up before a big send
myapi email warmup start --address [email protected]
myapi email warmup stats --address [email protected]

<!-- llm:end -->

Notes

• A mailbox is uniquely identified by its address (username@domain).
• Sending is opt-in per mailbox. Newly-created mailboxes can receive but not send until activate-sending runs.
• 402 — INSUFFICIENT_FUNDS: top up or enable myapi billing auto-recharge. SPEND_CAP_EXCEEDED: raise your own ceiling with myapi billing spend-cap.
• Templates are org-scoped. Set a default org once: myapi config set-org <id>.

Which name mail actually lives on

Two things that read as contradictory and are not:

• Mailbox addresses are on the APEX — [email protected], never [email protected]. mail.<domain> is the sending identity that myapi domain email-setup provisions, not a mailbox namespace. Creating a mailbox on the subdomain fails with DOMAIN_NOT_OWNED.
• Registration and assign put MX, SPF and DMARC on the apex whether or not you run email-setup. So "apex is never touched" — which describes email-setup specifically — is not true of the domain as a whole. If you plan to run Google Workspace or another provider on the apex, check the existing records first with myapi domain records <domain>.

HTTP (from deployed code)

<!-- http:start --> <!-- generated by `npm run canonical-sync` — do not edit -->

base   https://api.myemailapi.com
path   POST /email/send
auth   Authorization: Bearer <key>   (fn: env.__MYAPI_KEY · container: env.MYAPI_KEY)
reply  { "success": true, "data": …, "error": null, "meta": {…} }

• Per-slot host — do not assume one host serves every slot.
• Account-scoped, not org-scoped — no {org_id} segment; the key identifies the account.

<!-- http:end -->

Run myapi email --help or myapi email <namespace> --help for full flag reference.