pmg.conf.5-opts.adoc

   1 .Section 'admin'
   2
   3 `advfilter`: `<boolean>` ('default =' `1`)::
   4
   5 Use advanced filters for statistic.
   6
   7 `avast`: `<boolean>` ('default =' `0`)::
   8
   9 Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.
  10
  11 `clamav`: `<boolean>` ('default =' `1`)::
  12
  13 Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.
  14
  15 `custom_check`: `<boolean>` ('default =' `0`)::
  16
  17 Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.
  18
  19 `custom_check_path`: `^/([^/\0]+\/)+[^/\0]+$` ('default =' `/usr/local/bin/pmg-custom-check`)::
  20
  21 Absolute Path to the Custom Check Script
  22
  23 `dailyreport`: `<boolean>` ('default =' `1`)::
  24
  25 Send daily reports.
  26
  27 `demo`: `<boolean>` ('default =' `0`)::
  28
  29 Demo mode - do not start SMTP filter.
  30
  31 `dkim_selector`: `<string>` ::
  32
  33 Default DKIM selector
  34
  35 `dkim_sign`: `<boolean>` ('default =' `0`)::
  36
  37 DKIM sign outbound mails with the configured Selector.
  38
  39 `dkim_sign_all_mail`: `<boolean>` ('default =' `0`)::
  40
  41 DKIM sign all outgoing mails irrespective of the Envelope From domain.
  42
  43 `email`: `<string>` ('default =' `admin@domain.tld`)::
  44
  45 Administrator E-Mail address.
  46
  47 `http_proxy`: `http://.*` ::
  48
  49 Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
  50
  51 `statlifetime`: `<integer> (1 - N)` ('default =' `7`)::
  52
  53 User Statistics Lifetime (days)
  54
  55 .Section 'clamav'
  56
  57 `archiveblockencrypted`: `<boolean>` ('default =' `0`)::
  58
  59 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'.
  60
  61 `archivemaxfiles`: `<integer> (0 - N)` ('default =' `1000`)::
  62
  63 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.
  64
  65 `archivemaxrec`: `<integer> (1 - N)` ('default =' `5`)::
  66
  67 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.
  68
  69 `archivemaxsize`: `<integer> (1000000 - N)` ('default =' `25000000`)::
  70
  71 Files larger than this limit (in bytes) won't be scanned.
  72
  73 `dbmirror`: `<string>` ('default =' `database.clamav.net`)::
  74
  75 ClamAV database mirror server.
  76
  77 `maxcccount`: `<integer> (0 - N)` ('default =' `0`)::
  78
  79 This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.
  80
  81 `maxscansize`: `<integer> (1000000 - N)` ('default =' `100000000`)::
  82
  83 Sets the maximum amount of data (in bytes) to be scanned for each input file.
  84
  85 `safebrowsing`: `<boolean>` ('default =' `1`)::
  86
  87 Enables support for Google Safe Browsing.
  88
  89 .Section 'mail'
  90
  91 `banner`: `<string>` ('default =' `ESMTP Proxmox`)::
  92
  93 ESMTP banner.
  94
  95 `before_queue_filtering`: `<boolean>` ('default =' `0`)::
  96
  97 Enable before queue filtering by pmg-smtp-filter
  98
  99 `conn_count_limit`: `<integer> (0 - N)` ('default =' `50`)::
 100
 101 How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.
 102
 103 `conn_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
 104
 105 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.
 106
 107 `dnsbl_sites`: `<string>` ::
 108
 109 Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
 110
 111 `dnsbl_threshold`: `<integer> (0 - N)` ('default =' `1`)::
 112
 113 The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).
 114
 115 `dwarning`: `<integer> (0 - N)` ('default =' `4`)::
 116
 117 SMTP delay warning time (in hours).
 118
 119 `ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
 120
 121 SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
 122
 123 `greylist`: `<boolean>` ('default =' `1`)::
 124
 125 Use Greylisting.
 126
 127 `helotests`: `<boolean>` ('default =' `0`)::
 128
 129 Use SMTP HELO tests.
 130
 131 `hide_received`: `<boolean>` ('default =' `0`)::
 132
 133 Hide received header in outgoing mails.
 134
 135 `int_port`: `<integer> (1 - 65535)` ('default =' `26`)::
 136
 137 SMTP port number for outgoing mail (trusted).
 138
 139 `max_filters`: `<integer> (3 - 40)` ('default =' `35`)::
 140
 141 Maximum number of pmg-smtp-filter processes.
 142
 143 `max_policy`: `<integer> (2 - 10)` ('default =' `5`)::
 144
 145 Maximum number of pmgpolicy processes.
 146
 147 `max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::
 148
 149 Maximum number of SMTP daemon processes (in).
 150
 151 `max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::
 152
 153 Maximum number of SMTP daemon processes (out).
 154
 155 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
 156
 157 Maximum email size. Larger mails are rejected.
 158
 159 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
 160
 161 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.
 162
 163 `ndr_on_block`: `<boolean>` ('default =' `0`)::
 164
 165 Send out NDR when mail gets blocked
 166
 167 `rejectunknown`: `<boolean>` ('default =' `0`)::
 168
 169 Reject unknown clients.
 170
 171 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
 172
 173 Reject unknown senders.
 174
 175 `relay`: `<string>` ::
 176
 177 The default mail delivery transport (incoming mails).
 178
 179 `relaynomx`: `<boolean>` ('default =' `0`)::
 180
 181 Disable MX lookups for default relay.
 182
 183 `relayport`: `<integer> (1 - 65535)` ('default =' `25`)::
 184
 185 SMTP port number for relay host.
 186
 187 `smarthost`: `<string>` ::
 188
 189 When set, all outgoing mails are deliverd to the specified smarthost.
 190
 191 `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
 192
 193 SMTP port number for smarthost.
 194
 195 `spf`: `<boolean>` ('default =' `1`)::
 196
 197 Use Sender Policy Framework.
 198
 199 `tls`: `<boolean>` ('default =' `0`)::
 200
 201 Enable TLS.
 202
 203 `tlsheader`: `<boolean>` ('default =' `0`)::
 204
 205 Add TLS received header.
 206
 207 `tlslog`: `<boolean>` ('default =' `0`)::
 208
 209 Enable TLS Logging.
 210
 211 `verifyreceivers`: `<450 | 550>` ::
 212
 213 Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
 214
 215 .Section 'spam'
 216
 217 `bounce_score`: `<integer> (0 - 1000)` ('default =' `0`)::
 218
 219 Additional score for bounce mails.
 220
 221 `clamav_heuristic_score`: `<integer> (0 - 1000)` ('default =' `3`)::
 222
 223 Score for ClamAV heuristics (Encrypted Archives/Documents, Google Safe Browsing database, PhishingScanURLs, ...).
 224
 225 `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
 226
 227 This option is used to specify which languages are considered OK for incoming mail.
 228
 229 `maxspamsize`: `<integer> (64 - N)` ('default =' `262144`)::
 230
 231 Maximum size of spam messages in bytes.
 232
 233 `rbl_checks`: `<boolean>` ('default =' `1`)::
 234
 235 Enable real time blacklists (RBL) checks.
 236
 237 `use_awl`: `<boolean>` ('default =' `1`)::
 238
 239 Use the Auto-Whitelist plugin.
 240
 241 `use_bayes`: `<boolean>` ('default =' `1`)::
 242
 243 Whether to use the naive-Bayesian-style classifier.
 244
 245 `use_razor`: `<boolean>` ('default =' `1`)::
 246
 247 Whether to use Razor2, if it is available.
 248
 249 `wl_bounce_relays`: `<string>` ::
 250
 251 Whitelist legitimate bounce relays.
 252
 253 .Section 'spamquar'
 254
 255 `allowhrefs`: `<boolean>` ('default =' `1`)::
 256
 257 Allow to view hyperlinks.
 258
 259 `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
 260
 261 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.
 262
 263 `hostname`: `<string>` ::
 264
 265 Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.
 266
 267 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 268
 269 Quarantine life time (days)
 270
 271 `mailfrom`: `<string>` ::
 272
 273 Text for 'From' header in daily spam report mails.
 274
 275 `port`: `<integer> (1 - 65535)` ('default =' `8006`)::
 276
 277 Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.
 278
 279 `protocol`: `<http | https>` ('default =' `https`)::
 280
 281 Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.
 282
 283 `reportstyle`: `<custom | none | short | verbose>` ('default =' `verbose`)::
 284
 285 Spam report style.
 286
 287 `viewimages`: `<boolean>` ('default =' `1`)::
 288
 289 Allow to view images.
 290
 291 .Section 'virusquar'
 292
 293 `allowhrefs`: `<boolean>` ('default =' `1`)::
 294
 295 Allow to view hyperlinks.
 296
 297 `lifetime`: `<integer> (1 - N)` ('default =' `7`)::
 298
 299 Quarantine life time (days)
 300
 301 `viewimages`: `<boolean>` ('default =' `1`)::
 302
 303 Allow to view images.
 304