exp:mailsuppression
The suppression list of the e-mail gate: list, check, add and lift entries (only hashes are stored).
Script bin/php/mailsuppression.php, code in kernel/private/classes/commands/mailsuppression.php. Run it from the installation root, as the user the web server runs as:
./console exp:mailsuppression --help
./console exp:mail:suppression --help
php bin/php/mailsuppression.php --helpHelp text
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
| Option | Value | Help |
|---|---|---|
--email | required | the address (check, add, lift) |
--hash | required | lift: the hash of an entry (list shows its start; the whole hash is in --json) |
--reason | required | add: the reason; list: only this reason |
--note | required | add: a note for the admins (the address is removed from it) |
--limit | required | list: how many (default 50) |
--offset | required | list: skip this many |
--json | list: JSON |
Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).
Related
Generated by ./console exp:help:examples from bin/php/mailsuppression.php, kernel/private/classes/commands/mailsuppression.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.