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
commit b808b5e0755d483f01c47349142062670aa63ada
Author: LanKhuat <khuatdang...@gmail.com>
AuthorDate: Fri Mar 13 14:41:46 2020 +0700
JAMES-3072 Add documentation for mailboxes export route in webadmin
---
src/site/markdown/server/manage-webadmin.md | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/src/site/markdown/server/manage-webadmin.md
b/src/site/markdown/server/manage-webadmin.md
index 825b8f9..042752b 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -701,6 +701,7 @@ Warning: During the re-indexing, the result of search
operations might be altere
- [Testing existence of a mailbox](#Testing_existence_of_a_mailbox)
- [Listing user mailboxes](#Listing_user_mailboxes)
- [Deleting user mailboxes](#Deleting_user_mailboxes)
+ - [Exporting user mailboxes](#Exporting_user_mailboxes)
- [ReIndexing a user mails](#ReIndexing_a_user_mails)
- [Recomputing User JMAP fast message view
projection](#Recomputing_User_JMAP_fast_message_view_projection)
@@ -787,6 +788,30 @@ Response codes:
- 204: The user do not have mailboxes anymore
- 404: The user name does not exist
+### Exporting user mailboxes
+
+```
+curl -XPOST http://ip:port/users/{usernameToBeUsed}/mailboxes?action=export
+```
+
+Resource name `usernameToBeUsed` should be an existing user
+
+Response codes:
+
+ - 201: Success. Corresponding task id is returned
+ - 404: The user name does not exist
+
+The scheduled task will have the following type `MailboxesExportTask` and the
following `additionalInformation`:
+
+```
+{
+ "type":"MailboxesExportTask",
+ "timestamp":"2007-12-03T10:15:30Z",
+ "username": "user",
+ "stage": "STARTING"
+}
+```
+
### ReIndexing a user mails
```
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
