# Configuration reference

All settings are reached through the **Options** button at the top right of every Mail Log view. This page lists every option with its default. Some areas are described in more detail in chapters of their own; here you find the complete overview.

<div class="callout info" id="bkmrk-the-defaults-are-del">The defaults are deliberately frugal with data and suitable for most websites. Especially in the areas *body storage* and *sensitive content*, change only what you have understood.

</div>## Logging

<table class="table" id="bkmrk-optiondefaultmeaning"> <thead> <tr><th scope="col">Option</th><th scope="col">Default</th><th scope="col">Meaning</th></tr> </thead> <tbody> <tr><td>Enable logging</td><td>Yes</td><td>Main switch. Off = no new entries; existing ones stay accessible.</td></tr> <tr><td>Log failed mails</td><td>Yes</td><td>Also record mails the mailer reports as not sent.</td></tr> <tr><td>Log contexts</td><td>Frontend, backend, CLI, API</td><td>Where logging happens. The four areas can be chosen independently.</td></tr> <tr><td>Detect source extension</td><td>Yes</td><td>Determines the triggering extension (best effort). Switching it off saves a minimal amount of work per mail.</td></tr> </tbody></table>

## Body storage

<table class="table" id="bkmrk-optiondefaultmeaning-1"> <thead> <tr><th scope="col">Option</th><th scope="col">Default</th><th scope="col">Meaning</th></tr> </thead> <tbody> <tr><td>Storage mode</td><td>Metadata + first N KB</td><td>How much text is kept (see the chapter *Body storage, encryption and sensitive content*). Affects new entries only.</td></tr> <tr><td>Body retention (days)</td><td>30</td><td>Only with "full, deleted automatically": after this period the task removes the text.</td></tr> <tr><td>Body size to keep (KB)</td><td>4</td><td>Only with "metadata + first N KB": how many kilobytes from the start are stored.</td></tr> <tr><td>Maximum body size (KB)</td><td>1024</td><td>Global ceiling. Larger bodies are truncated and marked.</td></tr> <tr><td>Encryption key</td><td>—</td><td>Purely a status display. The key is derived from the Joomla secret; there is nothing to enter.</td></tr> </tbody></table>

## Raw MIME

<table class="table" id="bkmrk-store-raw-mimenokeep"> <tbody> <tr><td>Store raw MIME</td><td>**No**</td><td>Keep the exact RFC822 message (for clean .eml downloads). Off out of the box for privacy reasons.</td></tr> <tr><td>Encrypt raw MIME</td><td>No</td><td>Apply the same encryption as for bodies to the MIME message.</td></tr> </tbody></table>

## Attachments

<table class="table" id="bkmrk-capture-attachmentsy"> <tbody> <tr><td>Capture attachments</td><td>Yes</td><td>Copy every attachment to disk while sending.</td></tr> <tr><td>Storage path</td><td>empty (= safe default outside the web root)</td><td>Where the attachments are kept.</td></tr> <tr><td>Max. per file (MB)</td><td>10</td><td>Larger attachments are skipped; the metadata remains.</td></tr> <tr><td>Total storage budget (MB)</td><td>500</td><td>When exceeded, new attachments are skipped until the next cleanup.</td></tr> </tbody></table>

## Sensitive content

<table class="table" id="bkmrk-handling-of-sensitiv"> <tbody> <tr><td>Handling of sensitive mails</td><td>Metadata only</td><td>How mails matching the subject patterns are treated: metadata only, normally, or not logged at all.</td></tr> <tr><td>Subject patterns</td><td>`/password/i`, `/passwort/i`, `/reset/i`, `/token/i`, `/2fa/i`, `/verify/i`, `/verifizier/i`</td><td>One regular expression per line. If the subject matches, the mail counts as sensitive.</td></tr> <tr><td>Body masking patterns</td><td>`/token=…/`, `/key=…/`</td><td>Matches are replaced by `***` in the stored body.</td></tr> </tbody></table>

## Retention

<table class="table" id="bkmrk-entry-retention-%28day"> <tbody> <tr><td>Entry retention (days)</td><td>180</td><td>Older entries are removed by the task "clean up logs". 0 = no age-based cleanup.</td></tr> <tr><td>Maximum number of entries</td><td>0 (off)</td><td>FIFO ceiling: the oldest entries are removed as soon as the limit is exceeded.</td></tr> <tr><td>Attachment retention (days)</td><td>30</td><td>Older attachment files are removed by the attachment cleanup task.</td></tr> </tbody></table>

## Display rules

<table class="table" id="bkmrk-matchall-%28and%29whethe"> <tbody> <tr><td>Match</td><td>All (AND)</td><td>Whether a row has to satisfy all or any of the rules to be hidden.</td></tr> <tr><td>Rules</td><td>empty</td><td>Hide matching entries from the list and the statistics without deleting them. See the chapter *Log rules and display rules*.</td></tr> </tbody></table>

## Log rules

<table class="table" id="bkmrk-matchany-%28or%29whether"> <tbody> <tr><td>Match</td><td>Any (OR)</td><td>Whether a mail has to match all or any of the rules.</td></tr> <tr><td>Mode</td><td>Exclude matches</td><td>Exclude matches, or include matches only.</td></tr> <tr><td>Rules</td><td>empty</td><td>Decide before storing which mails are logged at all.</td></tr> </tbody></table>

## Notifications

<table class="table" id="bkmrk-enable-notifications"> <tbody> <tr><td>Enable notifications</td><td>No</td><td>Warn when a delivery fails.</td></tr> <tr><td>Notify super admins</td><td>Yes</td><td>To super users with system emails enabled.</td></tr> <tr><td>Additional recipients</td><td>empty</td><td>Further addresses.</td></tr> <tr><td>Throttle window (minutes)</td><td>30</td><td>Minimum gap between two alerts.</td></tr> <tr><td>Also as a Joomla private message</td><td>No</td><td>File the alert internally (com\_messages) as well.</td></tr> </tbody></table>

## Dashboard

<table class="table" id="bkmrk-statistics-modelivel"> <tbody> <tr><td>Statistics mode</td><td>Live</td><td>*Live* calculates from the entries on every view. *Task* uses pre-aggregated daily figures maintained by the statistics task — faster with very many entries.</td></tr> <tr><td>Default period</td><td>Last 30 days</td><td>Preset period of the chart.</td></tr> <tr><td>Show latest mails</td><td>10</td><td>How many entries the dashboard lists show.</td></tr> </tbody></table>

## Permissions

The standard Joomla tab. Which action needs which permission is described in the chapter [Permissions, export and privacy](https://docs.graup-it.de/books/mail-log-en/page/permissions-export-and-privacy).

<small>Applies to version 1.0.5.</small>

[Deutsche Fassung](https://docs.graup-it.de/link/87)