public inbox for pmg-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Leo Nunner <l.nunner@proxmox.com>
To: pmg-devel@lists.proxmox.com
Subject: [pmg-devel] [PATCH pmg-docs] docs: document negation and match groups
Date: Fri,  7 Apr 2023 15:42:57 +0200	[thread overview]
Message-ID: <20230407134258.199691-12-l.nunner@proxmox.com> (raw)
In-Reply-To: <20230407134258.199691-1-l.nunner@proxmox.com>

Signed-off-by: Leo Nunner <l.nunner@proxmox.com>
---
 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





  parent reply	other threads:[~2023-04-07 13:43 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-07 13:42 [pmg-devel] [PATCH pmg-api/gui/docs, proxmox-widget-toolkit] Extend rule system Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 1/8] feature: negation: add field to database Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 2/8] feature: negation: parse negation value into objects Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 3/8] feature: negation: expand/implement API endpoints Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 4/8] feature: negation: implement matching logic Leo Nunner
2023-04-11  7:35   ` Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 5/8] feature: match groups: add field to database Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 6/8] feature: match groups: parse field into objects Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 7/8] feature: match groups: update API endpoints Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-api 8/8] feature: match groups: implement matching logic Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-gui 1/2] feature: negate objects inside rules Leo Nunner
2023-04-07 13:42 ` [pmg-devel] [PATCH pmg-gui 2/2] feature: introduce logical 'and' for rules Leo Nunner
2023-04-07 13:42 ` Leo Nunner [this message]
2023-04-07 13:42 ` [pmg-devel] [PATCH widget-toolkit] dark-mode: fix colour of default tree icons Leo Nunner
2023-04-11  9:52 ` [pmg-devel] [PATCH pmg-api/gui/docs, proxmox-widget-toolkit] Extend rule system Thomas Lamprecht
2023-04-11 11:04   ` Leo Nunner
2023-04-11 11:19     ` Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230407134258.199691-12-l.nunner@proxmox.com \
    --to=l.nunner@proxmox.com \
    --cc=pmg-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal