suppressions · MachineMail Docs
suppressions create
Addresses we will not send to. Also spelled suppression.
| Command | Summary |
|---|---|
suppressions create |
Add suppression |
suppressions delete |
Remove suppression |
suppressions get |
Get suppression |
suppressions list |
List suppressions |
Every command also takes the global flags.
suppressions create
Add suppression.
Suppress an address for the whole organization, with —reason “manual”. Adding an address that is already suppressed replaces a bounce or manual suppression (its —reason becomes manual); a complaint suppression is returned unchanged. Sends to a suppressed address return 403.
Requires the list_entry_create permission.
shell
machinemail suppressions create [flags]
Flags
| Field | Description |
|---|---|
--email <value> |
Address to suppress. |
--detail <value> |
Note stored as --detail. |
--reason <value> |
Old name of --detail (it is stored as --detail; the suppression --reason is always manual). Ignored when --detail is set. |
| `-d, --data <json | @file |
Examples
shell
machinemail suppressions create --email someone@example.com
machinemail suppressions create --data @body.json
API
suppressions delete
Remove suppression.
Also: machinemail suppressions rm.
Allow sending to the address again. Organization-scoped credentials only: pod and inbox credentials get 403. Only bounce and manual suppressions can be removed: a complaint suppression returns 403 (Complaint suppressions can only be removed by MachineMail support; email support@machinemail.dev).
Requires the list_entry_delete permission.
shell
machinemail suppressions delete <email> [flags]
Arguments
| Field | Description |
|---|---|
<email> |
Required; The suppressed address (URL-encoded). |
Examples
shell
machinemail suppressions delete someone@example.com
API
suppressions get
Get suppression.
Requires the list_entry_read permission.
shell
machinemail suppressions get <email> [flags]
Arguments
| Field | Description |
|---|---|
<email> |
Required; The suppressed address (URL-encoded). |
Examples
shell
machinemail suppressions get someone@example.com
API
suppressions list
List suppressions.
Also: machinemail suppressions ls.
Every suppressed address in the organization (also for pod and inbox credentials). Addresses are added automatically on permanent bounces and complaints.
Requires the list_entry_read permission.
shell
machinemail suppressions list [flags]
Flags
| Field | Description |
|---|---|
--limit <n> |
Maximum number of items to return. Default 50, maximum 500; larger values are capped. |
--page-token <value> |
next_page_token from the previous page. |
--ascending |
Sort oldest first. |
--all |
Follow next_page_token and return every page. |
Examples
shell
machinemail suppressions list
machinemail suppressions list --all --json | jq '.suppressions | length'