From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <d.csapak@proxmox.com> 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 6266194024 for <pmg-devel@lists.proxmox.com>; Wed, 21 Feb 2024 13:25:15 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 9603F16C60 for <pmg-devel@lists.proxmox.com>; Wed, 21 Feb 2024 13:24:44 +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 <pmg-devel@lists.proxmox.com>; Wed, 21 Feb 2024 13:24:43 +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 318F444484 for <pmg-devel@lists.proxmox.com>; Wed, 21 Feb 2024 13:24:42 +0100 (CET) From: Dominik Csapak <d.csapak@proxmox.com> To: pmg-devel@lists.proxmox.com Date: Wed, 21 Feb 2024 13:24:37 +0100 Message-Id: <20240221122439.1281024-12-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20240221122439.1281024-1-d.csapak@proxmox.com> References: <20240221122439.1281024-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.020 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 T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pmg-devel] [PATCH pmg-docs v2 1/1] rule system: explain new and mode and invert flag X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion <pmg-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pmg-devel>, <mailto:pmg-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pmg-devel/> List-Post: <mailto:pmg-devel@lists.proxmox.com> List-Help: <mailto:pmg-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel>, <mailto:pmg-devel-request@lists.proxmox.com?subject=subscribe> X-List-Received-Date: Wed, 21 Feb 2024 12:25:15 -0000 and adding that the previous behaviour is now the default. Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> --- changes from v1: * incorporated stoikos feedback pmg-mail-filter.adoc | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/pmg-mail-filter.adoc b/pmg-mail-filter.adoc index 57b8a15..9c0e2c4 100644 --- a/pmg-mail-filter.adoc +++ b/pmg-mail-filter.adoc @@ -63,7 +63,7 @@ Application of Rules When there is more than one object category or multiple objects configured within a single rule, the following logic is used to determine if the rule -should be applied: +should be applied by default: * Within one category (WHAT/FROM/TO/WHEN), all objects are logical-or linked, meaning that only one object of any one object group from the same category @@ -75,6 +75,44 @@ should be applied: When these conditions are met, all configured actions are executed. +Alternatively, one can configure the 'mode' to 'any' (the default) or 'all' and +set 'invert' (default off) per object group and per object category for each +rule. + +When the mode is 'all' for a group, all objects within must match for the +object group to count as a match. This can be helpful when one wants to match +multiple conditions at the same time (e.g. file content-type and filename). + +When 'all' is set for a category of a rule, all object groups for that +type must match for the type to match. + +When 'invert' is active on a group, the original result of the group will +simply be inverted, so a match becomes a non-match and vice versa. + +The same is true for the object group types for rules. + +Special handling is done for WHAT matches that mark mail parts (e.g. filename) +since that is not a simple yes/no match for the complete mail, but could be a +match for each part of the e-mail (e.g. attachments, or parts of a multi-part +e-mail). + +So for WHAT match object groups, the 'mode' and 'invert' is applied to +the single parts of the e-mail, not the message as a whole. + +This means one has to be very careful with the 'invert' option, as previously +not matching parts, will match when using 'invert' (e.g. an inverted filename +matching will also mark non attachment parts of the mail). + +On the rule level, these marks of the parts will always be logical-or linked, +this way even more scenarios can be represented. + +To make it a bit easier to understand, the options are combined to a single +selection in the web ui: + +* Any must match => mode: 'any', invert: 'off' +* All must match => mode: 'all', invert: 'off' +* At least one must not match => mode: 'all', invert: 'on' +* None must match => mode: 'any', invert: 'on' [[pmg_mailfilter_action]] 'Action' - objects -- 2.30.2