Send a transactional email through CamelMailer. Provide html_body and/or text_body. Queues one message per recipient and returns their ids.

Render a stored CamelMailer template (Mustache-style {{ variables }}) against template_model and send it. Fields set directly (e.g. subject) override the rendered ones.

List messages of the CamelMailer server, newest first. Filter by scope, status, tag, substring query or message stream.

Retrieve one message by id, including its SMTP delivery attempts.

List all stored message templates of the CamelMailer server.

Preview a stored template rendered against a variable model — returns the rendered subject, html_body and text_body without sending anything.

Message counters of the server (sent, pending, bounced, opens, clicks, …), optionally limited to a created_at time window.

List bounced messages, filtered and paginated.

DMARC compliance summary over the stored aggregate reports: pass rate, top sending sources and disposition totals.

List the message streams of the server. A stream is transactional or broadcast; broadcast streams are the ones campaigns and subscribers belong to.

Retrieve one message stream by permalink.

Create a message stream. Set permalink explicitly when you need to know it up front; the API derives one from the name otherwise.

Update a message stream. Only the given fields change.

Archive a message stream. Archived streams reject new messages.

SENDS MAIL IMMEDIATELY to every subscriber of a broadcast stream. Give either a subject with a body, or a template permalink. Recipients past the per-request cap of 1000 come back as skipped, so a larger audience wants a campaign.

List broadcast campaigns, newest first. Pass stream to narrow to one broadcast stream.

Retrieve one campaign with its statistics: total, sent, delivered, failed, opened, clicked and unsubscribed.

Write a campaign WITHOUT sending it. Leave scheduled_at unset and the campaign stays a draft; set it and the server sends when due. This is the tool to use when a campaign should be reviewed first — use send_campaign_now only when it should go out immediately.

CREATES A CAMPAIGN AND SENDS IT IMMEDIATELY to every subscriber of the stream. There is no draft to review and no schedule; the send starts before this returns. Use create_campaign_draft unless the mail really should go out now.

Edit a draft or scheduled campaign. Set scheduled_at to schedule it, or clear_schedule to drop it back to a draft. Touching neither leaves the schedule standing. A campaign that is already sending cannot be edited.

SENDS AN EXISTING CAMPAIGN NOW, whatever its schedule said. The send starts immediately and cannot be undone for messages already queued.

Cancel a scheduled or in-flight campaign. Messages already queued are not recalled.

List a broadcast stream's subscribers, subscribed and unsubscribed alike. A broadcast send to an address that is not subscribed is refused, so this list is the audience.

Add or update one subscriber of a broadcast stream. Upserts by address, so calling it twice is safe.

Add many addresses to a broadcast stream at once, all as subscribed. Blanks and duplicates within the request are skipped, so the reported count can be lower than the number of addresses passed.

Record a spam complaint against an address: writes a stream-scoped suppression and flips the subscription to unsubscribed. Idempotent, so a feedback loop can replay it safely.

Remove a subscriber from a broadcast stream entirely. To stop mailing someone while keeping the record, set their status to unsubscribed with add_subscriber instead.

List the template layouts of the server. A layout wraps every template that uses it, so header, footer and styling live in one place.

Retrieve one layout by permalink, including its wrappers.

Create a template layout. html_wrapper has to embed the body with {{{ content }}}; anything else is refused with ValidationError.

Update a layout. Only the given fields change.

Delete a layout. Templates that referenced it fall back to no wrapper.

List inbound and held messages, newest first. Covers mail arriving through an inbound route as well as outbound mail the spam filter put on hold.

Retrieve one inbound or held message by id.

Put an inbound message back on the delivery queue, for instance after fixing the route it should have matched.

RELEASE A HELD MESSAGE past the hold and deliver it. The hold is what the spam filter put there, so check the message before releasing it.

List the server's own logged API requests, newest first. Useful when a send did not arrive and the question is whether the request ever reached the API, and with what answer.

Tags used by the server's recent messages, most used first — the vocabulary available to the tag filter of list_emails.