mailpreferences.ini [GateSettings] #

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

Gate #

enabled: categorised optional mail is checked and blocked when the person
has not switched the category on. disabled: every mail is sent as before
(optional mail still gets its footer and headers).

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[GateSettings]
Gate=enabled
*/ ?>

EssentialSenders #

Mail without a category is always sent, as before. It is logged as
"uncategorised" unless its sender is listed here: an e-mail address of the
From header, or a file of the code that hands the mail to eZMailTransport
(path relative to the installation), or a class name in that call stack.
Senders listed here are logged as essential.

Default: a list of 7: kernel/private/classes/views/user/register.php, kernel/private/classes/views/user/forgotpassword.php, kernel/user/ezuseroperationcollection.php, kernel/classes/confirmorderhandlers/ezdefaultconfirmorderhandler.php, kernel/classes/audit/sinks/expauditmailsink.php, kernel/setup/steps/ezstep_registration.php, expMailPreferencesService.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[GateSettings]
# an empty "EssentialSenders[]" first replaces the shipped list; without it the items are added
EssentialSenders[]
EssentialSenders[]=kernel/private/classes/views/user/register.php
EssentialSenders[]=kernel/private/classes/views/user/forgotpassword.php
EssentialSenders[]=kernel/user/ezuseroperationcollection.php
EssentialSenders[]=kernel/classes/confirmorderhandlers/ezdefaultconfirmorderhandler.php
EssentialSenders[]=kernel/classes/audit/sinks/expauditmailsink.php
EssentialSenders[]=kernel/setup/steps/ezstep_registration.php
EssentialSenders[]=expMailPreferencesService
*/ ?>

LogFile #

The gate's own log of decisions (blocked, sent, uncategorised), JSON lines,
without addresses, relative to the var directory. Rotated at MaxLogSize bytes.

Default: log/mailgate.jsonl.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[GateSettings]
LogFile=log/mailgate.jsonl
*/ ?>

MaxLogSize #

Default: 5242880.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[GateSettings]
MaxLogSize=5242880
*/ ?>

SplitRecipients #

Optional mail to several recipients is sent as one message per recipient,
so each gets a working unsubscribe link of its own.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/mailpreferences.ini.append.php
[GateSettings]
SplitRecipients=enabled
*/ ?>

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.