This is an automated email from the ASF dual-hosted git repository.
aduprat pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 02d492c54843e963e60017a9d8b3a0744da4ade3
Author: Tran Tien Duc <dt...@linagora.com>
AuthorDate: Wed Apr 10 15:51:45 2019 +0700
JAMES-2714 Deleted Messages Vault xdoc configuration documentation
---
src/site/xdoc/server/config-listeners.xml | 2 +-
src/site/xdoc/server/config-vault.xml | 59 +++++++++++++++++++++++++++++++
src/site/xdoc/server/config.xml | 6 +++-
3 files changed, 65 insertions(+), 2 deletions(-)
diff --git a/src/site/xdoc/server/config-listeners.xml
b/src/site/xdoc/server/config-listeners.xml
index 3eae89f..0f9a41c 100644
--- a/src/site/xdoc/server/config-listeners.xml
+++ b/src/site/xdoc/server/config-listeners.xml
@@ -25,7 +25,7 @@
<body>
- <section name="Mailbox listeners configuration in general">
+ <section name="Mailbox listeners configuration overview">
<p>
Note: This feature requires Guice wiring. This is not
implemented using Spring wiring.<br/>
diff --git a/src/site/xdoc/server/config-vault.xml
b/src/site/xdoc/server/config-vault.xml
new file mode 100644
index 0000000..289a339
--- /dev/null
+++ b/src/site/xdoc/server/config-vault.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+<!--
+ 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.
+-->
+<document>
+
+ <properties>
+ <title>Apache James Server 3 - Deleted Messages Vault
Configuration</title>
+ </properties>
+
+ <body>
+
+ <p>
+ Deleted Messages Vault is the component in charge of retaining
messages before they are going to be deleted.
+ Messages stored in the Deleted Messages Vault could be deleted
after exceeding their retentionPeriod (explained below).
+ It also supports to restore or export messages matching with
defined criteria in <a
href="https://james.apache.org/server/manage-webadmin.html#Deleted_Messages_Vault";>WebAdmin
deleted messages vault document</a>
+ by using <a
href="https://james.apache.org/server/manage-webadmin.html#Deleted_Messages_Vault";>WebAdmin
endpoints</a>
+ </p>
+ <section name="Deleted Messages Vault Configuration">
+
+ <p>
+ Note: This feature requires Guice wiring.
+ To make James use DeletedMessageVault, you also need to
configure the PreDeletionHook for it.
+ Example is at <a href="server/config-listeners.html">Mailbox
Listener Configuration</a>
+ </p>
+
+ <subsection name="deletedMessageVault.properties">
+
+ <p>Consult <a
href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/deletedMessageVault.properties";>deletedMessageVault.properties</a>
+ to get some examples and hints.</p>
+ <br/>
+ <dl>
+ <dt><strong>urlPrefix</strong></dt>
+ <dd>Define prefix value of namespace in MailRepository
where deleted messages are stored (default: default mail repository protocol +
var/deletedMessages/vault)</dd>
+
+ <dt><strong>retentionPeriod</strong></dt>
+ <dd>Deleted messages stored in the Deleted Messages Vault
are expired after this period, (default: 1 year)</dd>
+ </dl>
+
+ </subsection>
+ </section>
+ </body>
+
+</document>
diff --git a/src/site/xdoc/server/config.xml b/src/site/xdoc/server/config.xml
index ce19d31..013c4e2 100644
--- a/src/site/xdoc/server/config.xml
+++ b/src/site/xdoc/server/config.xml
@@ -133,7 +133,11 @@
<td><a href="config-webadmin.html">WebAdmin Configuration</a></td>
<td></td>
</tr>
-
+ <tr>
+ <td><a
href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/deletedMessageVault.properties";>deletedMessageVault.properties</a></td>
+ <td><a href="config-vault.html">Deleted Messages Vault
Configuration</a></td>
+ <td></td>
+ </tr>
</table>
<p>For most advanced system configuration, you can configure James for the
following:</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
