Skip to the content
Documentation

[CategorySettings]

No ratings yet

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

Summary

The group [CategorySettings] of settings/mailpreferences.ini.

File

settings/mailpreferences.ini; override it in settings/override/mailpreferences.ini.append.php, in a siteaccess or in an extension.

Settings

Setting Default Description
AllowDefaultOn disabled 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.
Categories[] content; collaboration; newsletter; marketing; system; security; orders; legal; admin  

See also

Generated example: mailpreferences.ini [CategorySettings]

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/mailpreferences.ini.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.