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 c8f84a8a5b769eef9b0859fb22fa0f17238fc639 Author: datph <dphamho...@linagora.com> AuthorDate: Fri Apr 5 16:43:19 2019 +0700 JAMES-2710 Document Purge API --- src/site/markdown/server/manage-webadmin.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md index da75144..98ef7fb 100644 --- a/src/site/markdown/server/manage-webadmin.md +++ b/src/site/markdown/server/manage-webadmin.md @@ -2643,6 +2643,7 @@ Here are the following actions available on the 'Deleted Messages Vault' - [Restore Deleted Messages](#Restore_deleted_messages) - [Export Deleted Messages](#Export_deleted_messages) + - [Purge Deleted Messages](#Purge_deleted_messages) Note that the 'Deleted Messages Vault' feature is only supported on top of Cassandra-Guice. @@ -2816,6 +2817,29 @@ while: - userExportFrom: export deleted messages from this user - exportTo: content of deleted messages have been shared to this mail address - totalExportedMessages: number of deleted messages match with json query, then being shared to sharee + +### Purge Deleted Messages + +You can overwrite 'retentionPeriod' configuration in deletedMessageVault or use default value is 1 year. + +Delete all expired deleted messages with 'retentionPeriod' configured. + +``` +curl -XDEL http://ip:port/deletedMessages?scope=expired +``` + +Response code: + + - 201: Task for purging has been created + - 400: Bad request: + - action query param is not present + - action query param is not a valid action + +You may want to call this endpoint on a regular basis. Example: + +``` +0 0 * * * /usr/bin/curl --request POST http://ip:port/deletedMessages?action=purge >/dev/null 2>&1 +``` ## Task management --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org