Skip to content

Settings

MSFE-NG edited this page Sep 30, 2026 · 5 revisions

Settings

Settings

Global scanning policy

The server-wide defaults; account owners can override most of them per domain in the end-user panel. Save & apply regenerates the MailScanner rule files and reloads the scanner only if something changed.

Field Meaning
High / Low spam score SpamAssassin thresholds for high spam and spam
Scan for spam / viruses master switches
Low-spam / High-spam action deliver, delete, spambox (Junk folder) or forward
Deliver disinfected pass on messages ClamAV could clean
Store copies (quarantine) keep held mail on disk so it can be reviewed and released
Keep a copy of every message archive all mail (not only held mail) so Messages can show and re-send it — see below
Keep message log for (days) retention of log rows (scores, reports, headers); pruned nightly
Keep message bodies for (days) retention of stored copies; 0 = forever

What is stored

The line under the card tells you exactly what is on disk: whether full copies are kept and where (archive_dir, default /var/spool/MailScanner/archive, laid out as <YYYYMMDD>/<message-id>), the retention, the current volume (messages/day × average size), the projected size and the free disk.

Copies are the largest thing MSFE-NG stores, and archiving everyone's mail can carry legal obligations — keep the retention as short as is useful and use the per-domain opt-out (archive=no in /etc/msfe-ng/policy/domains/<domain>.txt) where it is not wanted.

Interface & release

Stored in /etc/msfe-ng/config.toml.

Field Meaning
Messages auto-refresh (seconds) 0 = off; otherwise the Messages list reloads on that interval
Rows per page message list page size
Open message details in a new window otherwise the message view replaces the list (deep-linkable as #msg=<id>)
Reclassify the database on Learn as ham/spam training Bayes also flips the message's spam flag in the log
Release (forward) subject / intro line applied when releasing with forward
Release from address envelope sender for released mail; blank = postmaster@<host>
SpamCop reporting address enables the Report to SpamCop button in the message view
Default reason when blocking an IP pre-fills the csf comment in the IP modal

The AbuseIPDB API key, for reporting an address from the client-IP view, sits with the Telegram settings in the Config tab (abuseipdb_key; a secret — the API only says whether it is set).

Message footers

MailScanner can write into the body of the mail it delivers:

Directive What it adds
Sign Clean Messages the "This message has been scanned for viruses and dangerous content by MailScanner, and is believed to be clean" footer on clean mail
Mark Unscanned Messages a note on mail it did not scan
Mark Infected Messages an inline warning where it removed an attachment

The card shows, for each directive:

  • whether it is on;
  • its value;
  • the file it is set in. MailScanner reads MailScanner.conf and then conf.d/*.conf, and the last one wins; engine default means it is not set anywhere.

It also shows the footer text now in use.

Remove footers sets each active directive to no on the line where it takes effect. That can be a conf.d file, and a ruleset value such as %rules-dir%/sign.rules is replaced too. After that, new mail is delivered as it was sent. The change goes through the same checked save as the Config tab: MailScanner --lint, a history copy of every file, and one restart. If the lint fails, nothing is written.

What is not affected:

  • subject tags ({Spam?}, {Filename?});
  • the X-…-MailScanner headers;
  • the warning attachment for a removed file;
  • mail already delivered, which keeps its footer.

The backup. Before switching off, the exact lines that were there are saved, or the fact that there were none, together with a copy of every footer template (Inline Text/HTML Signature, Inline Text/HTML Warning, in every language directory). Backups live in /etc/msfe-ng/footers/<date-time>/, so msfe-ng backup and snapshots include them. The last 10 are kept.

Put back restores one backup:

  • each line becomes what it was;
  • a directive that was not set is removed again, so the engine default applies;
  • any footer text changed since is restored too.

A line edited by hand in the meantime is left alone, and the output says so. The files come back byte for byte.

From the command line:

msfe-ng footers status [--json]          what is on, where, and the templates
msfe-ng footers off [--dry-run]          back up, then switch every body insertion off
msfe-ng footers restore [<backup>]       put a backup back (default: the latest applied one)
msfe-ng footers backups                  list the backups

Clone this wiki locally