exp:mailsuppression

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

The suppression list of the e-mail gate: list, check, add and lift entries (only hashes are stored)

Usage

./console exp:mailsuppression [options]
php bin/php/mailsuppression.php [options]
./console exp:mail:suppression [options]

Aliases

exp:mail:suppression

Help

The output of ./console help exp:mailsuppression (the script run with --help), without the standard options:

Usage: bin/php/mailsuppression.php [OPTION]...
E-mail suppression list
No optional mail goes to a suppressed address. The table holds a salted sha256 hash of each
address, never the address: an entry is found by entering the address.
  list                      the entries: hash (start), reason, date, note
  check                     is --email suppressed, and why
  add                       suppress --email with --reason (bounce, complaint, unsubscribe_all, legal, admin, bridge)
  lift                      lift the entry of --email or --hash

./console exp:mail:suppression list --reason=bounce
./console exp:mail:suppression add [email protected] --reason=legal --note="Request of 2026-10-04"
./console exp:mail:suppression lift --hash=3f2a...


Options:
  --email=VALUE   the address (check, add, lift)
  --hash=VALUE    lift: the hash of an entry (list shows its start; the whole hash is in --json)
  --reason=VALUE  add: the reason; list: only this reason
  --note=VALUE    add: a note for the admins (the address is removed from it)
  --limit=VALUE   list: how many (default 50)
  --offset=VALUE  list: skip this many
  --json          list: JSON

Options

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/mailsuppression.php, kernel/private/classes/commands/mailsuppression.php

See also

Generated example: exp:mailsuppression

Added to the reference for Exponential 6.0.15.