From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 4302190A42 for ; Fri, 24 Mar 2023 14:30:15 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 2C765BE7B for ; Fri, 24 Mar 2023 14:30:15 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Fri, 24 Mar 2023 14:30:14 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 2B1A546891 for ; Fri, 24 Mar 2023 14:30:14 +0100 (CET) From: Dominik Csapak To: pmg-devel@lists.proxmox.com Date: Fri, 24 Mar 2023 14:30:11 +0100 Message-Id: <20230324133013.2862297-2-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230324133013.2862297-1-d.csapak@proxmox.com> References: <20230324133013.2862297-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.010 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pmg-devel] [PATCH pmg-api 1/1] config: extend documentation for options a bit X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 24 Mar 2023 13:30:15 -0000 add an explanation what the 'advanced statistic filter' are. add the reference to the postfix options if we have a direct one Signed-off-by: Dominik Csapak --- src/PMG/Config.pm | 36 +++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/src/PMG/Config.pm b/src/PMG/Config.pm index 386df18..ca9b5dd 100755 --- a/src/PMG/Config.pm +++ b/src/PMG/Config.pm @@ -63,7 +63,14 @@ sub type { sub properties { return { advfilter => { - description => "Use advanced filters for statistic.", + description => "Enable advanced filters for statistic.", + verbose_description => < 'boolean', default => 1, }, @@ -519,11 +526,13 @@ sub properties { default => 0, }, 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`)", type => 'string', format => 'address', }, smarthostport => { - description => "SMTP port number for smarthost.", + description => "SMTP port number for smarthost.". + "(postfix option `default_transport`)", type => 'integer', minimum => 1, maximum => 65535, @@ -587,13 +596,13 @@ sub properties { default => 0, }, maxsize => { - description => "Maximum email size. Larger mails are rejected.", + description => "Maximum email size. Larger mails are rejected. (postfix option `message_size_limit`)", type => 'integer', minimum => 1024, default => 1024*1024*10, }, dwarning => { - description => "SMTP delay warning time (in hours).", + description => "SMTP delay warning time (in hours). (postfix option `delay_warning_time`)", type => 'integer', minimum => 0, default => 4, @@ -643,31 +652,36 @@ sub properties { default => 64, }, helotests => { - description => "Use SMTP HELO tests.", + description => "Use SMTP HELO tests. (postfix option `smtpd_helo_restrictions)", type => 'boolean', default => 0, }, rejectunknown => { - description => "Reject unknown clients.", + description => "Reject unknown clients. (postfix option `reject_unknown_client_hostname`)", type => 'boolean', default => 0, }, rejectunknownsender => { - description => "Reject unknown senders.", + description => "Reject unknown senders. (postfix option `reject_unknown_sender_domain`)", type => 'boolean', default => 0, }, 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`)", type => 'string', enum => ['450', '550'], }, 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`).", type => 'string', format => 'dnsbl-entry-list', }, dnsbl_threshold => { - 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`).", type => 'integer', minimum => 0, default => 1 -- 2.30.2