?? jwebmail-guide.html
字號:
<HTML><HEAD><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><TITLE>JWebMail v1.0.1*</TITLE><META CONTENT="AUTHOR" VALUE="Blaine Simpson, blaine.simpson@admc.com"></HEAD><BODY BGCOLOR="#ffffff"><CENTER><H1>User's Guide for JWebMail v1.0.1*</H1></CENTER><CENTER><H4>$Revision: 140 $</H4></CENTER><A NAME="contents"></A><TABLE WIDTH="100%" BGCOLOR="#a0d895" CELLSPACING="0" BORDER="0"><TR><TD><H1><CENTER>I. Contents</CENTER></H1></TD></TR></TABLE><OL><LI><A HREF="#contents">Contents</A></LI><LI><A HREF="#about">What is JWebMail</A></LI><LI><A HREF="#install">Installation</A></LI><LI><A HREF="#config">Configuration</A></LI><LI><A HREF="#auth">User Authentication</A></LI><LI><A HREF="#usage">Usage</A></LI><LI><A HREF="#lang">Different Languages, Translating JWebMail</A></LI><LI><A HREF="#notes">Notes</A></LI><LI><A HREF="#license">License</A></LI><LI><A HREF="#doc_contrib">Contributed Documentation</A></LI><LI><A HREF="#credits">Credits</A></LI></OL><A HREF="#contents">Top of section "Contents"</A><A NAME="about"></A><TABLE WIDTH="100%" BGCOLOR="#a0d895" CELLSPACING="0" BORDER="0"><TR><TD><H1><CENTER>II. What is JWebMail</CENTER></H1></TD></TR></TABLE><P> JWebMail is a <A HREF="http://en.wikipedia.org/wiki/Web_mail">web mail</A> server. Web mail allows an organization to provide a WWW interface for each user to his mailbox(es). Unlike Yahoo Mail, Hotmail, and Gmail, JWebMail presents a web interface to traditional email accounts which you or somebody else provide. The target email account servers may be restricted by JWebMail. </P><P> By virtue of JWebMail being a pure Java appplication, it has excellent portability, scalability, and performance. We have designed JWebMail so that it works out-of-the-box for a home LAN setup by just dropping the .war file into your servlet container (which includes all modern application servers). </P><A NAME="about:usecases"></A><H2>2.1. Use Cases</H2><P>Common use-cases <UL> <LI> Serve JWebMail on the same host that your traditional email server runs on, to provide web access in addition to dedicated email client access. </LI> <LI> Run JWebMail to provide members Internet web access to their email accounts on an internal mail server. </LI> <LI> Run a single JWebMail server to allow for a single, unified interface to all of the email accounts for your users, whether the target email accounts are internal organizational accounts and/or external accounts. </LI> </UL> </P><A HREF="#about:usecases">Top of section "Use Cases"</A><HR><A NAME="about:features"></A><H2>2.2. Features</H2><P> Features include: <UL> <LI>Product is independent of the target email account <I>provider(s)</I>.</LI> <LI>Gives a user full access to his/her IMAP mailbox through a simple-to-use WWW interface</LI> <LI>Supports multiple folders on multiple hosts, depending on mail protocol used (IMAP supports different folders on the same host, POP doesn't)</LI> <LI>Supports SSL protocols <CODE>imaps</CODE> and <CODE>pop3s</CODE>.</LI> <LI>Sophisticated folder management system</LI> <LI>100% HTML 3.2/4.0 output, no Java on the Client side</LI> <LI>Supports multiple languages, configurable for each user</LI> <LI>Flexible template system to personalize look and feel and write new language files using XML and XSL</LI> <LI>Runs as a <I>web application</I> in a Java servlet container</LI> <LI>Improved session management keeps mail connections alive</LI> <LI>Performance, scalability, and portability of a pure Java application</LI> <LI>Usage of JavaMail-API ensures compatibility to many mail standards</LI> <LI>Open Source distribution allows easy customization</LI> <LI>Web-based administration interface</LI> <LI>Support for multiple virtual user domains</LI> <LI>Easily add new features through the JWebMail modular plugin concept (support for dependencies, hooking into URLs, etc)</LI> <LI>Application/Data separation allows for redeployments and upgrades without losing any configuration or user data.</LI> </UL> </P><A HREF="#about:features">Top of section "Features"</A><HR><A HREF="#about">Top of section "What is JWebMail"</A><A NAME="install"></A><TABLE WIDTH="100%" BGCOLOR="#a0d895" CELLSPACING="0" BORDER="0"><TR><TD><H1><CENTER>III. Installation</CENTER></H1></TD></TR></TABLE><A NAME="install:introduction"></A><H2>3.1. Introduction</H2><A HREF="#install:introduction">Top of section "Introduction"</A><HR><A NAME="install:requirements"></A><H2>3.2. Requirements</H2><P>For running JWebMail you need the following software: <UL> <LI> A mailserver for sending (SMTP) and receiving (IMAP) mails; by default, JWebMail will use <CODE>localhost</CODE> for both </LI> <LI> A Java servlet container which supports the 2.4 servlet spec, and runs on a Java 1.5 or greater JVM (either JRE or JDK). Anything from a stripped down servlet-container like <A HREF="http://tomcat.apache.org/">Tomcat</A>, to a J2EE application server like <A HREF="http://www.jboss.org/jbossas">JBoss</A> or <A HREF="http://www.ibm.com/software/webservers/appserv/was/"> WebSphere</A> will work. </LI> <LI> Your servlet container needs modern versions of the following libraries installed: <UL> <LI> JavaMail API (typically <CODE>mailapi-*.jar</CODE>) You can download <A HREF="http://pub.admc.com/lib-repos/mailapi-1.4.1.jar"> version 1.4.1 of the JavaMail API library here</A>. </LI> <LI> JavaMail SMTP provider (typically <CODE>smtp-*.jar</CODE>). You can download <A HREF="http://pub.admc.com/lib-repos/smtp-1.4.1.jar"> version 1.4.1 of the SMTP library here</A>. </LI> <LI> JAF/Java Activation Framework (<I>not necessary if your servlet container uses Java 1.6</I>, since Java 1.6 includes the activation framework). Java 1.5-users can download <A HREF="http://pub.admc.com/lib-repos/jaf-1.1.1.jar"> version 1.1.1 of JAF library here</A>. </LI> </UL> </LI> </UL> </P><P> If you wish to build a custom app, or develop, you will also need a standalone Java JDK 1.5 or later, and Ant 1.7 or later, as described below. Any or no Java IDE will work. </P><A HREF="#install:requirements">Top of section "Requirements"</A><HR><A NAME="install:intro"></A><H2>3.3. Installing</H2><P> There are separate sections below, depending on whether you want to just <I>run</I> JWebMail, or to build it on the command-line or with an IDE. </P><A NAME="install:binary"></A><H3>3.3.1. Installing Application (binary install)</H3> <P> This is the preferred installation method if you just want to run JWebMail, and have no need to customize the application iteself. </P> <P> This installation is very simple: </P> <P> Install <CODE>jwebmail.war</CODE> as you would install any War file. </P> <P> With Tomcat, the easiest way is to use the Manager webapp, which serves http://localhost:8080/manager/html by default. Log in and deploy the war using the Gui (you can see or add manager accounts in the file $CATALINA_BASE/config/tomcat-users.xml). </P> <P> For every application server that I know of, if you have auto-deploy on (usually the default mode) you can become the app-server <I>owner</I> (the account under which the server process(es) run), and just copy the war file into the webapp landing directory. If you don't have access to that account, see your app server docs, because the war file permission requirements vary (if you have superuser privileges, you can always change the file to be owned by the app-server owner). Rest assured, your app server has several easy ways to deploy war files. </P> <P> JWebMail is then available by visiting http://yourhost:PORT/jwebmail with a web browser. </P> <P> Please don't forget to visit the administration interface first. You can access it by browsing http://yourhost:PORT/jwebmail/admin. Initial password is <CODE>Secret</CODE>. </P> <A HREF="#install:binary">Top of section "Installing Application (binary install)"</A><A NAME="install:build"></A><H3>3.3.2. Build and Install from source</H3> <P> JWebMail is compiled by using the Ant build-system. You will need <A HREF="http://ant.apache.org/">Ant</A> version 1.7 or greater and <A HREF="http://java.sun.com/javase/">Java JDK 1.5 or greater</A> to build JWebMail. </P> <P> You can obtain the JWebMail source code by extracing a source code distribution package, or by exporting or checking out our code from SourceForge. You can get our distro packages at <A HREF="https://sourceforge.net/project/showfiles.php?group_id=2056"> https://sourceforge.net/project/showfiles.php?group_id=2056</A>. You can use any Subversion client to get our trunk code from <CODE>https://jwebmail.svn.sourceforge.net/svnroot/jwebmail/trunk</CODE>. </P> <P> The following steps are required (for a quick-start):<OL> <LI> Set your JAVA_HOME environment variable (to the directory where the JDK is installed) </LI> <LI> Make sure that the <CODE>bin</CODE> directory of your Ant installation is in your search path. Run "<CODE>ant -v</CODE>" to verify. </LI> <LI> You will need Internet access the first time you run the build, so that build process can download the needed third party libraries (automatically). </LI> <LI> Just run 'ant' to build a war file in subdirectory <CODE>dist</CODE>. If you don't have an <A HREF="http://ant.apache.org/ivy/">Ivy</A> jar file in your CLASSPATH, the Ant command above will display the simple command that you can copy-and-paste to your command line to satisfy it. <CENTER><TABLE WIDTH="80%" BGCOLOR="#eae723" BORDER="1"><TR><TD><B>Note:</B> An error message like <CODE>...doesn't support the nested "matches" element...</CODE> means you need to upgrade Ant to 1.7 or later.</TD></TR></TABLE></CENTER> </LI> <LI> Deploy the file at <CODE>dist/jwebmail.jar</CODE> to your servlet container, as explained in the previous section. Alternatively, you set Ant property <CODE>exploded.dir</CODE> and deploy the exploded webapp to a live deployment directory. Since you are building software, we figure you are handy enough to figure this out without further instruction from us. </LI> </OL> </P> <P> Run "<CODE>ant -p</CODE>" for further possible targets that may be used. To customize any Ant properties, create a standard Java properties file in this directory with name <CODE>local.properties</CODE>. Most developers will want to use the targets <CODE>gen-guide</CODE> and <CODE>javadoc</CODE> to build documentation. (They get written to the <CODE>build/apidocs</CODE> and <CODE>doc</CODE> subdirectories respectively). </P> <P> Unless the version of the User's Guide you are reading is out-of-date, you probably won't need this, but... The <CODE>gen-guide</CODE> task requires the program "xsltproc". You have a few alternatives to access a User's Guide if you don't have <CODE>xsltproc</CODE>. <UL> <LI>Read it online at <A HREF="http://jwebmail.sourceforge.net/jwebmail-guide.html"> http://jwebmail.sourceforge.net/jwebmail-guide.html</A></LI> <LI>Use your own XSLT processor program to generate jwebmail-guide.html file from the guide.* artifacts in the doc-src directory.</LI> <LI>Download the desired version of the binary distribution of JWebMail. These include a pre-build User's Guide.</LI> </UL> </P> <P> The build system uses <A HREF="http://ant.apache.org/ivy/">Apache Ivy</A> to fetch third party libraries. The configuration allows you to change the library repository location by editing local.properties and ivy-settings.xml. See <A HREF="http://ant.apache.org/ivy/">http://ant.apache.org/ivy/</A> for details about Apache Ivy. </P> <P> Code contributors must read and follow the coding conventions listed in the <CODE>conventions.txt</CODE> file located in the <CODE>doc</CODE> subdirectory. It's important to not submit files which should not be change-controlled, and to set the right Subversion file properties. The easiest way to accomplish this is to put the supplied file <CODE>samples/config-svn.txt</CODE> into place at <CODE>$HOME/.subversion/config</CODE> on UNIX-like OSes, or wherever your Subversion client wants it on Windows. When you submit code, always add a meaningful subversion commit message which very briefly describes what you have changed, added, or removed. </P> <A HREF="#install:build">Top of section "Build and Install from source"</A><A NAME="install:ide"></A><H3>3.3.3. IDE Setup</H3> <P> At this point in time, we only have the JWebMail pre-configured for Eclipse. Any developer who has a strong preference for a different IDE should be capable of getting things working in it. If you do this in a way to share the configuration in a fool-proof manner, like we do for Eclipse, please contact me to get these improvements into the code baseline. </P> <P> Here are the steps to start from 0 and get JWebMail building.?? 快捷鍵說明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -