Repository: james-project Updated Branches: refs/heads/master 27fd46dc4 -> 6f6513dff
JAMES-2293 Add more explanations about the Mail Repository feature. Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/4c525bcb Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/4c525bcb Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/4c525bcb Branch: refs/heads/master Commit: 4c525bcba294572d4150f3c02a45434beb6e3cd3 Parents: c702d05 Author: benwa <[email protected]> Authored: Thu Jan 25 13:38:54 2018 +0700 Committer: benwa <[email protected]> Committed: Tue Jan 30 16:49:38 2018 +0700 ---------------------------------------------------------------------- src/site/xdoc/server/feature-persistence.xml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/4c525bcb/src/site/xdoc/server/feature-persistence.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/server/feature-persistence.xml b/src/site/xdoc/server/feature-persistence.xml index 7f70ff6..4c8c1a2 100644 --- a/src/site/xdoc/server/feature-persistence.xml +++ b/src/site/xdoc/server/feature-persistence.xml @@ -51,6 +51,24 @@ </subsection> <subsection name="Mail Repository Store Persistence"> + + <p>Mail repository allow the administrator to store mail being processed in the mailet-container. The mails are typically + added by the <strong>ToRepository</strong> mailet. Then for Guice wiring <a href="manage-webadmin.html">webAdmin</a> API allows to read, delete and + reprocess these mails.</p> + + <p> + Typical use cases might be: + <ul> + <li>Error management: mails can be stored if an error is encountered during the mail processing, be the error caused by a bug, + a configuration mistake, a parsing error, temporary unavailable services. Reprocessing the mails once the problem fixed allows to + avoid data loss. Note that you can use mail repositories of different types on the same James server in order to not + be dependant from a single data-store.</li> + <li>Debugging: MDC context allows to follow mail processing, and isolate logs of a single mail. You can then configure + James in order to collect all mails processed in one part of your pipeline, and thus better understand this one.</li> + <li>Data collection: Collect spam, suspicious mails and much more. You can then later on analyze them or for instance train + your anti-spam system.</li> + </ul> + </p> <p>Available Mail Repository Store are defined in mailrepositorystore.xml. Each has an URL prefix (file, db, dbfile,...) that can be used in mailetcontainer.xml --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
