blob: f796bf1b16ad13ca9f66a5ee2bb7633c0e9f0654 [file] [log] [blame]
<!--
Copyright 2001-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
Email Sandbox
--------------
Getting started:
1) Build the jar file
If you have the source distribution you will need to build the jar file
using Maven. For instructions on downloading and installing Maven see
http://maven.apache.org/.
To build execute the command 'maven'. The jar file will be built in the
target directory.
2) Generate the documentation
Run the 'maven site:generate' command. The documentation will be written
to the target/docs directory. The documentation has some examples of
how to use this package as well as a FAQ.
3) Use
Simply include the jar file built in step #1 in your classpath. Import the
classes that you want to use and you are ready to go!