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 8EF7D937D7 for ; Fri, 7 Apr 2023 15:43:39 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 0F26B1A783 for ; Fri, 7 Apr 2023 15:43:09 +0200 (CEST) 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, 7 Apr 2023 15:43:07 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 442C246454 for ; Fri, 7 Apr 2023 15:43:07 +0200 (CEST) From: Leo Nunner To: pmg-devel@lists.proxmox.com Date: Fri, 7 Apr 2023 15:42:57 +0200 Message-Id: <20230407134258.199691-12-l.nunner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230407134258.199691-1-l.nunner@proxmox.com> References: <20230407134258.199691-1-l.nunner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.127 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-docs] docs: document negation and match groups 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, 07 Apr 2023 13:43:39 -0000 Signed-off-by: Leo Nunner --- pmg-mail-filter.adoc | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/pmg-mail-filter.adoc b/pmg-mail-filter.adoc index 3aafe4c..60bb8c0 100644 --- a/pmg-mail-filter.adoc +++ b/pmg-mail-filter.adoc @@ -58,9 +58,36 @@ You can also disable a rule completely, which is mostly useful for testing and debugging. The 'Factory Defaults' button allows you to reset the filter rules. +[[pmg_mailfilter_structure]] +Rule structure +-------------- + +Rules have a predefined structure. A rule contains objects of all +categories (Action, Who, What, When), which are grouped by their +respective types. + +Matches +~~~~~~~ + +The logic behind matches is as follows: all categories need to +match separately; if a category is empty, it matches automatically. +As for the objects inside a category, it's enough if only +one of them matches; if one object matches, the whole category +matches. Finally, if all categories match, the whole rule counts as +a match and the defined actions are executed. + +This behaviour can be changed by using match groups. Each category +contains a child item titled 'Match groups'. All objects that are +added to this group will be evaluated together: the match group only +evaluates as a match if all objects inside it do. + +Objects can also be inverted, so that they only match if their +criteria are *not* fulfilled. This is indicated via a prefixed +"NOT" in the object overview. + [[pmg_mailfilter_action]] -'Action' - objects +'Action' objects ------------------ [thumbnail="pmg-gui-mail-filter-actions.png", big=1] -- 2.30.2