mailpreferences.ini

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

Summary

Exponential configuration file for the e-mail preferences and consent system.

Description

Exponential configuration file for the e-mail preferences and consent system.

Every person can switch e-mail on and off per category on one page (mailpreferences/settings, mailpreferences/manage/<token> without login). The mail gate in eZMailTransport::send() checks every mail that declares a category (eZMail::setCategory() or the X-Exp-Mail-Category header) against the master switch, the category, the suppression list and a pending double opt-in; optional mail gets a footer, a one-click unsubscribe link and the RFC 8058 List-Unsubscribe and List-Unsubscribe-Post headers.

NOTE: It is not recommended to edit this file directly, instead a file in override should be created for the values the site needs: settings/override/mailpreferences.ini.append.php

The site secret for the links and the address hashes ([SecretSettings]) is generated on first use into settings/ove

Groups

Location

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

See also

Generated examples: the settings of mailpreferences.ini

Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this file. The groups are listed from the file; their settings are described in its comments.