openemail provider-imports
Every command in this namespace, with its arguments, flags and examples.
Commands
Move from Resend, SendGrid, Postmark, Mailgun or Mailchimp: suppressions, audiences, contacts, templates and webhooks come across with one key, with a checklist for domains and API keys.
Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags
openemail provider-imports inspect
Look inside an account at another provider before importing
Usage
openemail provider-imports inspect <api-key> [flags]
Reads the first page of every resource with a key from Resend, SendGrid, Postmark, Mailgun or Mailchimp and returns a count for each, with more set where a resource runs past its first page. resources lists what this key can bring across: what the provider has no such thing for, or the key may not read, is left out. Nothing is stored, and the key is not kept.
--provider picks the provider and defaults to resend. Resend needs a full-access key, SendGrid a key with read access, Postmark a Server API token, Mailgun a private API key from either region and Mailchimp an API key with its datacenter suffix. A key that can read nothing but sending is 400 restricted_key: create one with more access for the import and revoke it afterwards.
Arguments
<api-key>RequiredThe key from the other provider: a full-access Resend key
re_…, a SendGrid keySG.…, a Postmark Server API token, a Mailgun private API key or a Mailchimp key ending in its datacenter, such as-us6. Pass - to read it from standard input, or @path to read it from a file, so it stays out of your shell history.
Flags
--provider <value>One of
resend,sendgrid,postmark,mailgunandmailchimp. Defaults toresend.
Examples
openemail provider-imports inspect @provider-key.txtopenemail provider-imports inspect @provider-key.txt --provider sendgridAlso available in
openemail provider-imports create
Import from another provider
newaddUsage
openemail provider-imports create --provider-key <value> --resources <a,b> [flags] openemail provider-imports create --data <json|@file|-> [flags]
Queues an import from Resend, SendGrid, Postmark, Mailgun or Mailchimp. Suppressions keep their reason, segments and lists become audiences, subscribed contacts arrive with their names, templates arrive as HTML templates with their variables declared, and webhooks are registered switched off because deliveries here are signed differently. A contact who unsubscribed at the provider is not imported and is recorded as unsubscribed, so suppressions.listUnsubscribes lists them. Domains and API keys come back as a checklist in the report, since a signing key or a token cannot leave the provider that made it. Resources the provider has no such thing for, or the key cannot read, are left out, and resources on the import says what it brings.
The key is held encrypted only while the import runs and is erased when it ends, fails or is cancelled. Running it twice duplicates nothing.
Flags
--provider-key <value>The key from the other provider, as
inspecttakes it. Pass - to read it from standard input, or @path to read it from a file, so it stays out of your shell history. Required, here or in--data.--provider <value>One of
resend,sendgrid,postmark,mailgunandmailchimp. Defaults toresend.Default"resend"--resources <a,b>RepeatableAny of
suppressions,audiences,contacts,templates,webhooks,domainsandapi-keys. Required, here or in--data.--data <json|@file|->The whole
bodyas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
Examples
openemail provider-imports create --provider-key @provider-key.txt --resources suppressions,audiences,contacts,templates,webhooks,domains,api-keysopenemail provider-imports create --provider-key @provider-key.txt --resources suppressions,audiences,contacts,templates,webhooks,domains,api-keys --provider mailgunopenemail provider-imports create --data @provider-import.jsonAlso available in
openemail provider-imports list
List one page of imports from sending providers
lsUsage
openemail provider-imports list [flags]
One page of the provider imports in the workspace, newest first, each with its report.
Add --all to walk every page: a table on a terminal, one JSON object per line when piped or with --ndjson, and one { items, hasMore, nextCursor } document with --json. --max <n> stops after that many items.
Flags
--limit <n>Rows per page, a whole number from 1 to 100. The server defaults to 25.
Default25--cursor <value>The
nextCursorfrom the previous page. One that names no provider import in the workspace is a 400invalid_cursor.--allFetch every page and stream the items as they arrive.
--max <n>Stop after this many items. Implies
--all.--ndjsonPrint every item as one JSON object per line. Implies
--all
Examples
openemail provider-imports listopenemail provider-imports list --all --max 100openemail provider-imports list --all > provider-imports.ndjsonAlso available in
openemail provider-imports get
Read one import from a sending provider
showviewUsage
openemail provider-imports get <id> [flags]
Status, the step it is on and the report so far. Poll it while status is queued or running.
Arguments
<id>RequiredProvider import id,
pimp_followed by 24 hex characters.
Examples
openemail provider-imports get pimp_3f9c2a7b1e4d8f60a5c7b92dopenemail provider-imports get pimp_3f9c2a7b1e4d8f60a5c7b92d --jsonAlso available in
openemail provider-imports cancel
Cancel an import from a sending provider
Usage
openemail provider-imports cancel <id> [flags]
Stops the import and erases the provider key. What already came across stays.
Arguments
<id>RequiredProvider import id,
pimp_followed by 24 hex characters.
Examples
openemail provider-imports cancel pimp_3f9c2a7b1e4d8f60a5c7b92dopenemail provider-imports cancel pimp_3f9c2a7b1e4d8f60a5c7b92d --yes