Camelmailer from your terminal — send and inspect transactional email. Works with the Camelmailer cloud and any self-hosted instance.
npm install -g @camelmailer/clicamelmailer login # stores the key in ~/.config/camelmailer/config.json (600)
camelmailer ping # validate the key
camelmailer emails send \
--from billing@acme.com \
--to ada@example.com \
--subject "Your receipt" \
--html "<p>Thanks for your purchase.</p>"Credentials resolve as flags → environment → config file:
export CAMELMAILER_API_KEY=cm_xxxx
export CAMELMAILER_BASE_URL=https://mail.example.com # self-hosted; defaults to the cloud
# or per invocation:
camelmailer --api-key cm_xxxx --base-url https://mail.example.com ping# direct body
camelmailer emails send --from billing@acme.com --to ada@example.com \
--subject Hi --text "Hello!" --tag welcome --stream broadcasts
# stored template + variables
camelmailer emails send --from billing@acme.com --to ada@example.com \
--template welcome --model '{"name":"Ada"}'--to, --cc, --bcc and --reply-to accept multiple addresses.
--idempotency-key makes a send replayable: the same key with the same body
returns the first result instead of sending twice, and a different body under
the same key is refused with InvalidIdempotentRequest.
camelmailer emails send --from billing@acme.com --to ada@example.com \
--text "Your receipt" --idempotency-key "order-4711"camelmailer emails send-to-stream newsletter \
--from news@acme.com --subject September --text "What shipped this month."Recipients past the per-request cap of 1000 come back as skipped, so a larger audience wants a campaign.
camelmailer emails list --scope outgoing --status HardFail --page 2
camelmailer emails list --tag receipt --query ada
camelmailer emails get 42camelmailer templates list
camelmailer templates get welcome
camelmailer templates render welcome --model '{"name":"Ada"}' # preview, no sendA campaign is content plus an audience. The two ways to create one behave
differently, so pick deliberately: create writes it and waits, send-now
expands it to the stream's subscribers before the command returns.
# Write it and leave it alone. Without --scheduled-at it stays a draft.
camelmailer campaigns create --stream newsletter --from news@acme.com \
--name September --subject "What shipped" --text "Hello."
# Goes out on the spot, no draft and no schedule.
camelmailer campaigns send-now newsletter --name "Status update" \
--from news@acme.com --text "All clear."
camelmailer campaigns list
camelmailer campaigns list --stream newsletter
camelmailer campaigns get 7 # with statistics
camelmailer campaigns update 7 --scheduled-at 2026-10-01T08:00:00Z
camelmailer campaigns update 7 --clear-schedule # back to a draft
camelmailer campaigns send 7 # now, whatever the schedule said
camelmailer campaigns cancel 7A broadcast send to an address that is not subscribed is refused, so this list is the audience.
camelmailer subscribers list newsletter
camelmailer subscribers add newsletter ada@example.com
camelmailer subscribers import newsletter ada@example.com grace@example.com
camelmailer subscribers complaint newsletter ada@example.com # suppress + unsubscribe
camelmailer subscribers remove newsletter ada@example.comcamelmailer streams list
camelmailer streams create --name Broadcasts --permalink broadcasts --stream-type broadcast
camelmailer streams get broadcasts
camelmailer streams update broadcasts --name Newsletter
camelmailer streams archive broadcasts
camelmailer layouts list
camelmailer layouts create --name Default --permalink default \
--html '<html><body>{{{ content }}}</body></html>'
camelmailer layouts upload-logo default ./logo.png # prints the URL to reference
camelmailer layouts delete defaultcamelmailer inbound list --status held
camelmailer inbound retry 55 # back on the delivery queue
camelmailer inbound bypass 55 # release past the hold
camelmailer logs list --status 4xx
camelmailer logs tagscamelmailer stats --from 2026-07-01 --to 2026-07-11
camelmailer bounces list
camelmailer dmarc summary --domain acme.com
camelmailer pingEvery command prints a compact table by default; add --json for the raw API payload — ideal for piping into jq:
camelmailer --json emails list --status HardFail | jq '.messages[].rcpt_to'Failures print Error [Code]: message to stderr and exit non-zero. Codes are the stable Camelmailer API codes (Unauthorized, NotFound, ValidationError, …) plus CLI-local ones (MissingApiKey, MissingBody, InvalidJson).
camelmailer emails get 999999 || echo "exit $?"
# Error [NotFound]: no such message
# exit 1Full API reference: camelmailer.com/docs · SDK: camelmailer-node