expmailsuppression

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

Summary

The suppression list (table expmail_suppression): addresses no optional mail goes to (hard bounces, complaints, "unsubscribe from all", legal requests, admin entries, the cjw_newsletter blacklist through the bridge).

Description

The suppression list (table expmail_suppression): addresses no optional mail goes to (hard bounces, complaints, "unsubscribe from all", legal requests, admin entries, the cjw_newsletter blacklist through the bridge). Only a hash is stored: sha256( lowercase( trim( address ) ) . site secret ), so the address cannot be read from the table; an admin finds an entry by entering the address. Entries are kept forever unless mailpreferences.ini [SuppressionSettings] RetentionDays says otherwise.

\code expMailSuppression::add( '[email protected]', 'bounce', 'Hard bounce 550 5.1.1' ); expMailSuppression::isSuppressed( '[email protected]' ); // true expMailSuppression::lift( '[email protected]' ); // or the hash \endcode

Persistent

Yes. Table expmail_suppression.

Attributes

* Yes: a field of the table (a stored value); No: a function attribute, computed when it is asked for.

Source

kernel/classes/mailpreferences/expmailsuppression.php, expMailSuppression::definition()

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this object.