.Section 'admin'

`admin-mail-from`: `^\p{PosixPrint}{1,998}$` ('default =' `Proxmox Mail Gateway <postmaster>`)::

Text for 'From' header in admin mails and bounces.

`advfilter`: `<boolean>` ('default =' `0`)::

Enable advanced filters for statistic.
+
If this is enabled, the receiver statistic are limited to active ones
(receivers which also sent out mail in the 90 days before), and the contact
statistic will not contain these active receivers.

`avast`: `<boolean>` ('default =' `0`)::

Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.

`clamav`: `<boolean>` ('default =' `1`)::

Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.

`consent-text`: `<string>` ('default =' ``)::

Consent text that is displayed before logging in.

`custom_check`: `<boolean>` ('default =' `0`)::

Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.

`custom_check_path`: `<string>` ('default =' `/usr/local/bin/pmg-custom-check`)::

Absolute Path to the Custom Check Script

`dailyreport`: `<boolean>` ('default =' `1`)::

Send daily reports.

`demo`: `<boolean>` ('default =' `0`)::

Demo mode - do not start SMTP filter.

`dkim-use-domain`: `<envelope | header>` ('default =' `envelope`)::

Whether to sign using the domain found in the header or the envelope.

`dkim_selector`: `<string>` ::

Default DKIM selector

`dkim_sign`: `<boolean>` ('default =' `0`)::

DKIM sign outbound mails with the configured Selector.

`dkim_sign_all_mail`: `<boolean>` ('default =' `0`)::

DKIM sign all outgoing mails irrespective of the Envelope From domain.

`email`: `<string>` ('default =' `admin@domain.tld`)::

Administrator E-Mail address.

`http_proxy`: `http://.*` ::

Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')

`log-tracker-base`: `<string>` ('default =' `/var/log/syslog`)::

Location of rotated mail logs, input-base argument for pmg-log-tracker

`statlifetime`: `<integer> (1 - N)` ('default =' `7`)::

User Statistics Lifetime (days)

.Section 'clamav'

`archiveblockencrypted`: `<boolean>` ('default =' `0`)::

Whether to mark encrypted archives and documents as heuristic virus match. A match does not necessarily result in an immediate block, it just raises the Spam Score by 'clamav_heuristic_score'.

`archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::

Number of files to be scanned within an archive, a document, or any other kind of container. Warning: disabling this limit or setting it too high may result in severe damage to the system.

`archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::

Nested archives are scanned recursively, e.g. if a ZIP archive contains a TAR  file,  all files within it will also be scanned. This options specifies how deeply the process should be continued. Warning: setting this limit too high may result in severe damage to the system.

`archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::

Files larger than this limit (in bytes) won't be scanned.

`dbmirror`: `<string>` ('default =' `database.clamav.net`)::

ClamAV database mirror server.

`maxcccount`: `<integer> (0 - N)` ('default =' `0`)::

This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.

`maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::

Sets the maximum amount of data (in bytes) to be scanned for each input file.

`scriptedupdates`: `<boolean>` ('default =' `1`)::

Enables ScriptedUpdates (incremental download of signatures)

.Section 'mail'

`accept-broken-mime`: `<boolean>` ('default =' `0`)::

Accept e-mails with broken MIME structure (insecure). If enabled, a `X-Proxmox-Broken-Message` header is added to each mail with broken MIME structure.

`banner`: `<string>` ('default =' `ESMTP Proxmox`)::

ESMTP banner.

`before_queue_filtering`: `<boolean>` ('default =' `0`)::

Enable before queue filtering by pmg-smtp-filter

`conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::

How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.

`conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::

The maximal number of connection attempts any client is allowed to make to this service per minute. To disable this feature, specify a limit of 0.

`dnsbl_sites`: `<string>` ::

Optional list of DNS welcome/blocklist domains (postfix option `postscreen_dnsbl_sites`).

`dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::

The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (postfix option `postscreen_dnsbl_threshold`).

`dwarning`: `<integer> (0 - N)` ('default =' `4`)::

SMTP delay warning time (in hours). (postfix option `delay_warning_time`)

`ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::

SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.

`filter-timeout`: `<integer> (2 - 86400)` ('default =' `600`)::

Timeout for the processing of one mail (in seconds)  (postfix option `smtpd_proxy_timeout` and `lmtp_data_done_timeout`)

`greylist`: `<boolean>` ('default =' `1`)::

Use Greylisting for IPv4.

`greylist6`: `<boolean>` ('default =' `0`)::

Use Greylisting for IPv6.

`greylistmask4`: `<integer> (0 - 32)` ('default =' `24`)::

Netmask to apply for greylisting IPv4 hosts

`greylistmask6`: `<integer> (0 - 128)` ('default =' `64`)::

Netmask to apply for greylisting IPv6 hosts

`helotests`: `<boolean>` ('default =' `0`)::

Use SMTP HELO tests. (postfix option `smtpd_helo_restrictions`)

`hide_received`: `<boolean>` ('default =' `0`)::

Hide received header in outgoing mails.

`int_port`: `<integer> (1 - 65535)` ('default =' `26`)::

SMTP port number for outgoing mail (trusted).

`log-headers`: `<boolean>` ('default =' `0`)::

Log the envelope sender and recipient together with the decoded From, To, and Subject headers of each processed mail to the mail log. This eases auditing and tracing, but writes potentially personal data, such as mail subjects and addresses, to the host log. Make sure this is compatible with your data-protection obligations before enabling it.

`max_filters`: `<integer> (3 - 40)` ('default =' `38`)::

Maximum number of pmg-smtp-filter processes.

`max_policy`: `<integer> (2 - 10)` ('default =' `5`)::

Maximum number of pmgpolicy processes.

`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::

Maximum number of SMTP daemon processes (in).

`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::

Maximum number of SMTP daemon processes (out).

`maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::

Maximum email size. Larger mails are rejected. (postfix option `message_size_limit`)

`message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::

The maximal number of message delivery requests that any client is allowed to make to this service per minute.To disable this feature, specify a limit of 0.

`ndr_on_block`: `<boolean>` ('default =' `0`)::

Send out NDR when mail gets blocked

`queue-lifetime`: `<integer> (1 - 100)` ::

Maximum time (in days) a deferred message is kept in the queue before it is returned to the sender as undeliverable. Also applies to bounce (notification) messages. (postfix options `maximal_queue_lifetime` and `bounce_queue_lifetime`)

`rejectunknown`: `<boolean>` ('default =' `0`)::

Reject unknown clients. (postfix option `reject_unknown_client_hostname`)

`rejectunknownsender`: `<boolean>` ('default =' `0`)::

Reject unknown senders. (postfix option `reject_unknown_sender_domain`)

`relay`: `<string>` ::

The default mail delivery transport (incoming mails).

`relaynomx`: `<boolean>` ('default =' `0`)::

Disable MX lookups for default relay (SMTP only, ignored for LMTP).

`relayport`: `<integer> (1 - 65535)` ('default =' `25`)::

SMTP/LMTP port number for relay host.

`relayprotocol`: `<lmtp | smtp>` ('default =' `smtp`)::

Transport protocol for relay host.

`smarthost`: `<string>` ::

When set, all outgoing mails are delivered to the specified smarthost. (postfix option `default_transport`)

`smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::

SMTP port number for smarthost. (postfix option `default_transport`)

`smtputf8`: `<boolean>` ('default =' `1`)::

Enable SMTPUTF8 support in Postfix and detection for locally generated mail (postfix option `smtputf8_enable`)

`spf`: `<boolean>` ('default =' `1`)::

Use Sender Policy Framework.

`tls`: `<boolean>` ('default =' `0`)::

Enable TLS.

`tlsheader`: `<boolean>` ('default =' `0`)::

Add TLS received header.

`tlslog`: `<boolean>` ('default =' `0`)::

Enable TLS Logging.

`tlsprofile`: `<default | modern>` ('default =' `default`)::

TLS security profile for inbound SMTP.

`verifyreceivers`: `<450 | 550>` ::

Enable receiver verification. The value specifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)

.Section 'spam'

`bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::

Additional score for bounce mails.

`clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::

Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...).

`extract_text`: `<boolean>` ('default =' `0`)::

Extract text from attachments (doc, pdf, rtf, images) and scan for spam.

`languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::

This option is used to specify which languages are considered OK for incoming mail.

`maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::

Maximum size of spam messages in bytes.

`rbl_checks`: `<boolean>` ('default =' `1`)::

Enable real time blocklists (RBL) checks.

`use_awl`: `<boolean>` ('default =' `0`)::

Use the Auto-Welcomelist plugin.

`use_bayes`: `<boolean>` ('default =' `0`)::

Whether to use the naive-Bayesian-style classifier.

`use_razor`: `<boolean>` ('default =' `1`)::

Whether to use Razor2, if it is available.

`wl_bounce_relays`: `<string>` ::

Welcomelist legitimate bounce relays.

.Section 'spamquar'

`allowhrefs`: `<boolean>` ('default =' `1`)::

Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.

`authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::

Authentication mode to access the quarantine interface. Mode 'ticket' allows login using tickets sent with the daily spam report. Mode 'ldap' requires to login using an LDAP account. Finally, mode 'ldapticket' allows both ways.

`hostname`: `<string>` ::

Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.

`lifetime`: `<integer> (1 - N)` ('default =' `7`)::

Quarantine life time (days)

`listencert`: `<string>` ('default =' `/etc/pmg/pmg-api.pem`)::

Certificate the dedicated user quarantine daemon (pmgquarantineproxy) serves. Use a separate certificate when the public quarantine hostname differs from the management hostname. The file holds both certificate and key, like the default.

`listenport`: `<integer> (1 - 65535)` ('default =' `8007`)::

Port the dedicated user quarantine daemon (pmgquarantineproxy) listens on. That daemon serves only the quarantine interface, so the management API on port 8006 does not have to be exposed. It is not enabled by default; set LISTEN_IP in /etc/default/pmgquarantineproxy before enabling it. Set 'port' as well if the port users reach differs from this one.

`mailfrom`: `<string>` ::

Text for 'From' header in daily spam report mails.

`port`: `<integer> (1 - 65535)` ('default =' `8006`)::

Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.

`protocol`: `<http | https>` ('default =' `https`)::

Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.

`quarantinelink`: `<boolean>` ('default =' `0`)::

Enables user self-service for Quarantine Links. Caution: this is accessible without authentication

`reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::

Spam report style.

`viewimages`: `<0 | 1 | on-demand>` ('default =' `1`)::

Control how images in quarantined mails are displayed. '1' shows all images, including externally hosted ones; '0' hides all images; 'on-demand' shows only embedded images and lets the user load externally hosted ones manually (avoids leaking that a mail was opened).

.Section 'virusquar'

`allowhrefs`: `<boolean>` ('default =' `1`)::

Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.

`lifetime`: `<integer> (1 - N)` ('default =' `7`)::

Quarantine life time (days)

`viewimages`: `<0 | 1 | on-demand>` ('default =' `1`)::

Control how images in quarantined mails are displayed. '1' shows all images, including externally hosted ones; '0' hides all images; 'on-demand' shows only embedded images and lets the user load externally hosted ones manually (avoids leaking that a mail was opened).

