문서로 건너뛰기
CLI

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

범위settings:write로그인 필요

사용법

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.txt
Print the raw JSON
openemail provider-imports inspect @resend-key.txt --json

다른 사용처

API
POST /provider-imports/inspect
SDK
providerImports.inspect()

openemail provider-imports create

Import from Resend

범위settings:write로그인 필요별칭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, domains and api-keys. Required, here or in --data.

--data <json|@file|->

The whole body as 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-keys
Read the whole body from a JSON file
openemail provider-imports create --data @provider-import.json

다른 사용처

API
POST /provider-imports
SDK
providerImports.create()

openemail provider-imports list

List one page of imports from sending providers

범위settings:read로그인 필요별칭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 nextCursor from the previous page. One that names no provider import in the workspace is a 400 invalid_cursor.

--all

Fetch every page and stream the items as they arrive.

--max <n>

Stop after this many items. Implies --all.

--ndjson

Print every item as one JSON object per line. Implies --all

예시

openemail provider-imports list
Walk every page and stop after 100 items
openemail provider-imports list --all --max 100
One JSON object per line when piped
openemail provider-imports list --all > provider-imports.ndjson

다른 사용처

API
GET /provider-imports
SDK
providerImports.list()

openemail provider-imports get

Read one import from a sending provider

범위settings:read로그인 필요별칭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_3f9c2a7b1e4d8f60a5c7b92d
Print the raw JSON
openemail provider-imports get pimp_3f9c2a7b1e4d8f60a5c7b92d --json

다른 사용처

API
GET /provider-imports/{id}
SDK
providerImports.get()

openemail provider-imports cancel

Cancel an import from a sending provider

범위settings:write로그인 필요
확인을 요청합니다

사용법

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_3f9c2a7b1e4d8f60a5c7b92d
Skip the confirmation, for scripts
openemail provider-imports cancel pimp_3f9c2a7b1e4d8f60a5c7b92d --yes

다른 사용처

API
POST /provider-imports/{id}/cancel
SDK
providerImports.cancel()