You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2022/03/11 05:11:02 UTC
[james-project] 03/03: JAMES-3723 Document reprocessing with consume = false
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 fa12f5ebbec875b7231b29b2a9b9f5343cd0e9da
Author: Benoit Tellier <bt...@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 4ea5dd8..47ec81b 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 2f0f6f0..c7b2496 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-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org