[pmg-devel] [PATCH pmg-docs 1/2] rule system: add a small section about matching rules

[Dominik Csapak]

this section explains how multiple object categories and multiple
objects interact with the rule matching.

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 pmg-mail-filter.adoc | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/pmg-mail-filter.adoc b/pmg-mail-filter.adoc
index 3aafe4c..57b8a15 100644
--- a/pmg-mail-filter.adoc
+++ b/pmg-mail-filter.adoc
@@ -58,6 +58,23 @@ 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.
 
+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:
+
+* 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
+  has to match for the whole category to match.
+
+* FROM/TO/WHAT/WHEN category match results are logical-and linked, so all
+  categories that have at least one object in them must match for the rule to
+  match.
+
+When these conditions are met, all configured actions are executed.
+
 
 [[pmg_mailfilter_action]]
 'Action' - objects
-- 
2.30.2