PHP

$client->suppressions

この名前空間のすべてのメソッドの、シグネチャ、パラメーター、戻り値、例。

メソッド

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

`suppressions->list`

List one page of the suppression list

settings:read結果をページ単位で取得

シグネチャ

list(    ?string $q = null,    ?string $reason = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): Page

Returns one page of the addresses this workspace will not send to, newest first: every address that bounced hard, complained, or was added by hand. listAll collects every page and iterate walks them lazily.

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.

パラメーター

qstring: Searches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
reasonstring: Keeps one kind: bounce, complaint or manual, as in OpenEmail\Constants\SuppressionReasons.
limitint: Page size, from 1 to 100. The server defaults to 25.
cursorstring: The nextCursor of the previous page. Leave it out for the first page.
apiKeystring: Overrides the client API key for this call only.

戻り値

A Page of arrays with items, hasMore and nextCursor. Each item has id, email, reason, detail, removable and createdAt.

例

use OpenEmail\Constants\SuppressionReasons; $page = $client->suppressions->list(reason: SuppressionReasons::COMPLAINT); foreach ($page as $row) {    echo $row['email'], ' since ', $row['createdAt'], PHP_EOL;}

注意事項

Needs settings:read, the scope the Blocked addresses screen in Settings is gated on.
The cursor is opaque and holds where the last row sat, so an address removed between pages never breaks the walk. A cursor this list did not hand out is a 400 invalid_cursor.

ほかの提供先

API: GET /suppressions
TypeScript: suppressions.list()
Python: suppressions.list()
Ruby: suppressions.list
CLI: openemail suppressions list

`suppressions->listAll`

Collect the whole suppression list into one array

settings:read結果をページ単位で取得

シグネチャ

listAll(    ?string $q = null,    ?string $reason = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): array

Walks every page of list and returns every suppressed address, newest first. One request per page, with the same filters on each.

パラメーター

qstring: Searches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
reasonstring: Keeps one kind: bounce, complaint or manual, as in OpenEmail\Constants\SuppressionReasons.
limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstring: Starts the walk after this cursor instead of the first page.
apiKeystring: Overrides the client API key for every page of this walk.

戻り値

A list of arrays holding every suppressed address, each with the fields list returns.

例

$rows = $client->suppressions->listAll(limit: 100); $blocked = array_flip(array_column($rows, 'email')); echo isset($blocked['[email protected]']) ? 'Suppressed' : 'Can be sent to', PHP_EOL;

注意事項

If any page fails the call throws and the rows already fetched are discarded.

ほかの提供先

API: GET /suppressions
TypeScript: suppressions.listAll()
Python: suppressions.list_all()
Ruby: suppressions.list_all

`suppressions->iterate`

Stream the suppression list one address at a time

settings:read結果をページ単位で取得

シグネチャ

iterate(    ?string $q = null,    ?string $reason = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): Generator

Returns a Generator that yields one suppressed address at a time, newest first, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.

パラメーター

qstring: Searches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
reasonstring: Keeps one kind: bounce, complaint or manual, as in OpenEmail\Constants\SuppressionReasons.
limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstring: Starts the walk after this cursor instead of the first page.
apiKeystring: Overrides the client API key for every page of this walk.

戻り値

A Generator that yields one suppressed address per step.

例

foreach ($client->suppressions->iterate(q: 'example.com') as $row) {    echo $row['email'], ' ', $row['reason'], PHP_EOL;}

注意事項

The generator is lazy, so an abandoned loop costs only the pages you consumed.

ほかの提供先

API: GET /suppressions
TypeScript: suppressions.iterate()
Python: suppressions.iterate()
Ruby: suppressions.iterate

`suppressions->get`

Read one suppressed address by id

settings:read

シグネチャ

get(string $id, ?string $apiKey = null): array

Returns 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.

パラメーター

idstring必須: The id from list.
apiKeystring: Overrides the client API key for this call only.

戻り値

An array with id, email, reason, detail, removable and createdAt.

例

$row = $client->suppressions->get('7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e'); echo $row['email'], $row['removable'] ? ' can be removed' : ' stays on the list', PHP_EOL;

注意事項

An id that is not on this workspace is a 404 resource_not_found.

ほかの提供先

API: GET /suppressions/{id}
TypeScript: suppressions.get()
Python: suppressions.get()
Ruby: suppressions.get
CLI: openemail suppressions get

`suppressions->add`

Stop sending to an address

settings:write

シグネチャ

add(array $body, ?string $apiKey = null): array

Puts an address on the suppression list by hand, with reason set to 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.

パラメーター

emailstring必須: The address to stop sending to. It is trimmed and lower cased.
apiKeystring: Overrides the client API key for this call only.

戻り値

An array for the address, new or already there, with the fields get returns.

例

$row = $client->suppressions->add(['email' => '[email protected]']); echo $row['reason'], ' since ', $row['createdAt'], PHP_EOL;

注意事項

Safe to repeat: a second add finds the first entry, so the SDK retries it after a network failure.
A key limited to particular addresses or domains is refused with 422 capability_unsupported, because the list stops mail from every address in the workspace. So is an app connected by anybody but the owner.

ほかの提供先

API: POST /suppressions
TypeScript: suppressions.add()
Python: suppressions.add()
Ruby: suppressions.add
CLI: openemail suppressions add

`suppressions->remove`

Allow mail to an address again

settings:write

シグネチャ

remove(string $id, ?string $apiKey = null): array

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.

パラメーター

idstring必須: The id from list.
apiKeystring: Overrides the client API key for this call only.

戻り値

An array with object set to suppression, the id, the email, and deleted set to true.

例

use OpenEmail\Exception\ConflictException; $row = $client->suppressions->list(q: '[email protected]')->items[0] ?? null; if ($row !== null) {    try {        $client->suppressions->remove($row['id']);    } catch (ConflictException) {        echo $row['email'], ' bounced hard, so it stays on the list', PHP_EOL;    }}

注意事項

The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.
A key limited to particular addresses or domains is refused with 422 capability_unsupported.

ほかの提供先

API: DELETE /suppressions/{id}
TypeScript: suppressions.remove()
Python: suppressions.remove()
Ruby: suppressions.remove
CLI: openemail suppressions remove

$client->suppressions

メソッド

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

受信トレイを、あなたの思いどおりに。

受信トレイを、
あなたの思いどおりに。