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 31fb38f8869d1fc21c45d48d9b0f0e8c6a651978 Author: Tung Tran <[email protected]> AuthorDate: Tue Sep 17 12:19:41 2024 +0700 JAMES-4071 - Task fix mailboxes flag inconsistency - document --- .../operate/webadmin/admin-mailboxes-extend.adoc | 64 ++++++++++++++++++++++ src/site/markdown/server/manage-webadmin.md | 63 +++++++++++++++++++++ 2 files changed, 127 insertions(+) diff --git a/docs/modules/servers/pages/distributed/operate/webadmin/admin-mailboxes-extend.adoc b/docs/modules/servers/pages/distributed/operate/webadmin/admin-mailboxes-extend.adoc index 9342dc4341..ecdb8b2006 100644 --- a/docs/modules/servers/pages/distributed/operate/webadmin/admin-mailboxes-extend.adoc +++ b/docs/modules/servers/pages/distributed/operate/webadmin/admin-mailboxes-extend.adoc @@ -224,3 +224,67 @@ task will eventually fix all issues. This task could be run safely online and can be scheduled on a recurring basis outside of peak traffic by an admin to ensure Cassandra message consistency. + + +==== Fixing mailboxes flag inconsistencies + +===== Fixing mailbox messages deleted flag inconsistencies + +This task is only available on top of Guice Cassandra products. + +.... +curl -XPOST /mailboxes?task=SolveMessageDeletedInconsistencies +.... + +Will schedule a task for fixing mailbox messages `deleted` flag inconsistencies created by the +mailbox denormalization process. + +Response codes: + +* 201: Success. Corresponding task id is returned. +* 400: Error in the request. Details can be found in the reported error. + +The scheduled task will have the following type +`solve-mailbox-flag-inconsistencies` and the following +`additionalInformation` example: + +.... +{ + "timestamp": "2024-09-17T04:58:33.683813161Z", + "type": "solve-mailbox-flag-inconsistencies", + "processedMailboxEntries": 1, + "errors": ["551f0580-82fb-11ea-970e-f9c83d4cf8c2"], + "targetFlag": "DELETED" +} +.... + + +===== Fixing mailbox messages recent flag inconsistencies + +This task is only available on top of Guice Cassandra products. + +.... +curl -XPOST /mailboxes?task=SolveMessageRecentInconsistencies +.... + +Will schedule a task for fixing mailbox messages `recent` flag inconsistencies created by the +mailbox denormalization process. + +Response codes: + +* 201: Success. Corresponding task id is returned. +* 400: Error in the request. Details can be found in the reported error. + +The scheduled task will have the following type +`solve-mailbox-flag-inconsistencies` and the following +`additionalInformation` example: + +.... +{ + "timestamp": "2024-09-17T04:59:10.042097161Z", + "type": "solve-mailbox-flag-inconsistencies", + "processedMailboxEntries": 2, + "errors": ["551f0580-82fb-11ea-970e-f9c83d4cf8c2"], + "targetFlag": "RECENT" +} +.... \ No newline at end of file diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md index 2fb22542b7..64586fc297 100644 --- a/src/site/markdown/server/manage-webadmin.md +++ b/src/site/markdown/server/manage-webadmin.md @@ -857,6 +857,69 @@ firewall rules. Due to all of those risks, a `I-KNOW-WHAT-I-M-DOING` header should be positioned to `ALL-SERVICES-ARE-OFFLINE` in order to prevent accidental calls. + +#### Fixing mailboxes flag inconsistencies + +##### Fixing mailbox messages deleted flag inconsistencies + +This task is only available on top of Guice Cassandra products. + +```bash +curl -XPOST /messages?task=SolveMessageDeletedInconsistencies +``` + +Will schedule a task for fixing mailbox messages `deleted` flag inconsistencies created by the +mailbox denormalization process. + +Response codes: + +* 201: Success. Corresponding task id is returned. +* 400: Error in the request. Details can be found in the reported error. + +The scheduled task will have the following type +`solve-mailbox-flag-inconsistencies` and the following +`additionalInformation` example: + +```json +{ +"timestamp": "2024-09-17T04:58:33.683813161Z", +"type": "solve-mailbox-flag-inconsistencies", +"processedMailboxEntries": 1, +"errors": ["551f0580-82fb-11ea-970e-f9c83d4cf8c2"], +"targetFlag": "DELETED" +} +``` + +##### Fixing mailbox messages recent flag inconsistencies + +This task is only available on top of Guice Cassandra products. + +```bash +curl -XPOST /messages?task=SolveMessageRecentInconsistencies +``` + +Will schedule a task for fixing mailbox messages `recent` flag inconsistencies created by the +mailbox denormalization process. + +Response codes: + +* 201: Success. Corresponding task id is returned. +* 400: Error in the request. Details can be found in the reported error. + +The scheduled task will have the following type +`solve-mailbox-flag-inconsistencies` and the following +`additionalInformation` example: + +```json +{ +"timestamp": "2024-09-17T04:59:10.042097161Z", +"type": "solve-mailbox-flag-inconsistencies", +"processedMailboxEntries": 2, +"errors": ["551f0580-82fb-11ea-970e-f9c83d4cf8c2"], +"targetFlag": "RECENT" +} +``` + #### Recomputing mailbox counters This task is only available on top of Guice Cassandra products. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
