JAMES-2266 Add documentation for ghost mailbox correction

Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/800e88fa
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/800e88fa
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/800e88fa

Branch: refs/heads/master
Commit: 800e88fa8176f811ede932102a036044e5faa24b
Parents: 8da3ad0
Author: benwa <[email protected]>
Authored: Wed Dec 20 14:04:02 2017 +0700
Committer: benwa <[email protected]>
Committed: Fri Jan 5 16:06:36 2018 +0700

----------------------------------------------------------------------
 src/site/markdown/server/manage-webadmin.md | 44 ++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/800e88fa/src/site/markdown/server/manage-webadmin.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/server/manage-webadmin.md 
b/src/site/markdown/server/manage-webadmin.md
index d73651f..ed67ae0 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -466,6 +466,50 @@ The scheduled task will have the following type 
`CassandraMigration` and the fol
 {"toVersion":2}
 ```
 
+## Correcting ghost mailbox
+
+This is a temporary workaround for the **Ghost mailbox** bug encountered using 
the Cassandra backend, as described in MAILBOX-322.
+
+You can use the mailbox merging feature in order to merge the old "ghosted" 
mailbox with the new one.
+
+```
+curl -XPOST http://ip:port/cassandra/mailbox/merging -d '{"mergeOrigin":"id1", 
"mergeDestination":"id2"}'
+```
+
+Will scedule a task for :
+
+ - Delete references to `id1` mailbox
+ - Move it's messages into `id2` mailbox
+ - Union the rights of both mailboxes
+
+The response to that request will be the scheduled `taskId` :
+
+```
+{"taskId":"5641376-02ed-47bd-bcc7-76ff6262d92a"}
+```
+
+Positionned headers:
+
+ - Location header indicates the location of the resource associated with the 
scheduled task. Example:
+
+```
+Location: /tasks/3294a976-ce63-491e-bd52-1b6f465ed7a2
+```
+
+Response codes:
+
+ - 201: Success. Corresponding task id is returned.
+ - 400: Unable to parse the body.
+
+The scheduled task will have the following type `mailboxMerging` and the 
following `additionalInformation`:
+
+```
+{
+  "oldMailboxId":"5641376-02ed-47bd-bcc7-76ff6262d92a",
+  "newMailboxId":"4555159-52ae-895f-ccb7-586a4412fb50"
+}
+```
+
 ## Creating address group
 
 You can use **webadmin** to define address groups.


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to