Arsnael commented on a change in pull request #745: URL: https://github.com/apache/james-project/pull/745#discussion_r747956314
########## File path: src/site/xdoc/server/config-sieve.xml ########## @@ -25,10 +25,76 @@ <body> - <section name="Sieve Configuration"> - + <section name="Sieve"> + <p>James servers are able to evaluate and execute Sieve scripts.</p> + + <p>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).</p> + + <ul>The following Sieve capabilities are supported by Apache James: + + <li><a href="https://www.ietf.org/rfc/rfc2234.txt";>RFC 2234 ABNF</a></li> + <li><a href="https://www.ietf.org/rfc/rfc2244.txt";>RFC 2244 ACAP</a></li> + <li><a href="https://www.ietf.org/rfc/rfc2298.txt";>RFC 2298 MDN</a></li> + <li><a href="https://tools.ietf.org/html/rfc5228";>RFC 5228 Sieve</a></li> + <li><a href="https://tools.ietf.org/html/rfc4790";>RFC 4790 IAPCR</a></li> + <li><a href="https://tools.ietf.org/html/rfc5173"; >RFC 5173 Body Extension</a></li> + <li><a href="https://datatracker.ietf.org/doc/html/rfc5230"; >RFC 5230 Vacations</a></li> + </ul> + + <p>To be correctly executed, please note that the <b>Sieve</b> mailet is required to be positionned prior the + <b>LocalDelivery</b> mailet.</p> </section> + <section name="Managing Sieve scripts"> + <p>A user willing to manage his Sieve scripts on the server can do so via several means:</p> + + <p>He can ask an admin to upload his script via the <a href="manage-cli.html">CLI</a></p> + + <p>As James support ManageSieve (<a href="https://datatracker.ietf.org/doc/html/rfc5804";>RFC-5804</a>) a user Review comment: ```suggestion <p>As James supports ManageSieve (<a href="https://datatracker.ietf.org/doc/html/rfc5804";>RFC-5804</a>) a user ``` ########## 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 Review comment: ```suggestion As James supports ManageSieve (link:https://datatracker.ietf.org/doc/html/rfc5804[RFC-5804]) a user ``` ########## 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 +|=== +| Property name | explanation + +| bind +| Configure this to bind to a specific inetaddress. This is an optional integer value. This value is the port on which this IMAP4 server is configured +to listen. If the tag or value is absent then the service +will bind to all network interfaces for the machine If the tag or value is omitted, the value will default to the standard IMAP4 port Review comment: ```suggestion will bind to all network interfaces for the machine. If the tag or value is omitted, the value will default to the standard IMAP4 port ``` ########## 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 +|=== +| Property name | explanation + +| bind +| Configure this to bind to a specific inetaddress. This is an optional integer value. This value is the port on which this IMAP4 server is configured +to listen. If the tag or value is absent then the service +will bind to all network interfaces for the machine If the tag or value is omitted, the value will default to the standard IMAP4 port +port 143 is the well-known/IANA registered port for IMAP +port 993 is the well-known/IANA registered port for IMAPS ie over SSL/TLS Review comment: You will have a formatting issue here I think ########## File path: src/site/xdoc/server/config-sieve.xml ########## @@ -25,10 +25,76 @@ <body> - <section name="Sieve Configuration"> - + <section name="Sieve"> + <p>James servers are able to evaluate and execute Sieve scripts.</p> + + <p>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).</p> + + <ul>The following Sieve capabilities are supported by Apache James: + + <li><a href="https://www.ietf.org/rfc/rfc2234.txt";>RFC 2234 ABNF</a></li> + <li><a href="https://www.ietf.org/rfc/rfc2244.txt";>RFC 2244 ACAP</a></li> + <li><a href="https://www.ietf.org/rfc/rfc2298.txt";>RFC 2298 MDN</a></li> + <li><a href="https://tools.ietf.org/html/rfc5228";>RFC 5228 Sieve</a></li> + <li><a href="https://tools.ietf.org/html/rfc4790";>RFC 4790 IAPCR</a></li> + <li><a href="https://tools.ietf.org/html/rfc5173"; >RFC 5173 Body Extension</a></li> + <li><a href="https://datatracker.ietf.org/doc/html/rfc5230"; >RFC 5230 Vacations</a></li> + </ul> + + <p>To be correctly executed, please note that the <b>Sieve</b> mailet is required to be positionned prior the + <b>LocalDelivery</b> mailet.</p> </section> + <section name="Managing Sieve scripts"> + <p>A user willing to manage his Sieve scripts on the server can do so via several means:</p> + + <p>He can ask an admin to upload his script via the <a href="manage-cli.html">CLI</a></p> + + <p>As James support ManageSieve (<a href="https://datatracker.ietf.org/doc/html/rfc5804";>RFC-5804</a>) a user + can thus use compatible software to manage his Sieve scripts.</p> + </section> + <section name="ManageSieve protocol"> + <p><b>WARNING</b>: ManageSieve protocol should be considered experimental.</p> + <p> + Consult <a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/managesieveserver.xml";>managesieveserver.xml</a> + in GIT to get some examples and hints. + </p> + + <p>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.</p> + + <p>This tag has an optional boolean attribute - <strong>enabled</strong> - that defines whether the service is active or not. The value defaults to "false" if + not present.</p> + + <p>The standard children of the managesieveserver tag are:</p> + <dl> + <dt><strong>bind</strong></dt> + <dd>Configure this to bind to a specific inetaddress. This is an optional integer value. This value is the port on which this ManageSieve server is configured + to listen. If the tag or value is absent then the service + will bind to all network interfaces for the machine If the tag or value is omitted, the value will default to the standard ManageSieve port Review comment: ```suggestion will bind to all network interfaces for the machine. If the tag or value is omitted, the value will default to the standard ManageSieve port:<br/> ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
