]> git.proxmox.com Git - pmg-docs.git/blobdiff - pmg-mail-filter.adoc
bump version to 5.0-16
[pmg-docs.git] / pmg-mail-filter.adoc
index a02c5bf892da70c5ddf1512aa24d106bd30214e1..2f4cc59b6565e4c70f8d645510c98a377eabf114 100644 (file)
@@ -11,7 +11,7 @@ Every rule has 5 categories ('FROM', 'TO', 'WHEN', 'WHAT' and
 'ACTION'), and each category may contain several objects to match
 certain criteria:
 
-WHO - objects::
+'Who' - objects::
 
 Who is the sender or receiver of the e-mail? Those objects can be used
 for the 'TO' and/or 'FROM' category.
@@ -20,7 +20,7 @@ for the 'TO' and/or 'FROM' category.
 Example: EMail-object - Who is the sender or receiver of the e-mail?
 ====
 
-WHAT - objects::
+'What' - objects::
 
 What is in the e-mail?
 +
@@ -28,7 +28,7 @@ What is in the e-mail?
 Example: Does the e-mail contain spam?
 ====
 
-WHEN - objects::
+'When' - objects::
 
 When is the e-mail received by {pmg}?
 +
@@ -36,7 +36,7 @@ When is the e-mail received by {pmg}?
 Example: Office Hours - Mail is received between 8:00 and 16:00.
 ====
 
-ACTIONS - objects::
+'Action' - objects::
 
 Defines the final actions.
 +
@@ -58,8 +58,8 @@ testing and debugging. The 'Factory Defaults' button alows you to
 reset the filter rules.
 
 
-Actions
--------
+'Action' - objects
+------------------
 
 image::images/screenshot/pmg-gui-mail-filter-actions.png[]
 
@@ -145,7 +145,7 @@ Remove attachments
 ~~~~~~~~~~~~~~~~~~
 
 Remove attachments can either remove all attachments, or only those
-matched by the rules 'WHAT' object. You can also specify the
+matched by the rules 'What' - object. You can also specify the
 replacement text if you want.
 
 
@@ -155,8 +155,8 @@ Disclaimer
 Add a Disclaimer.
 
 
-WHO - objects
--------------
+'Who' - objects
+---------------
 
 image::images/screenshot/pmg-gui-mail-filter-who-objects.png[]
 
@@ -184,18 +184,18 @@ LDAP User or Group::
 
 Test if the mail address belong to a specific LDAP user or group.
 
-We have two important WHO objects called 'Blacklist' and
+We have two important 'Who' - objects called 'Blacklist' and
 'Whitelist'. Those are used in the default ruleset to globally block
 or allow specific senders.
 
 
-WHAT - objects
---------------
+'What' - objects
+----------------
 
 image::images/screenshot/pmg-gui-mail-filter-what-objects.png[]
 
-WHAT - objects are used to classify the mail content. A single object
-can combine multiple items, and the following item types are
+'What' - objects are used to classify the mail content. A single
+object can combine multiple items, and the following item types are
 available:
 
 Spam Filter::
@@ -223,13 +223,13 @@ Archive Filter::
 Can be used to match specific content types inside archives.
 
 
-WHEN - objects
---------------
+'When' - objects
+----------------
 
 image::images/screenshot/pmg-gui-mail-filter-when-objects.png[]
 
-WHEN - objects are use to activate rules at specific daytimes. You can compose
-them of one or more time-frame items.
+'When' - objects are use to activate rules at specific daytimes. You
+can compose them of one or more time-frame items.
 
 The default ruleset defines 'Office Hours', but this is not used by
 the default rules.
@@ -277,3 +277,5 @@ the period. This is used to match an arbitrary string of any length,
 including the null string. For example: `.*company.*` matches
 "company@domain.com" or "company@domain.co.uk" or
 "department.company@domain.com".
+
+The book xref:Friedl97[] provides a more comprehensive introduction.
\ No newline at end of file