[GitHub] [james-project] chibenwa commented on a change in pull request #745: JAMES-2734 Document Sieve and ManageSieve

[GitBox <gi...@apache.org>]

chibenwa commented on a change in pull request #745:
URL: https://github.com/apache/james-project/pull/745#discussion_r747958483



##########
File path: server/apps/distributed-app/docs/modules/ROOT/pages/configure/sieve.adoc
##########
@@ -0,0 +1,82 @@
+= Sieve
+:navtitle: Sieve
+
+James servers are able to evaluate and execute Sieve scripts.
+
+Sieve is an extensible mail filtering language. It's limited
+expressiveness (no loops or variables, no tests with side
+effects) allows user created scripts to be run safely on email
+servers. Sieve is targeted at the final delivery phase (where
+an incoming email is transferred to a user's mailbox).
+
+The following Sieve capabilities are supported by Apache James:
+
+  - link:https://www.ietf.org/rfc/rfc2234.txt[RFC 2234 ABNF]
+  - link:https://www.ietf.org/rfc/rfc2244.txt[RFC 2244 ACAP]
+  - link:https://www.ietf.org/rfc/rfc2298.txt[RFC 2298 MDN]
+  - link:https://tools.ietf.org/html/rfc5228[RFC 5228 Sieve]
+  - link:https://tools.ietf.org/html/rfc4790[RFC 4790 IAPCR]
+  - link:https://tools.ietf.org/html/rfc5173[RFC 5173 Body Extension]
+  - link:https://datatracker.ietf.org/doc/html/rfc5230[RFC 5230 Vacations]
+
+To be correctly executed, please note that the *Sieve* mailet is required to be positionned prior the
+*LocalDelivery* mailet.
+
+== Managing Sieve scripts
+
+A user willing to manage his Sieve scripts on the server can do so via several means:
+
+He can ask an admin to upload his script via the xref:operate/cli.adoc[CLI]
+
+As James support ManageSieve (link:https://datatracker.ietf.org/doc/html/rfc5804[RFC-5804]) a user
+can thus use compatible software to manage his Sieve scripts.</p>
+
+== ManageSieve protocol
+
+*WARNING*: ManageSieve protocol should be considered experimental.
+
+Consult link:https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/managesieveserver.xml[managesieveserver.xml]
+in GIT to get some examples and hints.
+
+The  service is controlled by a configuration block in the managesieveserver.xml.
+The managesieveserver tag defines the boundaries of the configuration block.  It encloses
+all the relevant configuration for the ManageSieve server.  The behavior of the ManageSieve service is
+controlled by the attributes and children of this tag.
+
+This tag has an optional boolean attribute - *enabled* - that defines whether the service is active or not.
+The value defaults to "false" if
+not present.
+
+The standard children of the managesieveserver tag are:
+
+.imapserver.xml content

Review comment:
       ```suggestion
   .managesieveserver.xml content
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



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