[BounceSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [BounceSettings] 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 |
|---|---|---|
| Reader | disabled | The mailbox that bounces and spam complaints arrive in (the Return-Path of the mail, and the address given to the feedback loops of the large mail providers). Hard bounces (RFC 3464 delivery status notifications) and complaints (RFC 5965 ARF reports) put the address on the suppression list. Read by the cronjob part mailbounces (also in the frequent group) and by ./console exp:mail:bounces (--dry-run shows what it would do). Set the server, the user and the password ONLY in settings/override/mailpreferences.ini.append.php, which is never committed. enabled: read the mailbox; disabled (the default): nothing is read. |
| Protocol | imap | imap or pop3 |
| Server | (empty) | |
| Port | (empty) | Empty: 993 for IMAP and 995 for POP3 with SSL, 143 and 110 without. |
| User | (empty) | |
| Password | (empty) | |
| SSL | enabled | |
| Folder | INBOX | IMAP only: the folder that is read. |
| AfterRead | keep | keep: IMAP reads only unread messages and marks them read, POP3 reads every message each time (an address is not added twice). delete: the messages that were understood (bounces and complaints) are deleted after reading. |
| MaxMessages | 500 | At most this many messages per run. |
| HardStatusCodes[] | 5.1.; 5.2.1; 5.4.4 | The status codes of a failed delivery that make it a hard bounce; a code ending in a dot matches every code that starts with it. Other failures and delays are counted, not suppressed. 5.1.x: the address or the domain does not exist; 5.2.1: the mailbox is disabled; 5.4.4: no mail server for the domain. |
| StatusFile | log/mailbounces.json | The last run (time, counts, error) for the status page and exp:mail:status, relative to the var directory. |
| MessageListeners[] | (empty array) | Classes that get every message the reader reads, after the reader's own classification and suppression: static mailMessage( $raw, $classification, $dryRun ), true when the message was for them (AfterRead=delete then removes it). For another system's own bounces, or mail to its own addresses that arrives in this mailbox (cjw_newsletter: subscribe and unsubscribe by e-mail, soft-bounce retries). A listener must not change anything in a dry run; one that fails is logged and the reading goes on. Extensions add their class in their own settings. |
See also
Generated example: mailpreferences.ini [BounceSettings]
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
- Graham Brookins Updated
Comments
Add a comment