[james-project] 04/23: JAMES-2685 DMV Route webadmin markdown

[bt...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit c0c1ca3d89b277de9a9320cc18340d3248babb34
Author: Tran Tien Duc <dt...@linagora.com>
AuthorDate: Mon Mar 18 13:08:47 2019 +0700

    JAMES-2685 DMV Route webadmin markdown
---
 src/site/markdown/server/manage-webadmin.md | 42 +++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md
index f3a65f3..55e6e41 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -2552,6 +2552,7 @@ To move deleted messages in the vault, you need to specifically configure the De
 Here are the following actions available on the 'Deleted Messages Vault'
 
  - [Restore Deleted Messages](#Restore_deleted_messages)
+ - [Export Deleted Messages](#Export_deleted_messages)
 
  Note that the 'Deleted Messages Vault' feature is only supported on top of Cassandra-Guice.
 
@@ -2669,6 +2670,7 @@ Response code:
    - can not parse the JSON body
    - Json query object contains unsupported operator, fieldName
    - Json query object values violate parsing rules 
+ - 404: User not found
 
 The scheduled task will have the following type `deletedMessages/restore` and the following `additionalInformation`:
 
@@ -2685,6 +2687,46 @@ while:
  - errorRestoreCount: number of messages that failed to restore
  - user: owner of deleted messages need to restore
 
+### Export Deleted Messages
+
+Retrieve deleted messages matched with requested query from an user then share the content to a targeted mail address (exportTo)
+
+```
+curl -XPOST http://ip:port/deletedMessages/user/userExportFrom@domain.ext?action=export&exportTo=userReceiving@domain.ext
+
+BODY: is the json query has the same structure with Restore Deleted Messages section
+```
+**Note**: Json query passing into the body follows the same rules & restrictions like in [Restore Deleted Messages](#Restore_deleted_messages)
+
+Response code:
+
+ - 201: Task for exporting has been created
+ - 400: Bad request: 
+   - exportTo query param is not present
+   - exportTo query param is not a valid mail address
+   - action query param is not present
+   - action query param is not a valid action
+   - user parameter is invalid
+   - can not parse the JSON body
+   - Json query object contains unsupported operator, fieldName
+   - Json query object values violate parsing rules 
+ - 404: User not found
+
+The scheduled task will have the following type `deletedMessages/export` and the following `additionalInformation`:
+
+```
+{
+  "userExportFrom": "userToRestore@domain.ext",
+  "exportTo": "userReceiving@domain.ext",
+  "totalExportedMessages": 1432
+}
+```
+
+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
+
 ## Task management
 
 Some webadmin features schedules tasks. The task management API allow to monitor and manage the execution of the following tasks.


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org