]> git.proxmox.com Git - pmg-docs.git/commitdiff
update static schema info
authorStoiko Ivanov <s.ivanov@proxmox.com>
Mon, 27 Mar 2023 12:40:15 +0000 (14:40 +0200)
committerStoiko Ivanov <s.ivanov@proxmox.com>
Mon, 27 Mar 2023 12:51:26 +0000 (14:51 +0200)
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
api-viewer/apidata.js
pmg.admin-conf-opts.adoc
pmg.conf.5-opts.adoc
pmg.mail-options-conf-opts.adoc
pmg.mail-relaying-conf-opts.adoc

index 242601c79f4d045357810cc4f9f2b4128c7c47f3..d7c2e11d04774d9bb69da1657dbb86afc1c99434 100644 (file)
@@ -10059,10 +10059,10 @@ var apiSchema = [
                               "delete" : {
                                  "description" : "A list of settings you want to delete.",
                                  "enum" : [
-                                    "rp",
                                     "id",
                                     "origin",
-                                    "allow-subdomains"
+                                    "allow-subdomains",
+                                    "rp"
                                  ],
                                  "optional" : 1,
                                  "type" : "string"
@@ -10174,10 +10174,11 @@ var apiSchema = [
                      "properties" : {
                         "advfilter" : {
                            "default" : 1,
-                           "description" : "Use advanced filters for statistic.",
+                           "description" : "Enable advanced filters for statistic.",
                            "optional" : 1,
                            "type" : "boolean",
-                           "typetext" : "<boolean>"
+                           "typetext" : "<boolean>",
+                           "verbose_description" : "Enable advanced filters for statistic.\n\nIf this is enabled, the receiver statistic are limited to active ones\n(receivers which also sent out mail in the 90 days before), and the contact\nstatistic will not contain these active receivers.\n"
                         },
                         "avast" : {
                            "default" : 0,
@@ -10505,7 +10506,7 @@ var apiSchema = [
                            "typetext" : "<string>"
                         },
                         "dnsbl_sites" : {
-                           "description" : "Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).",
+                           "description" : "Optional list of DNS white/blacklist domains (postfix option `postscreen_dnsbl_sites`).",
                            "format" : "dnsbl-entry-list",
                            "optional" : 1,
                            "type" : "string",
@@ -10513,7 +10514,7 @@ var apiSchema = [
                         },
                         "dnsbl_threshold" : {
                            "default" : 1,
-                           "description" : "The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).",
+                           "description" : "The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (postfix option `postscreen_dnsbl_threshold`).",
                            "minimum" : 0,
                            "optional" : 1,
                            "type" : "integer",
@@ -10521,7 +10522,7 @@ var apiSchema = [
                         },
                         "dwarning" : {
                            "default" : 4,
-                           "description" : "SMTP delay warning time (in hours).",
+                           "description" : "SMTP delay warning time (in hours). (postfix option `delay_warning_time`)",
                            "minimum" : 0,
                            "optional" : 1,
                            "type" : "integer",
@@ -10570,7 +10571,7 @@ var apiSchema = [
                         },
                         "helotests" : {
                            "default" : 0,
-                           "description" : "Use SMTP HELO tests.",
+                           "description" : "Use SMTP HELO tests. (postfix option `smtpd_helo_restrictions`)",
                            "optional" : 1,
                            "type" : "boolean",
                            "typetext" : "<boolean>"
@@ -10592,7 +10593,7 @@ var apiSchema = [
                            "typetext" : "<integer> (1 - 65535)"
                         },
                         "max_filters" : {
-                           "default" : 38,
+                           "default" : 31,
                            "description" : "Maximum number of pmg-smtp-filter processes.",
                            "maximum" : 40,
                            "minimum" : 3,
@@ -10629,7 +10630,7 @@ var apiSchema = [
                         },
                         "maxsize" : {
                            "default" : 10485760,
-                           "description" : "Maximum email size. Larger mails are rejected.",
+                           "description" : "Maximum email size. Larger mails are rejected. (postfix option `message_size_limit`)",
                            "minimum" : 1024,
                            "optional" : 1,
                            "type" : "integer",
@@ -10652,14 +10653,14 @@ var apiSchema = [
                         },
                         "rejectunknown" : {
                            "default" : 0,
-                           "description" : "Reject unknown clients.",
+                           "description" : "Reject unknown clients. (postfix option `reject_unknown_client_hostname`)",
                            "optional" : 1,
                            "type" : "boolean",
                            "typetext" : "<boolean>"
                         },
                         "rejectunknownsender" : {
                            "default" : 0,
-                           "description" : "Reject unknown senders.",
+                           "description" : "Reject unknown senders. (postfix option `reject_unknown_sender_domain`)",
                            "optional" : 1,
                            "type" : "boolean",
                            "typetext" : "<boolean>"
@@ -10698,7 +10699,7 @@ var apiSchema = [
                            "type" : "string"
                         },
                         "smarthost" : {
-                           "description" : "When set, all outgoing mails are deliverd to the specified smarthost.",
+                           "description" : "When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`)",
                            "format" : "address",
                            "optional" : 1,
                            "type" : "string",
@@ -10706,7 +10707,7 @@ var apiSchema = [
                         },
                         "smarthostport" : {
                            "default" : 25,
-                           "description" : "SMTP port number for smarthost.",
+                           "description" : "SMTP port number for smarthost. (postfix option `default_transport`)",
                            "maximum" : 65535,
                            "minimum" : 1,
                            "optional" : 1,
@@ -10715,7 +10716,7 @@ var apiSchema = [
                         },
                         "smtputf8" : {
                            "default" : 1,
-                           "description" : "Enable SMTPUTF8 support in Postfix and detection for locally generated mail",
+                           "description" : "Enable SMTPUTF8 support in Postfix and detection for locally generated mail (postfix option `smtputf8_enable`)",
                            "optional" : 1,
                            "type" : "boolean",
                            "typetext" : "<boolean>"
@@ -10749,7 +10750,7 @@ var apiSchema = [
                            "typetext" : "<boolean>"
                         },
                         "verifyreceivers" : {
-                           "description" : "Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.",
+                           "description" : "Enable receiver verification. The value spefifies 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`)",
                            "enum" : [
                               "450",
                               "550"
@@ -17782,9 +17783,9 @@ var apiSchema = [
                            "default" : "spam",
                            "description" : "Query this type of quarantine for users.",
                            "enum" : [
-                              "virus",
+                              "attachment",
                               "spam",
-                              "attachment"
+                              "virus"
                            ],
                            "optional" : 1,
                            "type" : "string"
index 03c83ce282bb9a5b85f6c5bd43f943b4c4e23a7d..dd42adb9d61d73e0040b3463981de5f7e94b3c17 100644 (file)
@@ -1,6 +1,10 @@
 `advfilter`: `<boolean>` ('default =' `1`)::
 
-Use advanced filters for statistic.
+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`)::
 
index f254e8b0071967703e73c0084b7d9cc8a2095674..33abfa98530aaef7765196392ce41c39573a5125 100644 (file)
@@ -2,7 +2,11 @@
 
 `advfilter`: `<boolean>` ('default =' `1`)::
 
-Use advanced filters for statistic.
+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`)::
 
@@ -110,15 +114,15 @@ The maximal number of connection attempts any client is allowed to make to this
 
 `dnsbl_sites`: `<string>` ::
 
-Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
+Optional list of DNS white/blacklist 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 (see postscreen_dnsbl_threshold parameter).
+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).
+SMTP delay warning time (in hours). (postfix option `delay_warning_time`)
 
 `ext_port`: `<integer> (1 - 65535)` ('default =' `25`)::
 
@@ -142,7 +146,7 @@ Netmask to apply for greylisting IPv6 hosts
 
 `helotests`: `<boolean>` ('default =' `0`)::
 
-Use SMTP HELO tests.
+Use SMTP HELO tests. (postfix option `smtpd_helo_restrictions`)
 
 `hide_received`: `<boolean>` ('default =' `0`)::
 
@@ -152,7 +156,7 @@ Hide received header in outgoing mails.
 
 SMTP port number for outgoing mail (trusted).
 
-`max_filters`: `<integer> (3 - 40)` ('default =' `38`)::
+`max_filters`: `<integer> (3 - 40)` ('default =' `31`)::
 
 Maximum number of pmg-smtp-filter processes.
 
@@ -170,7 +174,7 @@ Maximum number of SMTP daemon processes (out).
 
 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
 
-Maximum email size. Larger mails are rejected.
+Maximum email size. Larger mails are rejected. (postfix option `message_size_limit`)
 
 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
 
@@ -182,11 +186,11 @@ Send out NDR when mail gets blocked
 
 `rejectunknown`: `<boolean>` ('default =' `0`)::
 
-Reject unknown clients.
+Reject unknown clients. (postfix option `reject_unknown_client_hostname`)
 
 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
 
-Reject unknown senders.
+Reject unknown senders. (postfix option `reject_unknown_sender_domain`)
 
 `relay`: `<string>` ::
 
@@ -206,15 +210,15 @@ Transport protocol for relay host.
 
 `smarthost`: `<string>` ::
 
-When set, all outgoing mails are deliverd to the specified smarthost.
+When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`)
 
 `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
 
-SMTP port number for smarthost.
+SMTP port number for smarthost. (postfix option `default_transport`)
 
 `smtputf8`: `<boolean>` ('default =' `1`)::
 
-Enable SMTPUTF8 support in Postfix and detection for locally generated mail
+Enable SMTPUTF8 support in Postfix and detection for locally generated mail (postfix option `smtputf8_enable`)
 
 `spf`: `<boolean>` ('default =' `1`)::
 
@@ -234,7 +238,7 @@ Enable TLS Logging.
 
 `verifyreceivers`: `<450 | 550>` ::
 
-Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
+Enable receiver verification. The value spefifies 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'
 
index 4baba7a4139e8d9911b706a914770e22b352553a..4e8deb8cec39eba6224a183b777c231289b24ff6 100644 (file)
@@ -16,15 +16,15 @@ The maximal number of connection attempts any client is allowed to make to this
 
 `dnsbl_sites`: `<string>` ::
 
-Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).
+Optional list of DNS white/blacklist 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 (see postscreen_dnsbl_threshold parameter).
+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).
+SMTP delay warning time (in hours). (postfix option `delay_warning_time`)
 
 `greylist`: `<boolean>` ('default =' `1`)::
 
@@ -44,7 +44,7 @@ Netmask to apply for greylisting IPv6 hosts
 
 `helotests`: `<boolean>` ('default =' `0`)::
 
-Use SMTP HELO tests.
+Use SMTP HELO tests. (postfix option `smtpd_helo_restrictions`)
 
 `hide_received`: `<boolean>` ('default =' `0`)::
 
@@ -52,7 +52,7 @@ Hide received header in outgoing mails.
 
 `maxsize`: `<integer> (1024 - N)` ('default =' `10485760`)::
 
-Maximum email size. Larger mails are rejected.
+Maximum email size. Larger mails are rejected. (postfix option `message_size_limit`)
 
 `message_rate_limit`: `<integer> (0 - N)` ('default =' `0`)::
 
@@ -64,15 +64,15 @@ Send out NDR when mail gets blocked
 
 `rejectunknown`: `<boolean>` ('default =' `0`)::
 
-Reject unknown clients.
+Reject unknown clients. (postfix option `reject_unknown_client_hostname`)
 
 `rejectunknownsender`: `<boolean>` ('default =' `0`)::
 
-Reject unknown senders.
+Reject unknown senders. (postfix option `reject_unknown_sender_domain`)
 
 `smtputf8`: `<boolean>` ('default =' `1`)::
 
-Enable SMTPUTF8 support in Postfix and detection for locally generated mail
+Enable SMTPUTF8 support in Postfix and detection for locally generated mail (postfix option `smtputf8_enable`)
 
 `spf`: `<boolean>` ('default =' `1`)::
 
@@ -80,5 +80,5 @@ Use Sender Policy Framework.
 
 `verifyreceivers`: `<450 | 550>` ::
 
-Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.
+Enable receiver verification. The value spefifies 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`)
 
index 7a03a052bc5c479c22182ebf1d68fccf8aba40c8..f9627f55d0f57b0f78346ea1dedaabbc42f7cf3c 100644 (file)
@@ -16,9 +16,9 @@ Transport protocol for relay host.
 
 `smarthost`: `<string>` ::
 
-When set, all outgoing mails are deliverd to the specified smarthost.
+When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`)
 
 `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
 
-SMTP port number for smarthost.
+SMTP port number for smarthost. (postfix option `default_transport`)