mailpreferences.ini [SuppressionSettings] #

The block [SuppressionSettings] of settings/mailpreferences.ini, with 3 setting(s).

Never edit settings/mailpreferences.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/mailpreferences.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/mailpreferences.ini.append.php for one siteaccess,
• extension/<extension>/settings/mailpreferences.ini.append.php in an extension (read when the extension is active).

RetentionDays #

Days a suppressed address stays suppressed; 0 is forever (the default:
only the hash is stored, the address cannot be read from it).

Default: 0.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[SuppressionSettings]
RetentionDays=0
*/ ?>

Reasons #

Reasons an address can be suppressed with.

Default: a list of 6: bounce, complaint, unsubscribe_all, legal, admin, bridge.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[SuppressionSettings]
# an empty "Reasons[]" first replaces the shipped list; without it the items are added
Reasons[]
Reasons[]=bounce
Reasons[]=complaint
Reasons[]=unsubscribe_all
Reasons[]=legal
Reasons[]=admin
Reasons[]=bridge
*/ ?>

Listeners #

Classes told when an address is suppressed or lifted, so another system's
own block list stays the same as this one (cjw_newsletter adds its
blacklist here): static suppressionAdded( $email, $hash, $reason ) and
suppressionLifted( $hash, $email or null, $reason ).

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[SuppressionSettings]
# an empty "Listeners[]" first replaces the shipped list; without it the items are added
Listeners[]
*/ ?>

Related #

• All blocks of mailpreferences.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/mailpreferences.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.