JAMES-2529 Document filtering mailet

Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/472bf31a
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/472bf31a
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/472bf31a

Branch: refs/heads/master
Commit: 472bf31a47f8a5ffaa82a0ba15577eecaab67e96
Parents: b53509c
Author: Benoit Tellier <[email protected]>
Authored: Wed Aug 29 12:00:36 2018 +0700
Committer: Antoine Duprat <[email protected]>
Committed: Thu Aug 30 15:11:54 2018 +0200

----------------------------------------------------------------------
 .../apache/james/jmap/mailet/filter/JMAPFiltering.java   | 11 +++++++++++
 1 file changed, 11 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/472bf31a/server/protocols/jmap/src/main/java/org/apache/james/jmap/mailet/filter/JMAPFiltering.java
----------------------------------------------------------------------
diff --git 
a/server/protocols/jmap/src/main/java/org/apache/james/jmap/mailet/filter/JMAPFiltering.java
 
b/server/protocols/jmap/src/main/java/org/apache/james/jmap/mailet/filter/JMAPFiltering.java
index a68193a..0a71376 100644
--- 
a/server/protocols/jmap/src/main/java/org/apache/james/jmap/mailet/filter/JMAPFiltering.java
+++ 
b/server/protocols/jmap/src/main/java/org/apache/james/jmap/mailet/filter/JMAPFiltering.java
@@ -36,6 +36,17 @@ import org.apache.mailet.base.GenericMailet;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Mailet for applying JMAP filtering to incoming email.
+ *
+ * Users are able to set their personal filtering rules using JMAP 
setFilter/getFilter methods.
+ *
+ * Configuring this mailet in the 'transport' processor is mandatory when 
running a JMAP server.
+ *
+ * Example:
+ *
+ *  &lt;mailet matcher="RecipientIsLocal" 
class="org.apache.james.jmap.mailet.filter.JMAPFiltering"/&gt;
+ */
 public class JMAPFiltering extends GenericMailet {
 
     private final Logger logger = LoggerFactory.getLogger(JMAPFiltering.class);


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to