This is an automated email from the ASF dual-hosted git repository. btellier pushed a commit to branch 3.7.x in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 112bf71c95b7ab733d0888f5ecf46d918c2562ea Author: Benoit Tellier <btell...@linagora.com> AuthorDate: Thu Mar 10 16:50:09 2022 +0700 JAMES-3723 Document reprocessing with consume = false --- .../docs/modules/ROOT/pages/operate/webadmin.adoc | 20 ++++++++++++++++---- src/site/markdown/server/manage-webadmin.md | 6 ++++++ 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc index 4ea5dd82d5..47ec81b266 100644 --- a/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc +++ b/server/apps/distributed-app/docs/modules/ROOT/pages/operate/webadmin.adoc @@ -3299,11 +3299,17 @@ For instance: curl -XPATCH http://ip:port/mailRepositories/var%2Fmail%2Ferror%2F/mails?action=reprocess .... -Additional query parameters are supported: - `queue` allows you to +Additional query parameters are supported: + +- `queue` allows you to target the mail queue you want to enqueue the mails in. Defaults to -`spool`. - `processor` allows you to overwrite the state of the +`spool`. +- `processor` allows you to overwrite the state of the reprocessing mails, and thus select the processors they will start their processing in. Defaults to the `state` field of each processed email. +- `consume` (boolean defaulting to `true`) whether the reprocessing should consume the mail in its originating mail repository. Passing +this value to `false` allows non destructive reprocessing as you keep a copy of the email in the mail repository and can be valuable +when debugging. For instance: @@ -3353,11 +3359,17 @@ For instance: curl -XPATCH http://ip:port/mailRepositories/var%2Fmail%2Ferror%2F/mails/name1?action=reprocess .... -Additional query parameters are supported: - `queue` allows you to +Additional query parameters are supported: + +- `queue` allows you to target the mail queue you want to enqueue the mails in. Defaults to -`spool`. - `processor` allows you to overwrite the state of the +`spool`. +- `processor` allows you to overwrite the state of the reprocessing mails, and thus select the processors they will start their processing in. Defaults to the `state` field of each processed email. +- `consume` (boolean defaulting to `true`) whether the reprocessing should consume the mail in its originating mail repository. Passing +this value to `false` allows non destructive reprocessing as you keep a copy of the email in the mail repository and can be valuable +when debugging. While `processor` being an optional parameter, not specifying it will result reprocessing the mails in their current state diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md index 2f0f6f09cf..c7b2496d09 100644 --- a/src/site/markdown/server/manage-webadmin.md +++ b/src/site/markdown/server/manage-webadmin.md @@ -2985,6 +2985,9 @@ Additional query parameters are supported: - `queue` allows you to target the mail queue you want to enqueue the mails in. Defaults to `spool`. - `processor` allows you to overwrite the state of the reprocessing mails, and thus select the processors they will start their processing in. Defaults to the `state` field of each processed email. + - `consume` (boolean defaulting to `true`) whether the reprocessing should consume the mail in its originating mail repository. Passing + this value to `false` allows non destructive reprocessing as you keep a copy of the email in the mail repository and can be valuable + when debugging. For instance: @@ -3034,6 +3037,9 @@ Additional query parameters are supported: - `queue` allows you to target the mail queue you want to enqueue the mails in. Defaults to `spool`. - `processor` allows you to overwrite the state of the reprocessing mails, and thus select the processors they will start their processing in. Defaults to the `state` field of each processed email. + - `consume` (boolean defaulting to `true`) whether the reprocessing should consume the mail in its originating mail repository. Passing + this value to `false` allows non destructive reprocessing as you keep a copy of the email in the mail repository and can be valuable + when debugging. While `processor` being an optional parameter, not specifying it will result reprocessing the mails in their current state ([see documentation about processors and state](https://james.apache.org/server/feature-mailetcontainer.html#Processors)). Consequently, only few cases will give a different result, definitively storing them out of the mail repository. --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@james.apache.org For additional commands, e-mail: notifications-h...@james.apache.org