(james-project) 08/08: JAMES-4087 Document notmatch tag

[rc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rcordier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit 0e423bbdc0d7c740655b817c4145490585091aeb
Author: Quan Tran <hq...@linagora.com>
AuthorDate: Tue Nov 12 14:57:40 2024 +0700

    JAMES-4087 Document notmatch tag
---
 .../partials/configure/mailetcontainer.adoc        | 31 +++++++++++++++-------
 1 file changed, 21 insertions(+), 10 deletions(-)

diff --git a/docs/modules/servers/partials/configure/mailetcontainer.adoc b/docs/modules/servers/partials/configure/mailetcontainer.adoc
index 18ef8a5aee..b7cd767907 100644
--- a/docs/modules/servers/partials/configure/mailetcontainer.adoc
+++ b/docs/modules/servers/partials/configure/mailetcontainer.adoc
@@ -39,20 +39,31 @@ instead.
 
 == The Mailet Tag
 
-Consider the following simple *mailet* tag:</p>
+The mailet tag has two required attributes, condition tag and *class* tag.
 
-[source,xml]
-....
-<mailet match="RemoteAddrNotInNetwork=127.0.0.1" class="ToProcessor">
-    <processor>spam</processor>
-</mailet>
-....
-
-The mailet tag has two required attributes, *match* and *class*.
+The condition tag need to be one of these tag:
 
-The *match* attribute is set to the value of the specific Matcher class to be instantiated with a an
+- The *match* attribute is set to the value of the specific Matcher class to be instantiated with a an
 optional argument.  If present, the argument is separated from the Matcher class name by an '='.  Semantic
 interpretation of the argument is left to the particular mailet.
+  Example:
+
+    [source,xml]
+    ....
+    <mailet match="RemoteAddrNotInNetwork=127.0.0.1" class="ToProcessor">
+        <processor>spam</processor>
+    </mailet>
+    ....
+
+- The *notmatch* attribute inverts the according Matcher condition.
+  Example:
+
+    [source,xml]
+    ....
+    <mailet notmatch="RemoteAddrInNetwork=127.0.0.1" class="ToProcessor">
+        <processor>spam</processor>
+    </mailet>
+    ....
 
 The *class* attribute is set to the value of the Mailet class that is to be instantiated.
 


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org