openemail provider-imports
Каждая команда этого пространства имён, с её аргументами, флагами и примерами.
Команды
Move from Resend: suppressions, audiences, contacts, templates and webhooks come across with one key, with a checklist for domains and API keys.
Каждая команда здесь также принимает глобальные флаги, например --json, --profile и --dry-run. Глобальные флаги
openemail provider-imports inspect
Look inside a Resend account before importing
Использование
openemail provider-imports inspect <api-key> [flags]
Reads the first page of every resource with a full-access Resend key and returns a count for each, with more set where a resource runs past its first page. Nothing is stored, and the key is not kept.
A sending-only key is 400 restricted_key: create a full-access key at Resend for the import and revoke it afterwards.
Аргументы
<api-key>ОбязательноA full-access Resend API key,
re_…. Pass - to read it from standard input, or @path to read it from a file, so it stays out of your shell history.
Примеры
openemail provider-imports inspect @resend-key.txtopenemail provider-imports inspect @resend-key.txt --jsonТакже доступно в
openemail provider-imports create
Import from Resend
newaddИспользование
openemail provider-imports create --resend-key <value> --resources <a,b> [flags] openemail provider-imports create --data <json|@file|-> [flags]
Queues an import from a Resend account. Suppressions keep their reason, segments 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. Domains and API keys come back as a checklist in the report, since a signing key or a token cannot leave Resend.
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.
Флаги
--resend-key <value>A full-access Resend API key. 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.--resources <a,b>Можно повторятьAny 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.
Примеры
openemail provider-imports create --resend-key @resend-key.txt --resources suppressions,audiences,contacts,templates,webhooks,domains,api-keysopenemail provider-imports create --data @provider-import.jsonТакже доступно в
openemail provider-imports list
List one page of imports from sending providers
lsИспользование
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.
Флаги
--limit <n>Rows per page, a whole number from 1 to 100. The server defaults to 25.
По умолчанию25--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
Примеры
openemail provider-imports listopenemail provider-imports list --all --max 100openemail provider-imports list --all > provider-imports.ndjsonТакже доступно в
openemail provider-imports get
Read one import from a sending provider
showviewИспользование
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.
Аргументы
<id>ОбязательноProvider import id,
pimp_followed by 24 hex characters.
Примеры
openemail provider-imports get pimp_3f9c2a7b1e4d8f60a5c7b92dopenemail provider-imports get pimp_3f9c2a7b1e4d8f60a5c7b92d --jsonТакже доступно в
openemail provider-imports cancel
Cancel an import from a sending provider
Использование
openemail provider-imports cancel <id> [flags]
Stops the import and erases the Resend key. What already came across stays.
Аргументы
<id>ОбязательноProvider import id,
pimp_followed by 24 hex characters.
Примеры
openemail provider-imports cancel pimp_3f9c2a7b1e4d8f60a5c7b92dopenemail provider-imports cancel pimp_3f9c2a7b1e4d8f60a5c7b92d --yes