PHP

$client->suppressions

Every method in this namespace: its signature, its parameters, what it returns and an example.

Methods

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:readPages through results

Signature

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.

Parameters

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 Nextmail\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.

Returns

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

Example

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

Notes

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.

Also available in

API: GET /suppressions
TypeScript: nextmail.suppressions.list()
Python: suppressions.list()
Ruby: suppressions.list
Go: Suppressions.List
Java: suppressions().list
C#: Suppressions.ListAsync
CLI: openemail suppressions list

`suppressions->listAll`

Collect the whole suppression list into one array

settings:readPages through results

Signature

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.

Parameters

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 Nextmail\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.

Returns

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

Example

$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;

Notes

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

Also available in

API: GET /suppressions
TypeScript: nextmail.suppressions.listAll()
Python: suppressions.list_all()
Ruby: suppressions.list_all
Go: Suppressions.ListAll
Java: suppressions().listAll
C#: Suppressions.ListAllAsync

`suppressions->iterate`

Stream the suppression list one address at a time

settings:readPages through results

Signature

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.

Parameters

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 Nextmail\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.

Returns

A Generator that yields one suppressed address per step.

Example

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

Notes

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

Also available in

API: GET /suppressions
TypeScript: nextmail.suppressions.iterate()
Python: suppressions.iterate()
Ruby: suppressions.iterate
Go: Suppressions.Iterate
Java: suppressions().iterate
C#: Suppressions.IterateAsync

`suppressions->get`

Read one suppressed address by id

settings:read

Signature

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.

Parameters

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

Returns

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

Example

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

Notes

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

Also available in

API: GET /suppressions/{id}
TypeScript: nextmail.suppressions.get()
Python: suppressions.get()
Ruby: suppressions.get
Go: Suppressions.Get
Java: suppressions().get
C#: Suppressions.GetAsync
CLI: openemail suppressions get

`suppressions->add`

Stop sending to an address

settings:write

Signature

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.

Parameters

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

Returns

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

Example

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

Notes

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.

Also available in

API: POST /suppressions
TypeScript: nextmail.suppressions.add()
Python: suppressions.add()
Ruby: suppressions.add
Go: Suppressions.Add
Java: suppressions().add
C#: Suppressions.AddAsync
CLI: openemail suppressions add

`suppressions->remove`

Allow mail to an address again

settings:write

Signature

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.

Parameters

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

Returns

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

Example

use Nextmail\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;    }}

Notes

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.

Also available in

API: DELETE /suppressions/{id}
TypeScript: nextmail.suppressions.remove()
Python: suppressions.remove()
Ruby: suppressions.remove
Go: Suppressions.Remove
Java: suppressions().remove
C#: Suppressions.RemoveAsync
CLI: openemail suppressions remove

`suppressions->listUnsubscribes`

List one page of the people who unsubscribed

settings:readPages through results

Signature

listUnsubscribes(    ?string $q = null,    ?string $source = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): Page

Returns one page of the people who asked this workspace for no more marketing mail, newest first. It is the Unsubscribed list on the Blocked addresses screen in Settings.

An unsubscribe belongs to the whole workspace and outlasts the contact: removing the person from an audience, deleting the contact or importing the address again never brings them back. Every broadcast and automation email skips them, and adding them to an audience records them there as unsubscribed. Mail people write to you, and your replies, still reach them, because only marketing mail stops. list is the hard block on every kind of mail.

removable says whether removeUnsubscribe takes it back, which is true only for one the team recorded by hand. A person who unsubscribed decides alone whether to come back: through a sign-up form they confirm from their inbox, or Subscribe again on the unsubscribe page.

Parameters

qstring: One whole address, matched exactly and without regard to case. The addresses are stored encrypted, so a part of one finds nothing.
sourcestring: Keeps one way of unsubscribing: link, one_click, complaint, import or manual, as in Nextmail\Constants\UnsubscribeSources.
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.

Returns

A Page of arrays with items, hasMore and nextCursor. Each item has email, source, broadcastId, automationId, removable and createdAt.

Example

use Nextmail\Constants\UnsubscribeSources; $page = $client->suppressions->listUnsubscribes(source: UnsubscribeSources::ONE_CLICK); foreach ($page as $row) {    echo $row['email'], ' left on ', $row['createdAt'], PHP_EOL;}

Notes

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. A cursor this list did not hand out is a 400 invalid_cursor.

Also available in

API: GET /suppressions/unsubscribes
TypeScript: nextmail.suppressions.listUnsubscribes()
Python: suppressions.list_unsubscribes()
Ruby: suppressions.list_unsubscribes
Go: Suppressions.ListUnsubscribes
Java: suppressions().listUnsubscribes
C#: Suppressions.ListUnsubscribesAsync
CLI: openemail suppressions list-unsubscribes

`suppressions->addUnsubscribe`

Record that somebody unsubscribed

settings:write

Signature

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

Records that somebody asked to stop getting marketing mail, for when they asked by phone, in a reply or anywhere else, with source set to manual. Their contact, if there is one, is unsubscribed from every audience at once, the automations sending to them end, and contact.unsubscribed fires. No broadcast or automation email goes to the address from then on, while ordinary mail and replies still do.

Recording an address that is already on the list changes nothing: the server answers 200 with the record it holds, where a new one answers 201.

Parameters

emailstringRequired: The address that asked for no more marketing mail. It is trimmed and lower cased.
apiKeystring: Overrides the client API key for this call only.

Returns

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

Example

$row = $client->suppressions->addUnsubscribe(['email' => '[email protected]']); echo $row['source'], $row['removable'] ? ' can be taken back' : ' stays', PHP_EOL;

Notes

Safe to repeat: a second call finds the first record, 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 covers every address in the workspace. So is an app connected by anybody but the owner.

Also available in

API: POST /suppressions/unsubscribes
TypeScript: nextmail.suppressions.addUnsubscribe()
Python: suppressions.add_unsubscribe()
Ruby: suppressions.add_unsubscribe
Go: Suppressions.AddUnsubscribe
Java: suppressions().addUnsubscribe
C#: Suppressions.AddUnsubscribeAsync
CLI: openemail suppressions add-unsubscribe

`suppressions->removeUnsubscribe`

Take back an unsubscribe the team recorded

settings:write

Signature

removeUnsubscribe(string $email, ?string $apiKey = null): array

Takes back an unsubscribe the team recorded by hand, for one recorded by mistake. The audiences it unsubscribed are subscribed again, and contact.resubscribed fires.

Every other kind is refused with 409 unsubscribe_not_removable, because a person who unsubscribed decides alone whether to come back: through a sign-up form they confirm from their inbox, or Subscribe again on the unsubscribe page. An address that has not unsubscribed is a 404.

Parameters

emailstringRequired: The address, as listUnsubscribes returns it. Case does not matter.
apiKeystring: Overrides the client API key for this call only.

Returns

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

Example

use Nextmail\Exception\ConflictException; try {    $client->suppressions->removeUnsubscribe('[email protected]');} catch (ConflictException) {    echo 'Only the person can subscribe again', PHP_EOL;}

Notes

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.

Also available in

API: DELETE /suppressions/unsubscribes/{email}
TypeScript: nextmail.suppressions.removeUnsubscribe()
Python: suppressions.remove_unsubscribe()
Ruby: suppressions.remove_unsubscribe
Go: Suppressions.RemoveUnsubscribe
Java: suppressions().removeUnsubscribe
C#: Suppressions.RemoveUnsubscribeAsync
CLI: openemail suppressions remove-unsubscribe

$client->suppressions

Methods

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.