This is an automated email from the ASF dual-hosted git repository.
rcordier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
The following commit(s) were added to refs/heads/master by this push:
new d0aa047de3 Add missing doc and options for the deleted message vault
d0aa047de3 is described below
commit d0aa047de30d5683b87b9ca21b9de448cc077a55
Author: Rene Cordier <[email protected]>
AuthorDate: Wed Aug 28 16:49:15 2024 +0700
Add missing doc and options for the deleted message vault
---
.../modules/servers/pages/distributed/configure/vault.adoc | 6 ++++++
.../sample-configuration/deletedMessageVault.properties | 10 +++++++++-
.../sample-configuration/deletedMessageVault.properties | 10 +++++++++-
.../sample-configuration/deletedMessageVault.properties | 4 ++++
src/site/xdoc/server/config-vault.xml | 14 ++++++++++++++
5 files changed, 42 insertions(+), 2 deletions(-)
diff --git a/docs/modules/servers/pages/distributed/configure/vault.adoc
b/docs/modules/servers/pages/distributed/configure/vault.adoc
index b65a4c347d..2f7a4836a8 100644
--- a/docs/modules/servers/pages/distributed/configure/vault.adoc
+++ b/docs/modules/servers/pages/distributed/configure/vault.adoc
@@ -24,6 +24,12 @@ to get some examples and hints.
|===
| Property name | explanation
+| enabled
+| Allows to enable or disable usage of the Deleted Message Vault. Default to
false.
+
+| workQueueEnabled
+| Enable work queue to be used with deleted message vault. Default to false.
+
| retentionPeriod
| Deleted messages stored in the Deleted Messages Vault are expired after this
period (default: 1 year). It can be expressed in *y* years, *d* days, *h*
hours, ...
diff --git
a/server/apps/cassandra-app/sample-configuration/deletedMessageVault.properties
b/server/apps/cassandra-app/sample-configuration/deletedMessageVault.properties
index a6df89a227..71b344ad27 100644
---
a/server/apps/cassandra-app/sample-configuration/deletedMessageVault.properties
+++
b/server/apps/cassandra-app/sample-configuration/deletedMessageVault.properties
@@ -2,6 +2,14 @@
enabled=false
+# Enable work queue to be used with deleted message vault
+# Default to false
+# workQueueEnabled=false
+
# Retention period for your deleted messages into the vault, after which they
expire and can be potentially cleaned up
# Optional, default 1y
-# retentionPeriod=1y
\ No newline at end of file
+# retentionPeriod=1y
+
+# Messages restored from the Deleted Messages Vault are placed in a mailbox
with this name (default: ``Restored-Messages``).
+# The mailbox will be created if it does not exist yet.
+# restoreLocation=Restored-Messages
\ No newline at end of file
diff --git
a/server/apps/distributed-app/sample-configuration/deletedMessageVault.properties
b/server/apps/distributed-app/sample-configuration/deletedMessageVault.properties
index a6df89a227..71b344ad27 100644
---
a/server/apps/distributed-app/sample-configuration/deletedMessageVault.properties
+++
b/server/apps/distributed-app/sample-configuration/deletedMessageVault.properties
@@ -2,6 +2,14 @@
enabled=false
+# Enable work queue to be used with deleted message vault
+# Default to false
+# workQueueEnabled=false
+
# Retention period for your deleted messages into the vault, after which they
expire and can be potentially cleaned up
# Optional, default 1y
-# retentionPeriod=1y
\ No newline at end of file
+# retentionPeriod=1y
+
+# Messages restored from the Deleted Messages Vault are placed in a mailbox
with this name (default: ``Restored-Messages``).
+# The mailbox will be created if it does not exist yet.
+# restoreLocation=Restored-Messages
\ No newline at end of file
diff --git
a/server/apps/distributed-pop3-app/sample-configuration/deletedMessageVault.properties
b/server/apps/distributed-pop3-app/sample-configuration/deletedMessageVault.properties
index 47ec56c5c4..40873db544 100644
---
a/server/apps/distributed-pop3-app/sample-configuration/deletedMessageVault.properties
+++
b/server/apps/distributed-pop3-app/sample-configuration/deletedMessageVault.properties
@@ -2,6 +2,10 @@
enabled=false
+# Enable work queue to be used with deleted message vault
+# Default to false
+# workQueueEnabled=false
+
# Retention period for your deleted messages into the vault, after which they
expire and can be potentially cleaned up
# Optional, default 1y
# retentionPeriod=1y
diff --git a/src/site/xdoc/server/config-vault.xml
b/src/site/xdoc/server/config-vault.xml
index fb5bcb922e..25d5b809fa 100644
--- a/src/site/xdoc/server/config-vault.xml
+++ b/src/site/xdoc/server/config-vault.xml
@@ -50,6 +50,20 @@
<p>Consult <a
href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/deletedMessageVault.properties";>deletedMessageVault.properties</a>
to get some examples and hints.</p>
<br/>
+ <dl>
+ <dt><strong>enabled</strong></dt>
+ <dd>
+ Allows to enable or disable usage of the Deleted
Message Vault.
+ Default to false.
+ </dd>
+ </dl>
+ <dl>
+ <dt><strong>workQueueEnabled</strong></dt>
+ <dd>
+ Enable work queue to be used with deleted message
vault.
+ Default to false.
+ </dd>
+ </dl>
<dl>
<dt><strong>retentionPeriod</strong></dt>
<dd>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
