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.
  
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.
Logging
  
    
Option
Default
Meaning
  
  
    
Enable logging
Yes
Main switch. Off = no new entries; existing ones stay accessible.
    
Log failed mails
Yes
Also record mails the mailer reports as not sent.
    
Log contexts
Frontend, backend, CLI, API
Where logging happens. The four areas can be chosen independently.
    
Detect source extension
Yes
Determines the triggering extension (best effort). Switching it off saves a minimal amount of work per mail.
  
Body storage
  
    
Option
Default
Meaning
  
  
    
Storage mode
Metadata + first N KB
How much text is kept (see the chapter Body storage, encryption and sensitive content). Affects new entries only.
    
Body retention (days)
30
Only with "full, deleted automatically": after this period the task removes the text.
    
Body size to keep (KB)
4
Only with "metadata + first N KB": how many kilobytes from the start are stored.
    
Maximum body size (KB)
1024
Global ceiling. Larger bodies are truncated and marked.
    
Encryption key
—
Purely a status display. The key is derived from the Joomla secret; there is nothing to enter.
  
Raw MIME
  
    
Store raw MIME
No
Keep the exact RFC822 message (for clean .eml downloads). Off out of the box for privacy reasons.
    
Encrypt raw MIME
No
Apply the same encryption as for bodies to the MIME message.
  
Attachments
  
    
Capture attachments
Yes
Copy every attachment to disk while sending.
    
Storage path
empty (= safe default outside the web root)
Where the attachments are kept.
    
Max. per file (MB)
10
Larger attachments are skipped; the metadata remains.
    
Total storage budget (MB)
500
When exceeded, new attachments are skipped until the next cleanup.
  
Sensitive content
  
    
Handling of sensitive mails
Metadata only
How mails matching the subject patterns are treated: metadata only, normally, or not logged at all.
    
Subject patterns
/password/i, 
/passwort/i, 
/reset/i, 
/token/i, 
/2fa/i, 
/verify/i, 
/verifizier/i
One regular expression per line. If the subject matches, the mail counts as sensitive.
    
Body masking patterns
/token=…/, 
/key=…/
Matches are replaced by 
*** in the stored body.
  
Retention
  
    
Entry retention (days)
180
Older entries are removed by the task "clean up logs". 0 = no age-based cleanup.
    
Maximum number of entries
0 (off)
FIFO ceiling: the oldest entries are removed as soon as the limit is exceeded.
    
Attachment retention (days)
30
Older attachment files are removed by the attachment cleanup task.
  
Display rules
  
    
Match
All (AND)
Whether a row has to satisfy all or any of the rules to be hidden.
    
Rules
empty
Hide matching entries from the list and the statistics without deleting them. See the chapter Log rules and display rules.
  
Log rules
  
    
Match
Any (OR)
Whether a mail has to match all or any of the rules.
    
Mode
Exclude matches
Exclude matches, or include matches only.
    
Rules
empty
Decide before storing which mails are logged at all.
  
Notifications
  
    
Enable notifications
No
Warn when a delivery fails.
    
Notify super admins
Yes
To super users with system emails enabled.
    
Additional recipients
empty
Further addresses.
    
Throttle window (minutes)
30
Minimum gap between two alerts.
    
Also as a Joomla private message
No
File the alert internally (com_messages) as well.
  
Dashboard
  
    
Statistics mode
Live
Live calculates from the entries on every view. Task uses pre-aggregated daily figures maintained by the statistics task — faster with very many entries.
    
Default period
Last 30 days
Preset period of the chart.
    
Show latest mails
10
How many entries the dashboard lists show.
  
Permissions
The standard Joomla tab. Which action needs which permission is described in the chapter
Permissions, export and privacy.
Applies to version 1.0.5.
Deutsche Fassung