mailpreferences.ini [CategorySettings] #

The block [CategorySettings] of settings/mailpreferences.ini, with 2 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).

AllowDefaultOn #

The categories, in the order the preference page shows them. Each has a
block [Category_<identifier>]:
Name, Description shown on the page (translated through the
kernel/mailpreferences/categories context)
Essential true: never switchable, always sent (account
security, orders, legal notices, admin alerts)
DefaultOn only for optional categories; false (opt-in) is the
default and the only lawful choice in the EU. true is
refused (treated as false, with a warning on the status
page) unless AllowDefaultOn=enabled below
Frequencies[] immediate, daily, weekly; empty: the category keeps
its own schedule
DoubleOptIn true: switching on sends a confirmation mail first
HandlerClass optional PHP class implementing
expMailCategoryHandler, which reads existing data
(subscriptions) as the state of the category
Extensions add categories in their own mailpreferences.ini.append.php.

AllowDefaultOn: enabled lets an optional category be on for everybody who never
chose (DefaultOn=true: opt-out). Only for a site whose recipients are under a
law that allows it for that mail (never marketing in the EU or to Canada).
disabled (the default): DefaultOn=true is treated as false.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[CategorySettings]
AllowDefaultOn=disabled
*/ ?>

Categories #

Default: a list of 9: content, collaboration, newsletter, marketing, system, security, orders, legal, admin.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[CategorySettings]
# an empty "Categories[]" first replaces the shipped list; without it the items are added
Categories[]
Categories[]=content
Categories[]=collaboration
Categories[]=newsletter
Categories[]=marketing
Categories[]=system
Categories[]=security
Categories[]=orders
Categories[]=legal
Categories[]=admin
*/ ?>

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.