문서로 건너뛰기
CLI

openemail suppressions

이 네임스페이스의 모든 명령과 그 인수, 플래그, 예시.

명령

The addresses this workspace will not send to: hard bounces, complaints and the ones you block by hand.

여기 있는 모든 명령은 --json, --profile, --dry-run 같은 전역 플래그도 받습니다. 전역 플래그 보기

openemail suppressions list

List one page of the suppression list

범위settings:read로그인 필요별칭ls

사용법

openemail suppressions list [flags]

Resolves one page of the addresses this workspace will not send to, newest first: every address that bounced hard, complained, or was added by hand.

A send to a suppressed address is refused for that recipient before anything leaves, and a message whose recipients are all suppressed fails outright. The list belongs to the whole workspace, so a key limited to some addresses reads all of it, and a row names the recipient, never which of your addresses sent to it.

removable says whether remove will take the address off. A hard bounce is permanent here, because the address could not take mail. A complaint or a manual entry can be removed.

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.

플래그

--q <value>

Searches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.

--reason <value>

Keeps one kind: bounce, complaint or manual.

--limit <n>

Page size, from 1 to 100. The server defaults to 25.

기본값25
--cursor <value>

The nextCursor of the previous page. Leave it out for the first page.

--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 suppressions list
With optional flags
openemail suppressions list --reason complaint
Walk every page and stop after 100 items
openemail suppressions list --all --max 100
One JSON object per line when piped
openemail suppressions list --all > suppressions.ndjson

다른 사용처

API
GET /suppressions
SDK
suppressions.list()

openemail suppressions get

Read one suppressed address by id

범위settings:read로그인 필요별칭showview

사용법

openemail suppressions get <id> [flags]

Resolves one row of the suppression list: the address, why it is there, the detail the bounce or complaint carried, whether it can be removed and when it was added.

인수

<id>필수

The id from list.

예시

openemail suppressions get 7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e
Print the raw JSON
openemail suppressions get 7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e --json

다른 사용처

API
GET /suppressions/{id}
SDK
suppressions.get()

openemail suppressions add

Stop sending to an address

범위settings:write로그인 필요별칭newcreate

사용법

openemail suppressions add --email <value> [flags]
openemail suppressions add --data <json|@file|-> [flags]

Puts an address on the suppression list by hand, with reason: 'manual', so no address in the workspace sends to it again until it is removed. It is the Block an address control on the Blocked addresses screen.

Adding an address that is already there changes nothing: the server answers 200 with the row it already holds, whatever its reason, where a new entry answers 201. Either way you get the row back. A new entry fires suppression.added to the webhooks that asked for it.

플래그

--email <value>

The address to stop sending to. It is trimmed and lower cased. 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 suppressions add --email [email protected]
Read the whole body from a JSON file
openemail suppressions add --data @suppression.json

다른 사용처

API
POST /suppressions
SDK
suppressions.add()

openemail suppressions remove

Allow mail to an address again

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

사용법

openemail suppressions remove <id> [flags]

Takes an address off the suppression list, so mail may go to it again. It is Allow again on the Blocked addresses screen, and it fires suppression.removed.

Only a complaint or a manual entry can be removed. A hard bounce answers 409 suppression_not_removable and stays, because the address could not take mail: check it is spelled right and send to the corrected one instead.

인수

<id>필수

The id from list.

예시

openemail suppressions remove 7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e
Skip the confirmation, for scripts
openemail suppressions remove 7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e --yes

다른 사용처

API
DELETE /suppressions/{id}
SDK
suppressions.remove()