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
list(q: nil, reason: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns one page of the addresses this workspace will not send to, newest first: every address that bounced hard, complained, or was added by hand. list_all 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
qStringSearches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
reasonStringKeeps one kind:
bounce,complaintormanual.limitIntegerPage size, from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorof the previous page. Leave it out for the first page.api_keyStringOverrides the client API key for this call only.
Returns
The Nextmail::Page of Hashes, with items, has_more? and next_cursor. Each item has id, email, reason, detail, removable and createdAt.
Example
page = client.suppressions.list(reason: "complaint") p page.items.map { |row| [row[:email], row[:createdAt]] }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
suppressions.list_all
Collect the whole suppression list into one array
list_all(q: nil, reason: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Walks every page of list and returns every suppressed address in one Array, newest first. One request per page, with the same filters on each.
Parameters
qStringSearches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
reasonStringKeeps one kind:
bounce,complaintormanual.limitIntegerPage size for each request, from 1 to 100. The server defaults to 25.
cursorStringStarts the walk after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Array of Hashes holding every suppressed address, each with the fields list returns.
Example
all = client.suppressions.list_all(limit: 100) blocked = all.map { |row| row[:email] }.to_set puts blocked.include?("ada@example.com")Notes
If any page fails, the error is raised and the rows already fetched are discarded.
Also available in
suppressions.iterate
Stream the suppression list one address at a time
iterate(q: nil, reason: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator 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. Given a block, it yields each row to the block instead.
Parameters
qStringSearches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
reasonStringKeeps one kind:
bounce,complaintormanual.limitIntegerPage size for each request, from 1 to 100. The server defaults to 25.
cursorStringStarts the walk after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Enumerator of Hashes, one suppressed address per step (or yields each one to a block).
Example
client.suppressions.iterate(q: "example.com") do |row| puts "#{row[:email]} #{row[:reason]}"endNotes
Pages are fetched only as they are needed, so an abandoned loop costs only the pages you consumed.
Also available in
suppressions.get
Read one suppressed address by id
get(id, api_key: nil) -> HashReturns 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
idStringRequiredThe id from
list.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with id, email, reason, detail, removable and createdAt.
Example
row = client.suppressions.get("7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e") puts row[:email], row[:removable]Notes
An id that is not on this workspace is a 404
resource_not_found.
Also available in
suppressions.add
Stop sending to an address
add(body = nil, api_key: nil, **fields) -> HashPuts 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.
Parameters
emailStringRequiredThe address to stop sending to. It is trimmed and lower cased.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash for the address, new or already there, with the fields get returns.
Example
row = client.suppressions.add(email: "noreply@example.com") puts row[:reason], row[:createdAt]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
suppressions.remove
Allow mail to an address again
remove(id, api_key: nil) -> HashTakes 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
idStringRequiredThe id from
list.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with object set to suppression, the id, the email, and deleted set to true.
Example
row = client.suppressions.list(q: "ada@example.com").items.first begin client.suppressions.remove(row[:id]) if rowrescue Nextmail::ConflictError puts "#{row[:email]} bounced hard, so it stays on the list"endNotes
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
suppressions.list_unsubscribes
List one page of the people who unsubscribed
list_unsubscribes(q: nil, source: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns 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 remove_unsubscribe 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
qStringOne whole address, matched exactly and without regard to case. The addresses are stored encrypted, so a part of one finds nothing.
sourceStringKeeps one way of unsubscribing:
link,one_click,complaint,importormanual.limitIntegerPage size, from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorof the previous page. Leave it out for the first page.api_keyStringOverrides the client API key for this call only.
Returns
The Nextmail::Page of Hashes, with items, has_more? and next_cursor. Each item has email, source, broadcastId, automationId, removable and createdAt.
Example
page = client.suppressions.list_unsubscribes(source: "one_click") p page.items.map { |row| [row[:email], row[:createdAt]] }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
suppressions.add_unsubscribe
Record that somebody unsubscribed
add_unsubscribe(body = nil, api_key: nil, **fields) -> HashRecords that somebody asked to stop getting marketing mail, for when they asked by phone, in a reply or anywhere else, with source: "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
emailStringRequiredThe address that asked for no more marketing mail. It is trimmed and lower cased.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash for the address, new or already there, with the fields list_unsubscribes returns.
Example
row = client.suppressions.add_unsubscribe(email: "ada@example.com") puts row[:source], row[:removable]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
suppressions.remove_unsubscribe
Take back an unsubscribe the team recorded
remove_unsubscribe(email, api_key: nil) -> HashTakes 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
emailStringRequiredThe address, as
list_unsubscribesreturns it. Case does not matter.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with object set to unsubscribe, the email, and deleted set to true.
Example
begin client.suppressions.remove_unsubscribe("ada@example.com")rescue Nextmail::ConflictError puts "Only the person can subscribe again"endNotes
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()- PHP
suppressions->removeUnsubscribe- Go
Suppressions.RemoveUnsubscribe- Java
suppressions().removeUnsubscribe- C#
Suppressions.RemoveUnsubscribeAsync- CLI
nextmail suppressions remove-unsubscribe
Google Workspace
Fastmail