Title: mod_mbox - Mailing list archives browser
Notice:    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.

# Reference documentation #

In order to run properly, `mod_mbox` needs some configuration. Here follows
a list and description of all configuration directives understood by
`mod_mbox`.

# MboxIndex Directive #

Activate `mod_mbox` index.
<pre>
    MboxIndex On|Off
</pre>
Setting this option to *On* will tell `mod_mbox` to handle directory
listing. This will display a nice web page with mailing list information,
links to each month and the message count for each mailbox.

Default is *Off* 

# MboxRootPath Directive #

Set archives root directory.
<pre>
    MboxRootPath /archives/
</pre>
Specify the mail archives root directory, relative to webserver's
`DocumentRoot`. When set, `mod_mbox` will add *Site Index* link on
generated webpages, letting the user fall back to the list of mailing list
archives hosted on the server.

# MboxStyle Directive #

Set archives stylesheet file.
<pre>
    MboxStyle /archives/style.css
</pre>
When set, `mod_mbox` will use this stylesheet file. The path is relative to
the webserver's `DocumentRoot`. This is highly recommended since the
dynamic browser won't work as expected without a correct stylesheet.

The ASF's default stylesheet is bundled with `mod_mbox` sources and
releases. Using it is generally a good start.

# MboxScript Directive #

Set `mod_mbox` 's javascript file.
<pre>
    MboxScript /archives/archives.js
</pre>
When set, you will be able to use `mod_mbox` 's dynamic browsing interface,
an AJAX (Asynchronous Javascript and XML) application. A working javascript
file is bundled with `mod_mbox` , don't forget to copy it if you want to
use it !

# MboxHideEmpty Directive #

Hide empty mailboxes from index listing.
<pre>
    MboxHideEmpty On|Off
</pre>
This directive tells `mod_mbox` to hide empty (with zero message) mailboxes
from his index listings.

Default is *On* 

# MboxAntispam Directive #

Enable email obfuscation.
<pre>
    MboxAntispam On|Off
</pre>
This directive tells `mod_mbox` to enable a content-destructive email
obfuscation, thus avoiding spam to mailing list users. For exemple,
`localpart@localdomain.com` will be converted to
`localp...@localdomain.com`.

Default is *On*