| <?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 need to configure the PreDeletionHook for it. |
| Example is at <a href="/server/config-listeners.html">Mailbox Listener Configuration</a> |
| </p> |
| |
| <p> |
| The Deleted Messages Vault also stores and manages deleted messages into a BlobStore. The BlobStore can be either |
| based on an object storage or on Cassandra. For configuring the BlobStore the vault will use, you can look at |
| <a href="/server/config-blobstore.xml">BlobStore Configuration</a>. |
| </p> |
| |
| <subsection name="deletedMessageVault.properties"> |
| |
| <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>retentionPeriod</strong></dt> |
| <dd> |
| Deleted messages stored in the Deleted Messages Vault are expired after this period (default: 1 year). |
| It can be expressed in <b>y</b> years, <b>d</b> days, <b>h</b> hours, ... |
| </dd> |
| </dl> |
| <dl> |
| <dt><strong>restoreLocation</strong></dt> |
| <dd> |
| Messages restored from the Deleted Messages Vault are placed in a mailbox with this name (default: <code>Restored-Messages</code>>). |
| The mailbox will be created if it does not exist yet. |
| </dd> |
| </dl> |
| |
| </subsection> |
| </section> |
| </body> |
| |
| </document> |
