Newsletter campaigns (add-on)

Every campaign, newest first, with its status, the list it goes to, its counters and its open and click rates. The status counts come back for the whole table rather than for the page, so "four drafts" means four in the store. Filter by status to answer questions like "what is scheduled" or "what stopped itself".

One campaign with everything above its tables: the subject, the preheader, the Markdown body, the layout, the list, the sender overrides, the coupon, whether opens and clicks are counted, every counter, the open and click rates, and a breakdown of its recipients by what happened to each of them. On a campaign testing two subjects it also answers the test: both subjects, how big the sample is, when the winner is picked, which one won and when, and each letter's own sent, opened and clicked counts — always the sample's, never the whole campaign's. Also answers which moves the state machine will accept from here, so a caller knows whether it can be started, paused or edited before it tries.

How many people a campaign to these lists, narrowed by this segment, would mail right now, and up to twenty of them by name, before any campaign exists. Writes nothing. The same walk the send does, so somebody on two of the lists is counted once, and anybody suppressed, anybody who left and anybody who never confirmed is counted separately rather than offered. With no lists and a segment, it counts everybody on any list who matches the segment.

Create a campaign in draft. Nothing is sent and nothing is queued: a new campaign always starts as a draft and has to be started separately, which is a different permission. The body is Markdown, wrapped in the store's own email layout. Merge tags are checked here rather than at send time, so a campaign carrying a variable that is not allowed is refused now with the variable named. Pass a template id to start from a saved template, which copies its fields once.

Change a campaign that has not gone anywhere yet. Allowed from draft and scheduled only: a campaign that is sending has already put its subject in somebody's inbox, and editing it would mean two halves of one audience receiving two different messages under one name. Anything else is refused with a sentence saying so. Merge tags are checked against the campaign as it would stand afterwards, so a bad tag left in the body is reported even when only the subject was edited.

Remove a campaign and everything it recorded. Only a draft or a campaign that was canceled can be deleted; anything that has sent a message is refused, because its recipient list is the only record of who received it and that is the question a complaint always asks.

Who this campaign was sent to and what happened to each of them, a page at a time. On a campaign testing two subjects each row also carries the letter that person was actually sent, A or B. With the status counts for the whole campaign rather than for the page. Filter by status to answer the two questions that come up: which addresses failed and why (the transport's own words are on the row), and who was excluded before anything was sent — suppressed, already off the list, or never confirmed.

Every link in the campaign with how many times it was pressed and what share of the people it reached that is, ordered by clicks so the link that worked is at the top rather than buried under the header image nobody pressed. Empty until the campaign has been rendered for sending, because that is when the links are recorded.

Four cumulative series — sent, delivered, opened, clicked — in one-hour buckets from the moment the first message went out, over the first forty-eight hours. Cumulative rather than per hour, so every line only goes up and how it climbs is the answer. Use it to tell a subject line that landed from one that was opened out of habit three days later.

Render a campaign the way one person would receive it, through the real layout with the real Markdown and the real merge pass, and answer the HTML, the plain-text part and the subject. Tracking is off, so nothing here is counted and no link is rewritten. Draft fields in the body override the saved ones, so an unsaved edit can be previewed without being saved first. Any merge tag the sandbox will not allow comes back in the refusals list beside the render rather than instead of it.

Mail one copy of a campaign to an address, with the subject prefixed and nothing counted, so it can be looked at in a real inbox before anybody else sees it. It goes through the store's real transport, which is the point of it, so this needs the send permission rather than the manage one. An address that is already a real subscriber is used as it stands, links and all; a genuinely new address is written down and flagged as a test so it never enters an audience.

Put this campaign in inboxes, now or at a moment. The audience is worked out first, so a campaign that would reach nobody is refused before anything is queued, and everybody excluded gets a row saying why. A scheduled_at in the future schedules it; one in the past or omitted sends it now. This is a one-way door — pausing stops what has not gone and does not get back what has — which is why sending is a permission of its own.

Stop a sending or scheduled campaign within one message. The running job is asked to cancel before the status is written, so there is no window in which the campaign says paused while its job is still delivering. Resuming later carries on from what is still pending, and nobody is mailed twice.

Carry on with a paused campaign, or restart one that stopped itself after too many refused messages. A fresh job is queued rather than the old one revived, and it claims only the recipients still waiting — the unique constraint on the recipient row is what makes that safe. Needs the send permission, because this is what puts the remaining mail in the remaining inboxes.

Stop a campaign for good. It cannot be started again, and whoever has already received it keeps it. The recipients still waiting are left in place rather than deleted, because "who did this campaign not reach" is the question somebody asks the morning after a cancellation and those rows are the only answer.

Send a campaign that has already gone out to the people who joined its list afterwards and never received it. The audience is worked out again, which adds only the people who have joined since and who match the campaign's segment, and leaves everybody already mailed exactly as they are — so it stays one campaign with one report rather than a duplicate pointed at a segment. Nobody gets a second copy, a campaign that gives everybody their own coupon code mints a new one for each newcomer, and a campaign whose subject test already picked a winner sends the winner rather than re-opening the test. Only a sent campaign can do this, and it is refused when nobody has joined since. Needs the send permission, because it is what puts the mail in the inboxes.

How many people would be mailed if this campaign were sent on to the people who joined its list after it went out, and up to twenty of them by name. Writes nothing. The same walk the send itself does, so the number here is the number that would be written: everybody on the list — and in the segment, where the campaign names one — who has no recipient row on this campaign yet, with anybody suppressed, anybody who left the list and anybody who never confirmed counted separately rather than offered.

Try the failed sends of a campaign that has gone out again: every failed send, or only the one named by send_id. A failed send is one the mailer refused, usually because the transport could not be reached for a moment; bounces and complaints are never retried. The campaign runs again as the same campaign with the same report, nobody already mailed is mailed twice, and consent and suppression are checked again at delivery. Only a sent campaign can do this, and it is refused when nothing failed. Needs the send permission.

The campaign as it is saved, rendered through the real layout, for a reader without the manage permission and for the read-only demo. The POST on the same path renders unsaved fields as well.