Getting Started with EmailProcessor

Building from Source

The distribution comes with both source and jar files, so you don't need to build from source if you just want to use EmailProcessor without modifications. However, if you want to do some hacking, by all means:

• Go the main folder where you decompressed the distribution file you downloaded.
• Do an: ant dist
• You can grab your resulting jar from the dist dir.

(NOTE: If you are hacking the source and want to make code contributions, these are more than welcome.)

Running from the Command Line

To run from the command line, you can use either the shell script or the batch file:

bin/emailprocessor.sh
bin/emailprocessor.bat

Using EmailProcessor as a Library in Your Application

To incorporate EmailProcessor into your application, simply:

• Include all of the libraries in the "lib" folder in your application.
• Write your configuration file (how to configure).
• In your code:
• Initialize log4j
• Call EmailProcessor.runConfig() and pass it the path to your file.
• See the documentation for more details.

Here's an example:

BasicConfigurator.configure();
EmailProcessor.runConfig("etc/emailprocessor.xml");