]> git.proxmox.com Git - pmg-docs.git/commitdiff
update static schema info
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Fri, 24 Mar 2023 09:28:58 +0000 (10:28 +0100)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Fri, 24 Mar 2023 09:28:58 +0000 (10:28 +0100)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
api-viewer/apidata.js
pmg.conf.5-opts.adoc
pmg.mail-options-conf-opts.adoc
pmg.spam-conf-opts.adoc
pmgconfig.1-synopsis.adoc

index a1662b0673fe61c850ac5aa925e89609aee40d61..242601c79f4d045357810cc4f9f2b4128c7c47f3 100644 (file)
@@ -7903,6 +7903,106 @@ var apiSchema = [
             "path" : "/config/tlspolicy",
             "text" : "tlspolicy"
          },
+         {
+            "children" : [
+               {
+                  "info" : {
+                     "DELETE" : {
+                        "allowtoken" : 1,
+                        "description" : "Delete a tls_inbound_domains entry",
+                        "method" : "DELETE",
+                        "name" : "delete",
+                        "parameters" : {
+                           "additionalProperties" : 0,
+                           "properties" : {
+                              "domain" : {
+                                 "description" : "Domain which should be removed from tls_inbound_domains",
+                                 "format" : "transport-domain",
+                                 "type" : "string",
+                                 "typetext" : "<string>"
+                              }
+                           }
+                        },
+                        "permissions" : {
+                           "check" : [
+                              "admin"
+                           ]
+                        },
+                        "protected" : 1,
+                        "proxyto" : "master",
+                        "returns" : {
+                           "type" : "null"
+                        }
+                     }
+                  },
+                  "leaf" : 1,
+                  "path" : "/config/tls-inbound-domains/{domain}",
+                  "text" : "{domain}"
+               }
+            ],
+            "info" : {
+               "GET" : {
+                  "allowtoken" : 1,
+                  "description" : "List tls_inbound_domains entries.",
+                  "method" : "GET",
+                  "name" : "index",
+                  "parameters" : {
+                     "additionalProperties" : 0
+                  },
+                  "permissions" : {
+                     "check" : [
+                        "admin",
+                        "audit"
+                     ]
+                  },
+                  "proxyto" : "master",
+                  "returns" : {
+                     "description" : "List of domains for which TLS will be enforced on incoming connections",
+                     "items" : {
+                        "format" : "transport-domain",
+                        "type" : "string"
+                     },
+                     "links" : [
+                        {
+                           "href" : "{domain}",
+                           "rel" : "child"
+                        }
+                     ],
+                     "type" : "array"
+                  }
+               },
+               "POST" : {
+                  "allowtoken" : 1,
+                  "description" : "Add new tls_inbound_domains entry.",
+                  "method" : "POST",
+                  "name" : "create",
+                  "parameters" : {
+                     "additionalProperties" : 0,
+                     "properties" : {
+                        "domain" : {
+                           "description" : "Domain for which TLS should be enforced on incoming connections",
+                           "format" : "transport-domain",
+                           "type" : "string",
+                           "typetext" : "<string>"
+                        }
+                     }
+                  },
+                  "permissions" : {
+                     "check" : [
+                        "admin"
+                     ]
+                  },
+                  "protected" : 1,
+                  "proxyto" : "master",
+                  "returns" : {
+                     "type" : "null"
+                  }
+               }
+            },
+            "leaf" : 0,
+            "path" : "/config/tls-inbound-domains",
+            "text" : "tls-inbound-domains"
+         },
          {
             "children" : [
                {
@@ -9086,20 +9186,24 @@ var apiSchema = [
                                           "aws",
                                           "azion",
                                           "azure",
+                                          "bunny",
                                           "cf",
                                           "clouddns",
                                           "cloudns",
                                           "cn",
                                           "conoha",
                                           "constellix",
-                                          "cx",
+                                          "cpanel",
+                                          "curanet",
                                           "cyon",
                                           "da",
                                           "ddnss",
                                           "desec",
                                           "df",
                                           "dgon",
+                                          "dnshome",
                                           "dnsimple",
+                                          "dnsservices",
                                           "do",
                                           "doapi",
                                           "domeneshop",
@@ -9115,11 +9219,12 @@ var apiSchema = [
                                           "edgedns",
                                           "euserv",
                                           "exoscale",
+                                          "fornex",
                                           "freedns",
                                           "gandi_livedns",
                                           "gcloud",
                                           "gd",
-                                          "gdnsdk",
+                                          "geoscaling",
                                           "he",
                                           "hetzner",
                                           "hexonet",
@@ -9137,6 +9242,7 @@ var apiSchema = [
                                           "kas",
                                           "kinghost",
                                           "knot",
+                                          "la",
                                           "leaseweb",
                                           "lexicon",
                                           "linode",
@@ -9150,6 +9256,7 @@ var apiSchema = [
                                           "myapi",
                                           "mydevil",
                                           "mydnsjp",
+                                          "mythic_beasts",
                                           "namecheap",
                                           "namecom",
                                           "namesilo",
@@ -9177,24 +9284,29 @@ var apiSchema = [
                                           "porkbun",
                                           "rackcorp",
                                           "rackspace",
+                                          "rage4",
                                           "rcode0",
                                           "regru",
                                           "scaleway",
                                           "schlundtech",
                                           "selectel",
+                                          "selfhost",
                                           "servercow",
                                           "simply",
                                           "tele3",
                                           "transip",
+                                          "udr",
                                           "ultra",
                                           "unoeuro",
                                           "variomedia",
                                           "veesp",
+                                          "vercel",
                                           "vscale",
                                           "vultr",
                                           "websupport",
                                           "world4you",
                                           "yandex",
+                                          "yc",
                                           "zilore",
                                           "zone",
                                           "zonomi"
@@ -9340,20 +9452,24 @@ var apiSchema = [
                                     "aws",
                                     "azion",
                                     "azure",
+                                    "bunny",
                                     "cf",
                                     "clouddns",
                                     "cloudns",
                                     "cn",
                                     "conoha",
                                     "constellix",
-                                    "cx",
+                                    "cpanel",
+                                    "curanet",
                                     "cyon",
                                     "da",
                                     "ddnss",
                                     "desec",
                                     "df",
                                     "dgon",
+                                    "dnshome",
                                     "dnsimple",
+                                    "dnsservices",
                                     "do",
                                     "doapi",
                                     "domeneshop",
@@ -9369,11 +9485,12 @@ var apiSchema = [
                                     "edgedns",
                                     "euserv",
                                     "exoscale",
+                                    "fornex",
                                     "freedns",
                                     "gandi_livedns",
                                     "gcloud",
                                     "gd",
-                                    "gdnsdk",
+                                    "geoscaling",
                                     "he",
                                     "hetzner",
                                     "hexonet",
@@ -9391,6 +9508,7 @@ var apiSchema = [
                                     "kas",
                                     "kinghost",
                                     "knot",
+                                    "la",
                                     "leaseweb",
                                     "lexicon",
                                     "linode",
@@ -9404,6 +9522,7 @@ var apiSchema = [
                                     "myapi",
                                     "mydevil",
                                     "mydnsjp",
+                                    "mythic_beasts",
                                     "namecheap",
                                     "namecom",
                                     "namesilo",
@@ -9431,24 +9550,29 @@ var apiSchema = [
                                     "porkbun",
                                     "rackcorp",
                                     "rackspace",
+                                    "rage4",
                                     "rcode0",
                                     "regru",
                                     "scaleway",
                                     "schlundtech",
                                     "selectel",
+                                    "selfhost",
                                     "servercow",
                                     "simply",
                                     "tele3",
                                     "transip",
+                                    "udr",
                                     "ultra",
                                     "unoeuro",
                                     "variomedia",
                                     "veesp",
+                                    "vercel",
                                     "vscale",
                                     "vultr",
                                     "websupport",
                                     "world4you",
                                     "yandex",
+                                    "yc",
                                     "zilore",
                                     "zone",
                                     "zonomi"
@@ -9935,10 +10059,10 @@ var apiSchema = [
                               "delete" : {
                                  "description" : "A list of settings you want to delete.",
                                  "enum" : [
+                                    "rp",
                                     "id",
                                     "origin",
-                                    "allow-subdomains",
-                                    "rp"
+                                    "allow-subdomains"
                                  ],
                                  "optional" : 1,
                                  "type" : "string"
@@ -10589,6 +10713,13 @@ var apiSchema = [
                            "type" : "integer",
                            "typetext" : "<integer> (1 - 65535)"
                         },
+                        "smtputf8" : {
+                           "default" : 1,
+                           "description" : "Enable SMTPUTF8 support in Postfix and detection for locally generated mail",
+                           "optional" : 1,
+                           "type" : "boolean",
+                           "typetext" : "<boolean>"
+                        },
                         "spf" : {
                            "default" : 1,
                            "description" : "Use Sender Policy Framework.",
@@ -10707,6 +10838,13 @@ var apiSchema = [
                            "type" : "string",
                            "typetext" : "<string>"
                         },
+                        "extract_text" : {
+                           "default" : 0,
+                           "description" : "Extract text from attachments (doc, pdf, rtf, images) and scan for spam.",
+                           "optional" : 1,
+                           "type" : "boolean",
+                           "typetext" : "<boolean>"
+                        },
                         "languages" : {
                            "default" : "all",
                            "description" : "This option is used to specify which languages are considered OK for incoming mail.",
@@ -17644,9 +17782,9 @@ var apiSchema = [
                            "default" : "spam",
                            "description" : "Query this type of quarantine for users.",
                            "enum" : [
-                              "attachment",
                               "virus",
-                              "spam"
+                              "spam",
+                              "attachment"
                            ],
                            "optional" : 1,
                            "type" : "string"
index e55a8b37523072d3016b257a8a2410b08cd739eb..f254e8b0071967703e73c0084b7d9cc8a2095674 100644 (file)
@@ -212,6 +212,10 @@ When set, all outgoing mails are deliverd to the specified smarthost.
 
 SMTP port number for smarthost.
 
+`smtputf8`: `<boolean>` ('default =' `1`)::
+
+Enable SMTPUTF8 support in Postfix and detection for locally generated mail
+
 `spf`: `<boolean>` ('default =' `1`)::
 
 Use Sender Policy Framework.
@@ -242,6 +246,10 @@ Additional score for bounce mails.
 
 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.
index 9e0859778cef2bac77495176a6da864ccb7f2b38..4baba7a4139e8d9911b706a914770e22b352553a 100644 (file)
@@ -70,6 +70,10 @@ Reject unknown clients.
 
 Reject unknown senders.
 
+`smtputf8`: `<boolean>` ('default =' `1`)::
+
+Enable SMTPUTF8 support in Postfix and detection for locally generated mail
+
 `spf`: `<boolean>` ('default =' `1`)::
 
 Use Sender Policy Framework.
index 349da1ad82ca47ad87e94364d9d8eb6604473cb1..70d32e2b5e1f1dc117ab604e7349efe1f15f875e 100644 (file)
@@ -6,6 +6,10 @@ Additional score for bounce mails.
 
 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.
index 168cb80de43f596ecd3a9350d1126d514a60c40f..cbd0604371798f5a3506e61c34cddb323732234a 100644 (file)
@@ -97,7 +97,7 @@ ACME challenge type.
 
 ACME Plugin ID name
 
-`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
+`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
 
 API plugin name
 
@@ -149,7 +149,7 @@ Update ACME plugin configuration.
 
 ACME Plugin ID name
 
-`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
+`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
 
 API plugin name