You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2018/12/13 02:48:30 UTC

[4/6] james-project git commit: Document MailboxListener related changes

Document MailboxListener related changes


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

Branch: refs/heads/master
Commit: c03515b0ae9f6a426ca355cbb8f0f80e7270bf84
Parents: eba7e5b
Author: Benoit Tellier <bt...@linagora.com>
Authored: Mon Dec 10 11:14:48 2018 +0700
Committer: Benoit Tellier <bt...@linagora.com>
Committed: Thu Dec 13 09:46:50 2018 +0700

----------------------------------------------------------------------
 CHANGELOG.md            |  1 +
 upgrade-instructions.md | 27 +++++++++++++++++++++++++++
 2 files changed, 28 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/c03515b0/CHANGELOG.md
----------------------------------------------------------------------
diff --git a/CHANGELOG.md b/CHANGELOG.md
index cfe0fe5..67725c3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
 ### Changed
 - WebAdmin ReIndexing API had been reworked
+- MailboxListener and mailbox event system was reworked. Custom listeners will need to be adapted. Please see Upgrade instuctions.
 
 ### Removed
 - Drop HBase and JCR components (mailbox and server/data).

http://git-wip-us.apache.org/repos/asf/james-project/blob/c03515b0/upgrade-instructions.md
----------------------------------------------------------------------
diff --git a/upgrade-instructions.md b/upgrade-instructions.md
index 0a1fd3c..38c6fc2 100644
--- a/upgrade-instructions.md
+++ b/upgrade-instructions.md
@@ -18,6 +18,33 @@ Change list:
 
  - [Changes in WebAdmin reIndexing API](#changes-in-webadmin-reindexing-api)
 
+### Changes to the MailboxListener API
+
+#### Persistent MailboxId for MailDir
+
+Date: 30/11/2018
+
+SHA-1: 7e32da51a29bee1c732b2b13708bb4b986140119
+
+JIRA: https://issues.apache.org/jira/browse/MAILBOX-292
+
+MailboxId are now persisted in a `james-mailboxId` file. This file is created on the fly, so no action is required for users relying on
+the MailDir mailbox.
+
+#### Registration by MailboxId
+
+Date: 30/11/2018
+
+SHA-1: d9bcebc7dd546bd5f11f3d9b496491e7c9042fe2
+
+JIRA: https://issues.apache.org/jira/browse/MAILBOX-354
+
+Only user written components performing MailboxListener registration will be affected.
+
+The MailboxPath is mutable and thus can be changed upon mailbox rename. This leads to significantly complex code with possible inconsistency windows.
+
+Using the mailboxId, which is immutable, solves these issues.
+
 ### Changes in WebAdmin reIndexing API
 
 Date: 05/12/2018


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org