From fe96611eac23abae3fd3e1fa69155e4efddc6547 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Sat, 22 Feb 2025 18:22:02 +0100 Subject: [PATCH] update static schema info Signed-off-by: Thomas Lamprecht --- api-viewer/apidata.js | 88 ++++++++++++++++++++++++++------ pmg.admin-conf-opts.adoc | 2 +- pmg.admin-dkim-conf-opts.adoc | 4 ++ pmg.conf.5-opts.adoc | 8 +-- pmg.mail-relaying-conf-opts.adoc | 2 +- pmg.spamquar-conf-opts.adoc | 2 +- pmg.virusquar-conf-opts.adoc | 2 +- pmgconfig.1-synopsis.adoc | 4 +- pmgreport.1-synopsis.adoc | 2 +- 9 files changed, 88 insertions(+), 26 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index f218461..adf8825 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -2131,6 +2131,13 @@ var apiSchema = [ "description" : "Object Groups ID.", "type" : "integer", "typetext" : "" + }, + "only-content" : { + "default" : 0, + "description" : "use content-type from scanning only (ignore filename and header)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, @@ -2170,6 +2177,13 @@ var apiSchema = [ "description" : "Object Groups ID.", "type" : "integer", "typetext" : "" + }, + "only-content" : { + "default" : 0, + "description" : "use content-type from scanning only (ignore filename and header)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, @@ -2254,6 +2268,13 @@ var apiSchema = [ "type" : "integer", "typetext" : "" }, + "top-part-only" : { + "default" : 0, + "description" : "only match the headers in the first MIME-Part", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "value" : { "description" : "The Value", "maxLength" : 1024, @@ -2299,6 +2320,13 @@ var apiSchema = [ "type" : "integer", "typetext" : "" }, + "top-part-only" : { + "default" : 0, + "description" : "only match the headers in the first MIME-Part", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "value" : { "description" : "The Value", "maxLength" : 1024, @@ -2509,6 +2537,13 @@ var apiSchema = [ "description" : "Object Groups ID.", "type" : "integer", "typetext" : "" + }, + "only-content" : { + "default" : 0, + "description" : "use content-type from scanning only (ignore filename and header)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, @@ -2548,6 +2583,13 @@ var apiSchema = [ "description" : "Object Groups ID.", "type" : "integer", "typetext" : "" + }, + "only-content" : { + "default" : 0, + "description" : "use content-type from scanning only (ignore filename and header)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, @@ -9435,6 +9477,7 @@ var apiSchema = [ "active24", "ad", "ali", + "alviy", "anx", "artfiles", "arvan", @@ -9463,7 +9506,6 @@ var apiSchema = [ "dnshome", "dnsimple", "dnsservices", - "do", "doapi", "domeneshop", "dp", @@ -9496,6 +9538,7 @@ var apiSchema = [ "internetbs", "inwx", "ionos", + "ionos_cloud", "ipv64", "ispconfig", "jd", @@ -9507,6 +9550,7 @@ var apiSchema = [ "la", "leaseweb", "lexicon", + "limacity", "linode", "linode_v4", "loopia", @@ -9535,6 +9579,7 @@ var apiSchema = [ "nsupdate", "nw", "oci", + "omglol", "one", "online", "openprovider", @@ -9556,8 +9601,10 @@ var apiSchema = [ "selfhost", "servercow", "simply", + "technitium", "tele3", "tencent", + "timeweb", "transip", "udr", "ultra", @@ -9568,11 +9615,13 @@ var apiSchema = [ "vscale", "vultr", "websupport", + "west_cn", "world4you", - "yandex", + "yandex360", "yc", "zilore", "zone", + "zoneedit", "zonomi" ], "optional" : 1, @@ -9709,6 +9758,7 @@ var apiSchema = [ "active24", "ad", "ali", + "alviy", "anx", "artfiles", "arvan", @@ -9737,7 +9787,6 @@ var apiSchema = [ "dnshome", "dnsimple", "dnsservices", - "do", "doapi", "domeneshop", "dp", @@ -9770,6 +9819,7 @@ var apiSchema = [ "internetbs", "inwx", "ionos", + "ionos_cloud", "ipv64", "ispconfig", "jd", @@ -9781,6 +9831,7 @@ var apiSchema = [ "la", "leaseweb", "lexicon", + "limacity", "linode", "linode_v4", "loopia", @@ -9809,6 +9860,7 @@ var apiSchema = [ "nsupdate", "nw", "oci", + "omglol", "one", "online", "openprovider", @@ -9830,8 +9882,10 @@ var apiSchema = [ "selfhost", "servercow", "simply", + "technitium", "tele3", "tencent", + "timeweb", "transip", "udr", "ultra", @@ -9842,11 +9896,13 @@ var apiSchema = [ "vscale", "vultr", "websupport", + "west_cn", "world4you", - "yandex", + "yandex360", "yc", "zilore", "zone", + "zoneedit", "zonomi" ], "optional" : 1, @@ -10582,7 +10638,7 @@ var apiSchema = [ }, "dkim-use-domain" : { "default" : "envelope", - "description" : "Whether to sign using the address from the header or the envelope.", + "description" : "Whether to sign using the domain found in the header or the envelope.", "enum" : [ "header", "envelope" @@ -11061,7 +11117,7 @@ var apiSchema = [ "type" : "string" }, "smarthost" : { - "description" : "When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`)", + "description" : "When set, all outgoing mails are delivered to the specified smarthost. (postfix option `default_transport`)", "format" : "address", "optional" : 1, "type" : "string", @@ -11307,7 +11363,7 @@ var apiSchema = [ "properties" : { "allowhrefs" : { "default" : 1, - "description" : "Allow to view hyperlinks.", + "description" : "Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -11454,7 +11510,7 @@ var apiSchema = [ "properties" : { "allowhrefs" : { "default" : 1, - "description" : "Allow to view hyperlinks.", + "description" : "Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -13043,6 +13099,7 @@ var apiSchema = [ "GET" : { "allowtoken" : 1, "description" : "Read task log.", + "download_allowed" : 1, "method" : "GET", "name" : "read_task_log", "parameters" : { @@ -14702,7 +14759,7 @@ var apiSchema = [ "GET" : { "allowtoken" : 1, "description" : "Download a backup file.", - "download" : 1, + "download_allowed" : 1, "method" : "GET", "name" : "download", "parameters" : { @@ -14731,7 +14788,7 @@ var apiSchema = [ "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "string" + "type" : "object" } }, "POST" : { @@ -16454,6 +16511,7 @@ var apiSchema = [ "GET" : { "allowtoken" : 1, "description" : "Read Journal", + "download_allowed" : 1, "method" : "GET", "name" : "journal", "parameters" : { @@ -18886,7 +18944,7 @@ var apiSchema = [ "GET" : { "allowtoken" : 1, "description" : "Download E-Mail or Attachment from Quarantine.", - "download" : 1, + "download_allowed" : 1, "method" : "GET", "name" : "download", "parameters" : { @@ -19664,7 +19722,7 @@ var apiSchema = [ "type" : "number" }, "pregreet_rejects" : { - "description" : "PREGREET recject count.", + "description" : "PREGREET reject count.", "type" : "integer" }, "rbl_rejects" : { @@ -19956,7 +20014,7 @@ var apiSchema = [ "type" : "integer" }, "pregreet_rejects" : { - "description" : "PREGREET recject count.", + "description" : "PREGREET reject count.", "type" : "integer" }, "rbl_rejects" : { @@ -20341,11 +20399,11 @@ var apiSchema = [ "type" : "integer" }, "pregreet_rejects" : { - "description" : "PREGREET recject count.", + "description" : "PREGREET reject count.", "type" : "integer" }, "rbl_rejects" : { - "description" : "RBL recject count.", + "description" : "RBL reject count.", "type" : "integer" }, "time" : { diff --git a/pmg.admin-conf-opts.adoc b/pmg.admin-conf-opts.adoc index 2357284..a0beb10 100644 --- a/pmg.admin-conf-opts.adoc +++ b/pmg.admin-conf-opts.adoc @@ -32,7 +32,7 @@ Demo mode - do not start SMTP filter. `dkim-use-domain`: `` ('default =' `envelope`):: -Whether to sign using the address from the header or the envelope. +Whether to sign using the domain found in the header or the envelope. `dkim_selector`: `` :: diff --git a/pmg.admin-dkim-conf-opts.adoc b/pmg.admin-dkim-conf-opts.adoc index f81d756..13141ee 100644 --- a/pmg.admin-dkim-conf-opts.adoc +++ b/pmg.admin-dkim-conf-opts.adoc @@ -1,3 +1,7 @@ +`dkim-use-domain`: `` ('default =' `envelope`):: + +Whether to sign using the domain found in the header or the envelope. + `dkim_selector`: `` :: Default DKIM selector diff --git a/pmg.conf.5-opts.adoc b/pmg.conf.5-opts.adoc index 4c83177..07e3ae9 100644 --- a/pmg.conf.5-opts.adoc +++ b/pmg.conf.5-opts.adoc @@ -34,7 +34,7 @@ Demo mode - do not start SMTP filter. `dkim-use-domain`: `` ('default =' `envelope`):: -Whether to sign using the address from the header or the envelope. +Whether to sign using the domain found in the header or the envelope. `dkim_selector`: `` :: @@ -218,7 +218,7 @@ Transport protocol for relay host. `smarthost`: `` :: -When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`) +When set, all outgoing mails are delivered to the specified smarthost. (postfix option `default_transport`) `smarthostport`: ` (1 - 65535)` ('default =' `25`):: @@ -294,7 +294,7 @@ Whitelist legitimate bounce relays. `allowhrefs`: `` ('default =' `1`):: -Allow to view hyperlinks. +Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text. `authmode`: `` ('default =' `ticket`):: @@ -336,7 +336,7 @@ Allow to view images. `allowhrefs`: `` ('default =' `1`):: -Allow to view hyperlinks. +Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text. `lifetime`: ` (1 - N)` ('default =' `7`):: diff --git a/pmg.mail-relaying-conf-opts.adoc b/pmg.mail-relaying-conf-opts.adoc index f9627f5..95849e1 100644 --- a/pmg.mail-relaying-conf-opts.adoc +++ b/pmg.mail-relaying-conf-opts.adoc @@ -16,7 +16,7 @@ Transport protocol for relay host. `smarthost`: `` :: -When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`) +When set, all outgoing mails are delivered to the specified smarthost. (postfix option `default_transport`) `smarthostport`: ` (1 - 65535)` ('default =' `25`):: diff --git a/pmg.spamquar-conf-opts.adoc b/pmg.spamquar-conf-opts.adoc index 0fdb686..9c9d597 100644 --- a/pmg.spamquar-conf-opts.adoc +++ b/pmg.spamquar-conf-opts.adoc @@ -1,6 +1,6 @@ `allowhrefs`: `` ('default =' `1`):: -Allow to view hyperlinks. +Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text. `authmode`: `` ('default =' `ticket`):: diff --git a/pmg.virusquar-conf-opts.adoc b/pmg.virusquar-conf-opts.adoc index 8f534b4..4c07d84 100644 --- a/pmg.virusquar-conf-opts.adoc +++ b/pmg.virusquar-conf-opts.adoc @@ -1,6 +1,6 @@ `allowhrefs`: `` ('default =' `1`):: -Allow to view hyperlinks. +Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text. `lifetime`: ` (1 - N)` ('default =' `7`):: diff --git a/pmgconfig.1-synopsis.adoc b/pmgconfig.1-synopsis.adoc index a6712d7..02f4b30 100644 --- a/pmgconfig.1-synopsis.adoc +++ b/pmgconfig.1-synopsis.adoc @@ -97,7 +97,7 @@ ACME challenge type. ACME Plugin ID name -`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | 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 | nanelo | 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 | tencent | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: +`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | alviy | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ionos_cloud | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | limacity | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | omglol | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | technitium | tele3 | tencent | timeweb | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | west_cn | world4you | yandex360 | yc | zilore | zone | zoneedit | zonomi>` :: API plugin name @@ -149,7 +149,7 @@ Update ACME plugin configuration. ACME Plugin ID name -`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | 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 | nanelo | 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 | tencent | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: +`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | alviy | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ionos_cloud | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | limacity | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | omglol | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | technitium | tele3 | tencent | timeweb | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | west_cn | world4you | yandex360 | yc | zilore | zone | zoneedit | zonomi>` :: API plugin name diff --git a/pmgreport.1-synopsis.adoc b/pmgreport.1-synopsis.adoc index b124607..d2d99bf 100644 --- a/pmgreport.1-synopsis.adoc +++ b/pmgreport.1-synopsis.adoc @@ -14,7 +14,7 @@ Debug mode. Print raw email to stdout instead of sending them. `--receiver` `` :: -Send report to this email address. Default is the administratior email address. +Send report to this email address. Default is the administrator email address. `--timespan` `` ('default =' `today`)::