You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by ad...@apache.org on 2019/04/17 08:03:39 UTC
[james-project] branch master updated (e0bfaea -> 8d008f5)
This is an automated email from the ASF dual-hosted git repository.
aduprat pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git.
from e0bfaea JAMES-2694 fix unit test for insuring that assertion containsOnlyEntriesMatching is not sensitive to order
new a539b92 JAMES-2714 PreDeletionHook configuration documentation in xdoc config-listeners.xml
new 89a12a2 JAMES-2714 Update dead link in config-webadmin.xml
new 02d492c JAMES-2714 Deleted Messages Vault xdoc configuration documentation
new 8d008f5 JAMES-2714 Link configuration details to howTo
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/homepage/howTo/deleted-messages-vault.html | 6 +++
src/site/xdoc/server/config-listeners.xml | 25 ++++++++++-
src/site/xdoc/server/config-vault.xml | 59 ++++++++++++++++++++++++++
src/site/xdoc/server/config-webadmin.xml | 2 +-
src/site/xdoc/server/config.xml | 6 ++-
5 files changed, 94 insertions(+), 4 deletions(-)
create mode 100644 src/site/xdoc/server/config-vault.xml
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org
[james-project] 02/04: JAMES-2714 Update dead link in
config-webadmin.xml
Posted by ad...@apache.org.
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 89a12a2fdeb2d0fe3d3c9f1881c88a683d27c046
Author: Tran Tien Duc <dt...@linagora.com>
AuthorDate: Wed Apr 10 15:37:51 2019 +0700
JAMES-2714 Update dead link in config-webadmin.xml
---
src/site/xdoc/server/config-webadmin.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/site/xdoc/server/config-webadmin.xml b/src/site/xdoc/server/config-webadmin.xml
index 31ed7de..a651556 100644
--- a/src/site/xdoc/server/config-webadmin.xml
+++ b/src/site/xdoc/server/config-webadmin.xml
@@ -27,7 +27,7 @@
<section name="WebAdmin Configuration">
- <p>Consult <a href="https://github.com/apache/james-project/server/container/guice/memory-guice/sample-configuration/webadmin.properties">webadmin.properties</a> in GIT to get some examples and hints.</p>
+ <p>Consult <a href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/webadmin.properties">webadmin.properties</a> in GIT to get some examples and hints.</p>
<p>Use this configuration to define the WebAdmin's responding host and port.</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org
[james-project] 04/04: JAMES-2714 Link configuration details to
howTo
Posted by ad...@apache.org.
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 8d008f5cc05e03159a03002de871d0b46e6f802e
Author: Tran Tien Duc <dt...@linagora.com>
AuthorDate: Thu Apr 11 14:33:17 2019 +0700
JAMES-2714 Link configuration details to howTo
---
src/homepage/howTo/deleted-messages-vault.html | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/src/homepage/howTo/deleted-messages-vault.html b/src/homepage/howTo/deleted-messages-vault.html
index d4720a5..0cf7d0c 100644
--- a/src/homepage/howTo/deleted-messages-vault.html
+++ b/src/homepage/howTo/deleted-messages-vault.html
@@ -163,6 +163,9 @@ layout: default
urlPrefix=cassandra://var/deletedMessages/vault
retentionPeriod=1 year
</code></pre>
+ <p>
+ More details about configuration & example is at <a href="/server/config-vault.html">Deleted Messages Vault Configuration</a>
+ </p>
<header class="major">
<h3><b>Make James uses Deleted Messages Vault by configuring Pre Deletion Hooks</b></h3>
@@ -188,6 +191,9 @@ layout: default
</preDeletionHook>
</listeners>
</code></pre>
+ <p>
+ More details about configuration & example is at <a href="/server/config-listener.html">Pre Deletion Hook Configuration</a>
+ </p>
<header class="major">
<h3><b>Starting James with enabled Deleted Message Vault by docker compose</b></h3>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org
[james-project] 01/04: JAMES-2714 PreDeletionHook configuration
documentation in xdoc config-listeners.xml
Posted by ad...@apache.org.
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 a539b92703a237cf3e8f1db977d9c2ff2697f52f
Author: Tran Tien Duc <dt...@linagora.com>
AuthorDate: Wed Apr 10 15:34:33 2019 +0700
JAMES-2714 PreDeletionHook configuration documentation in xdoc config-listeners.xml
---
src/site/xdoc/server/config-listeners.xml | 25 +++++++++++++++++++++++--
1 file changed, 23 insertions(+), 2 deletions(-)
diff --git a/src/site/xdoc/server/config-listeners.xml b/src/site/xdoc/server/config-listeners.xml
index ca2f286..3eae89f 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">
+ <section name="Mailbox listeners configuration in general">
<p>
Note: This feature requires Guice wiring. This is not implemented using Spring wiring.<br/>
@@ -40,7 +40,12 @@
<p>To do so, just register the class that needs to be instantiated and added to global listeners. These JAR can be
part of James source code, or provided as an extension and thus should be located in the<code>extensions-jars</code> folder.</p>
+ </section>
+ <section name="MailboxListener configuration">
+ <p>
+ Mailbox listener configuration is under the XML element <listener>
+ </p>
<p>
Some MailboxListener allows you to specify if you want to run them synchronously or asynchronously. To do so,
for MailboxListener that supports this, you can use the <b>async</b> attribute (optional, per mailet default) to govern the execution mode.
@@ -61,7 +66,23 @@
For Cassandra guice wiring. Sends emails to users exceeding 80% and 99% of their quota to warn them</li>
</ul>
</section>
-
+ <section name="PreDeletionHook configuration">
+ <p>
+ Before deleting a message in James, this message and some related information about the deletion will be passed to a set of PreDeletionHook instances,
+ This process is called notifying, and it acts sequentially. If the notifying process for all PreDeletionHooks finish successfully, then the message will be processed to be deleted.
+ Otherwise, that message won't be deleted.
+ </p>
+ <p>
+ Pre Deletion Hook configuration is under the XML element <preDeletionHook>
+ </p>
+ <ul>
+ Already provided additional pre deletion hooks includes:
+ <li>
+ <code>org.apache.james.vault.DeletedMessageVaultHook</code>:
+ Storing messages about being deleted into <code>org.apache.james.vault.DeletedMessageVault</code>
+ </li>
+ </ul>
+ </section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org
[james-project] 03/04: JAMES-2714 Deleted Messages Vault xdoc
configuration documentation
Posted by ad...@apache.org.
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-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org