[pmg-devel] [PATCH pmg-docs v2] pmg-mail-filter: clarify matching of Who objects

[Friedrich Weber]

In particular, explain that Who objects match against Envelope From
and Envelope To, not the From: and To: mail headers. This is
occasionally a source of confusion in enterprise support.

Signed-off-by: Friedrich Weber <f.weber at proxmox.com>
---

Notes:
    changes since v1: (thx stoiko!)
    - mention that these addresses are also visible in the logs, fix
      phrasing
    - fix commands (they are called `MAIL`/`RCPT`, not `MAIL TO`/`MAIL
      FROM`)

 pmg-mail-filter.adoc | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/pmg-mail-filter.adoc b/pmg-mail-filter.adoc
index 235f156..6e7b21f 100644
--- a/pmg-mail-filter.adoc
+++ b/pmg-mail-filter.adoc
@@ -265,6 +265,19 @@ We have two important 'Who' objects called 'Blacklist' and
 'Whitelist'. These are used in the default ruleset to globally block
 or allow specific senders.
 
+Note that 'Who' objects match against the mail addresses given during the SMTP
+dialog:
+
+* 'Who' objects in the 'FROM' category match against the sender's mail address
+  given in the `MAIL` command (the Envelope From).
+* 'Who' objects in the 'TO' category match against the recipient's mail address
+  given in the `RCPT` command (the Envelope To).
+
+These addresses are also visible in the logs and the
+xref:pmg_tracking_center[Tracking Center].
+
+If you want to match against the `From:` or `To:` header fields of the mail,
+use a 'What' object with type 'Match Field' instead.
 
 [[pmg_mailfilter_what]]
 'What' objects
-- 
2.39.5