ORO is no more needed as a depedency because we now use java regex.
[james-jsieve.git] / README.txt
1 What is jSieve?
2 ---------------
3
4 jSieve is a Java implementation of the Sieve mail filtering language defined by 
5 RFC 3028. jSieve is implemented as a langauge processor that can be plugged into any
6 internet mail application to add Sieve support.
7
8 Getting Started
9 ---------------
10
11 Until these pages are fleshed out, the best way to understand jSieve is read the 
12 Javadocs and look at the source code. 
13
14 - To understand how to invoke jSieve, see org.apache.jsieve.SieveFactory.
15 - To understand how to implement a MailAdapter for jSieve, see
16   org.apache.jsieve.mail.MailAdapter.
17 - To understand how to add a custom extension to jSieve, see
18   org.apache.jsieve.commands.extensions.Log.
19 - The jUnit tests in org.apache.jsieve.junit illustrate many aspects
20   of the implementation.
21 - To build jSieve, run build.sh or build.bat as appropriate for your environment.   
22
23 Comments, Questions and Issues
24 ------------------------------
25
26 jSieve is a sub-project of Apache James. Please direct your comments and questions to 
27 the relevant James list.
28
29 To report issues, such as bugs, go to 
30 http://nagoya.apache.org/jira/secure/BrowseProject.jspa?id=10412.
31 As jSieve comes with a fairly extensive suite of jUnit Tests, it would be most 
32 helpful for bug reports to be accompanied by an illustrative jUnit test case.
33
34
35 Licensing and legal issues\r
36 --------------------------\r
37
38 For legal and licensing issues, please look in the legal section of\r
39 the documentation or read the LICENSE.txt and NOTICE.txt files.