Skip to main content

Function: createCampaigns()

createCampaigns(options): object

Defined in: campaigns.ts:349

Campaigns on top of the engine: write one, freeze its audience, and let a cron call tick() until everyone is handled.

tick is safe to run from any scheduler (a setInterval, a Lambda on a schedule): it works for at most budgetMs, respects ratePerSecond, and the next tick continues where it stopped. Each recipient is claimed before sending and completed after, so a crash never sends twice: what a dead tick left sending becomes failed/interrupted. Run one tick at a time, or the rate adds up across them.

Every e-mail goes through marketing.send, so suppressions, canSend and resolveSender apply to each recipient at the moment it is sent.

Parameters​

ParameterType
optionsCampaignsOptions

Returns​

cancel​

cancel: (id) => Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

Parameters​

ParameterType
idstring

Returns​

Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

create​

create: (input) => Promise<Campaign>

Parameters​

ParameterType
inputCreateCampaignInput

Returns​

Promise<Campaign>

get​

get: (id) => Promise<Campaign>

Parameters​

ParameterType
idstring

Returns​

Promise<Campaign>

pause​

pause: (id) => Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

Parameters​

ParameterType
idstring

Returns​

Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

preview​

preview: (__namedParameters) => Promise<CampaignContent>

What one recipient would receive, with variables filled in.

Parameters​

ParameterType
__namedParameters{ id: string; variables?: TemplateVariables; }
__namedParameters.idstring
__namedParameters.variables?TemplateVariables

Returns​

Promise<CampaignContent>

resume​

resume: (id) => Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

Parameters​

ParameterType
idstring

Returns​

Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

schedule​

schedule: (__namedParameters) => Promise<{ added: number; campaign: Campaign; }>

Freezes the audience and sets the start: the first tick at or after at (default now) starts sending. Addresses are normalized and de-duplicated, invalid ones dropped. Scheduling again adds recipients and moves the start.

Parameters​

ParameterType
__namedParameters{ at?: Date; audience: Audience; id: string; }
__namedParameters.at?Date
__namedParameters.audienceAudience
__namedParameters.idstring

Returns​

Promise<{ added: number; campaign: Campaign; }>

sendTest​

sendTest: (__namedParameters) => Promise<SendResult>

Sends the campaign to one address now, through the engine, without touching its recipients.

Parameters​

ParameterType
__namedParameters{ id: string; to: string; variables?: TemplateVariables; }
__namedParameters.idstring
__namedParameters.tostring
__namedParameters.variables?TemplateVariables

Returns​

Promise<SendResult>

stats​

stats: (id) => Promise<RecipientCounts>

Parameters​

ParameterType
idstring

Returns​

Promise<RecipientCounts>

tick​

tick: (__namedParameters) => Promise<TickResult>

One unit of work for a cron: starts the campaigns that are due, then sends until budgetMs runs out (default 50 seconds, under a one-minute schedule).

Parameters​

ParameterType
__namedParameters{ budgetMs?: number; }
__namedParameters.budgetMs?number

Returns​

Promise<TickResult>

update​

update: (__namedParameters) => Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

Changes name or content while draft or scheduled.

Parameters​

ParameterType
__namedParametersPartial<CampaignContent> & object

Returns​

Promise<{ createdAt: Date; finishedAt: Date | null; html: string; id: string; kind: string; name: string; scheduledAt: Date | null; scope: string; startedAt: Date | null; status: CampaignStatus; subject: string; text: string; }>

Example​

const campaigns = createCampaigns({ marketing, campaigns: campaignStore, recipients: recipientStore });
const { id } = await campaigns.create({ scope, name: 'Black Friday', subject, html, text });
await campaigns.schedule({ id, audience: leads.map((l) => ({ email: l.email, variables: { nome: l.name } })) });
// every minute, from a cron:
await campaigns.tick({ budgetMs: 50_000 });