newsletter
engine-dmo newsletter: The newsletter's subscribers, campaigns and deliverability. Every subcommand, argument and flag.
The newsletter’s subscribers, campaigns and deliverability.
| Command | What it does |
|---|---|
engine-dmo newsletter campaigns | List a site’s campaigns |
engine-dmo newsletter deliverability | Check SPF, DKIM and DMARC for each site’s sending domain, record the results, and show the complaint rate |
engine-dmo newsletter export | Export a site’s subscribers, or with --topics the recipients of that segment, as CSV; audited with the row count |
engine-dmo newsletter hygiene | Report a site’s list health: active, dormant, never confirmed, unsubscribed and bounced |
engine-dmo newsletter import | Import subscribers from a CSV file under a declared lawful basis, recorded on every row; --dry-run counts and writes nothing |
engine-dmo newsletter send | Send a draft campaign now; needs --confirm, since a send cannot be taken back |
engine-dmo newsletter subscribers | List a site’s subscribers; --dormant 12m lists the active ones with no click in that period |
engine-dmo newsletter suppress | Suppress an address on every channel: an alias for engine-dmo mail suppression add |
engine-dmo newsletter campaigns
List a site’s campaigns.
engine-dmo newsletter campaigns [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--site | string | site key | |
--status | string | draft | scheduled | sending | sent | cancelled |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo newsletter deliverability
Check SPF, DKIM and DMARC for each site’s sending domain, record the results, and show the complaint rate.
engine-dmo newsletter deliverability --json prints the text output in the JSON envelope. Runs in a project.
engine-dmo newsletter export
Export a site’s subscribers, or with --topics the recipients of that segment, as CSV; audited with the row count.
engine-dmo newsletter export [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--out | string | file to write; standard output when empty | |
--site | string | site key | |
--status | string | only subscribers in this status | |
--topics | string | a segment: the recipients interested in any of these topics, comma separated |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo newsletter hygiene
Report a site’s list health: active, dormant, never confirmed, unsubscribed and bounced.
engine-dmo newsletter hygiene [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--report | bool | print the report | |
--site | string | site key |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo newsletter import
Import subscribers from a CSV file under a declared lawful basis, recorded on every row; --dry-run counts and writes nothing.
engine-dmo newsletter import [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--basis | string | the lawful basis: consent | legitimate_interest | contract | |
--dry-run | bool | count what would happen and write nothing | |
--file | string | CSV file with an email column, and optionally name, locale, topics and consented_at | |
--site | string | site key |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo newsletter send
Send a draft campaign now; needs --confirm, since a send cannot be taken back.
engine-dmo newsletter send [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--campaign | string | campaign id | |
--confirm | bool | send it |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo newsletter subscribers
List a site’s subscribers; --dormant 12m lists the active ones with no click in that period.
engine-dmo newsletter subscribers [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--dormant | string | a period such as 12m: active subscribers with no click since | |
--site | string | site key | |
--status | string | pending | active | unsubscribed | bounced | complained | suppressed |
--json prints the text output in the JSON envelope. Runs in a project.
engine-dmo newsletter suppress
Suppress an address on every channel: an alias for engine-dmo mail suppression add.
engine-dmo newsletter suppress [flags] | Flag | Type | Default | Meaning |
|---|---|---|---|
--email | string | address | |
--reason | string | manual | hard_bounce | complaint | manual | unsubscribe_all | erasure |
--json prints the text output in the JSON envelope. Runs in a project.