blob: c00f3f7e0cf2de082b73952d752f5562e6423e95 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at Jun 7, 2012 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
Configuration</title>
<style type="text/css" media="all">
@import url("./css/james.css");
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
@import url("./js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css");
@import url("./js/jquery/css/print.css");
@import url("./js/fancybox/jquery.fancybox-1.3.4.css");
</style>
<script type="text/javascript" src="./js/jquery/js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="./js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script>
<script type="text/javascript" src="./js/fancybox/jquery.fancybox-1.3.4.js"></script>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="James Hupa Project Team" />
<meta name="Date-Revision-yyyymmdd" content="20120607" />
<meta http-equiv="Content-Language" content="en" />
<link title="DOAP" rel="meta" type="application/rdf+xml" href="http://james.apache.org//doap_james-project.rdf"/>
<!-- Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-1384591-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body class="composite">
<div id="banner">
<a href="index.html" id="bannerLeft" title="james-hupa-logo.gif">
<img src="images/logos/james-hupa-logo.gif" alt="James Hupa" />
</a>
<a href="http://www.apache.org/index.html" id="bannerRight">
<img src="images/logos/asf-logo-reduced.gif" alt="The Apache Software Foundation" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 2012-06-07</span>
</div>
<div class="xright"> <a href="../index.html" title="Home">Home</a>
|
<a href="../server/index.html" title="Server">Server</a>
|
<a href="index.html" title="Hupa">Hupa</a>
|
<a href="../protocols/index.html" title="Protocols">Protocols</a>
|
<a href="../imap/index.html" title="IMAP">IMAP</a>
|
<a href="../mailet/index.html" title="Mailets">Mailets</a>
|
<a href="../mailbox/index.html" title="Mailbox">Mailbox</a>
|
<a href="../mime4j/index.html" title="Mime4J">Mime4J</a>
|
<a href="../jsieve/index.html" title="jSieve">jSieve</a>
|
<a href="../jspf/index.html" title="jSPF">jSPF</a>
|
<a href="../jdkim/index.html" title="jDKIM">jDKIM</a>
|
<a href="../mpt/index.html" title="MPT">MPT</a>
|
<a href="../postage/index.html" title="Postage">Postage</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Hupa</h5>
<ul>
<li class="none">
<a href="index.html" title="Overview">Overview</a>
</li>
<li class="none">
<a href="screenshots.html" title="Screenshots">Screenshots</a>
</li>
<li class="none">
<strong>Configuration</strong>
</li>
<li class="none">
<a href="faq.html" title="FAQs">FAQs</a>
</li>
</ul>
<h5>Get Involved</h5>
<ul>
<li class="none">
<a href="environment.html" title="Setup">Setup</a>
</li>
<li class="none">
<a href="building.html" title="Building">Building</a>
</li>
</ul>
<h5>Project</h5>
<ul>
<li class="none">
<a href="https://issues.apache.org/jira/browse/HUPA" title="Issue Tracker">Issue Tracker</a>
</li>
<li class="none">
<a href="source-repository.html" title="Source Code">Source Code</a>
</li>
<li class="none">
<a href="javadoc.html" title="Javadoc">Javadoc</a>
</li>
<li class="none">
<a href="team-list.html" title="Who We Are">Who We Are</a>
</li>
<li class="none">
<a href="license.html" title="License">License</a>
</li>
</ul>
<h5>About James</h5>
<ul>
<li class="none">
<a href="../index.html" title="Overview">Overview</a>
</li>
<li class="none">
<a href="../newsarchive.html" title="News">News</a>
</li>
<li class="none">
<a href="../mail.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li class="none">
<a href="../contribute.html" title="Contributing">Contributing</a>
</li>
<li class="none">
<a href="../guidelines.html" title="Guidelines">Guidelines</a>
</li>
<li class="none">
<a href="http://wiki.apache.org/james" title="Wiki">Wiki</a>
</li>
<li class="none">
<a href="../team-list.html" title="Who We Are">Who We Are</a>
</li>
<li class="none">
<a href="../license.html" title="License">License</a>
</li>
</ul>
<h5>Download</h5>
<ul>
<li class="none">
<a href="../download.cgi" title="Releases">Releases</a>
</li>
<li class="none">
<a href="https://repository.apache.org/content/repositories/snapshots/org/apache/james/" title=""></a>
</li>
</ul>
<h5>Apache Software Foundation</h5>
<ul>
<li>
<strong>
<a title="ASF" href="http://www.apache.org/">ASF</a>
</strong>
</li>
<li>
<a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a>
</li>
<li>
<a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a>
</li>
<li>
<a title="License" href="http://www.apache.org/licenses/" >License</a>
</li>
<li>
<a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
</li>
<li>
<a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
</li>
<li>
<a title="Security" href="http://www.apache.org/security/">Security</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<!-- Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this
work for additional information regarding copyright ownership. The ASF
licenses this file to you 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. -->
<div class="section"><h2>Configuration<a name="Configuration"></a></h2>
<p>
The application tries to load from following configuration files (in order)
</p><ul>
<li>
<tt>-Dhupa.config.file=your_hupa_properties_file</tt>
when the web container has been started with the appropriate parameter
</li>
<li>$HOME/.hupa/config.properties</li>
<li>/etc/default/hupa</li>
</ul>
If no custom configuration file is found, a default configuration (
<tt>WEB-INF/conf/config.properties</tt>
) is used.
<p>
These property/value pairs are configurable in such a file:
</p><table border="0" class="bodyTable">
<tr class="a">
<th>Property</th>
<th>Mandatory</th>
<th>default</th>
<th>Comment</th>
</tr>
<tr class="b">
<td>IMAPServerAddress</td>
<td>yes</td>
<td></td>
<td>The IP or domainname of the IMAP server</td>
</tr>
<tr class="a">
<td>IMAPServerPort</td>
<td>yes</td>
<td></td>
<td>The port of the IMAP server</td>
</tr>
<tr class="b">
<td>IMAPConnectionPoolSize</td>
<td>no</td>
<td>4</td>
<td>
Set the connections amount which will get maximal opened per user for processing requests
<br />
Setting it higher can improve performance, but be sure that the IMAPServer will maybe have some limit
</td>
</tr>
<tr class="a">
<td>IMAPConnectionPoolTimeout</td>
<td>no</td>
<td>300000</td>
<td>Set the timeout for connections in milliseconds</td>
</tr>
<tr class="b">
<td>IMAPS</td>
<td>no</td>
<td>false</td>
<td>Use SSL/TLS to connect to the IMAP server</td>
</tr>
<tr class="a">
<td>TrustStore</td>
<td>no</td>
<td></td>
<td>The Truststore (including path) when using self-signed certificates on the server</td>
</tr>
<tr class="b">
<td>TrustStorePassword</td>
<td>no</td>
<td></td>
<td>The Truststore's password</td>
</tr>
<tr class="a">
<td>DefaultSentFolder</td>
<td>no</td>
<td>\Sent</td>
<td></td>
</tr>
<tr class="b">
<td>DefaultTrashFolder</td>
<td>no</td>
<td>\Trash</td>
<td></td>
</tr>
<tr class="a">
<td>DefaultDraftsFolder</td>
<td>no</td>
<td>\Drafts</td>
<td></td>
</tr>
<tr class="b">
<td>DefaultInboxFolder</td>
<td>no</td>
<td>INBOX</td>
<td></td>
</tr>
<tr class="a">
<td>PostFetchMessageCount</td>
<td>no</td>
<td>0</td>
<td>Number of Messages to post fetch</td>
</tr>
<tr class="b">
<td>SessionDebug</td>
<td>no</td>
<td>false</td>
<td>Log IMAP and SMTP dialog, Logger has to be in debug mode</td>
</tr>
<tr class="a">
<td>SMTPServerAddress</td>
<td>yes</td>
<td></td>
<td>The IP or domainname of the SMTP server</td>
</tr>
<tr class="b">
<td>SMTPServerPort</td>
<td>yes</td>
<td></td>
<td>The port of the SMTP server</td>
</tr>
<tr class="a">
<td>SMTPAuth</td>
<td>no</td>
<td>true</td>
<td>Use AUTH for SMTP</td>
</tr>
<tr class="b">
<td>SMTPS</td>
<td>no</td>
<td>false</td>
<td>Use SSL/TLS to connect to the SMTP server</td>
</tr>
</table>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">Copyright &#169; 2009-2012
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>