[jira] [Reopened] (JAMES-2714) Document SuperTrash

2019-04-17 Thread Rene Cordier (JIRA)


 [ 
https://issues.apache.org/jira/browse/JAMES-2714?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Rene Cordier reopened JAMES-2714:
-

One or two other docs are still not finished yet

> Document SuperTrash
> ---
>
> Key: JAMES-2714
> URL: https://issues.apache.org/jira/browse/JAMES-2714
> Project: James Server
>  Issue Type: New Feature
>Reporter: Rene Cordier
>Priority: Major
> Fix For: 3.4.0
>
>
> We need to write a proper documentation that will serve to explain to the 
> Apache community :
> * why we need a vault for email retention
> * what are the mechanisms involved in it
> * how can we use it
> * tutorial on configuration
> * detailed documentation page in the mailbox website.
> * medium article about this feature.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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



[jira] [Resolved] (JAMES-2714) Document SuperTrash

2019-04-17 Thread Antoine Duprat (JIRA)


 [ 
https://issues.apache.org/jira/browse/JAMES-2714?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Antoine Duprat resolved JAMES-2714.
---
Resolution: Fixed

merged

> Document SuperTrash
> ---
>
> Key: JAMES-2714
> URL: https://issues.apache.org/jira/browse/JAMES-2714
> Project: James Server
>  Issue Type: New Feature
>Reporter: Rene Cordier
>Priority: Major
> Fix For: 3.4.0
>
>
> We need to write a proper documentation that will serve to explain to the 
> Apache community :
> * why we need a vault for email retention
> * what are the mechanisms involved in it
> * how can we use it
> * tutorial on configuration
> * detailed documentation page in the mailbox website.
> * medium article about this feature.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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



[jira] [Closed] (JAMES-2714) Document SuperTrash

2019-04-17 Thread Antoine Duprat (JIRA)


 [ 
https://issues.apache.org/jira/browse/JAMES-2714?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Antoine Duprat closed JAMES-2714.
-

> Document SuperTrash
> ---
>
> Key: JAMES-2714
> URL: https://issues.apache.org/jira/browse/JAMES-2714
> Project: James Server
>  Issue Type: New Feature
>Reporter: Rene Cordier
>Priority: Major
> Fix For: 3.4.0
>
>
> We need to write a proper documentation that will serve to explain to the 
> Apache community :
> * why we need a vault for email retention
> * what are the mechanisms involved in it
> * how can we use it
> * tutorial on configuration
> * detailed documentation page in the mailbox website.
> * medium article about this feature.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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



[james-project] 01/04: JAMES-2714 PreDeletionHook configuration documentation in xdoc config-listeners.xml

2019-04-17 Thread aduprat
This is an automated email from the ASF dual-hosted git repository.

aduprat pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit a539b92703a237cf3e8f1db977d9c2ff2697f52f
Author: Tran Tien Duc 
AuthorDate: Wed Apr 10 15:34:33 2019 +0700

JAMES-2714 PreDeletionHook configuration documentation in xdoc 
config-listeners.xml
---
 src/site/xdoc/server/config-listeners.xml | 25 +++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/src/site/xdoc/server/config-listeners.xml 
b/src/site/xdoc/server/config-listeners.xml
index ca2f286..3eae89f 100644
--- a/src/site/xdoc/server/config-listeners.xml
+++ b/src/site/xdoc/server/config-listeners.xml
@@ -25,7 +25,7 @@
 
 
 
-
+
 
 
   Note: This feature requires Guice wiring. This is not 
implemented using Spring wiring.
@@ -40,7 +40,12 @@
 
 To do so, just register the class that needs to be instantiated 
and added to global listeners. These JAR can be
part of James source code, or provided as an extension and thus 
should be located in theextensions-jars folder.
+
 
+
+
+Mailbox listener configuration is under the XML element 

+
 
 Some MailboxListener allows you to specify if you want to run 
them synchronously or asynchronously. To do so,
 for MailboxListener that supports this, you can use the 
async attribute (optional, per mailet default) to govern the execution 
mode.
@@ -61,7 +66,23 @@
  For Cassandra guice wiring. Sends emails to users 
exceeding 80% and 99% of their quota to warn them
 
 
-
+
+
+Before deleting a message in James, this message and some 
related information about the deletion will be passed to a set of 
PreDeletionHook instances,
+This process is called notifying, and it acts sequentially. If 
the notifying process for all PreDeletionHooks finish successfully, then the 
message will be processed to be deleted.
+Otherwise, that message won't be deleted.
+
+
+Pre Deletion Hook configuration is under the XML element 

+
+
+Already provided additional pre deletion hooks includes:
+
+
org.apache.james.vault.DeletedMessageVaultHook:
+Storing messages about being deleted into 
org.apache.james.vault.DeletedMessageVault
+
+
+
 
 
 


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



[james-project] 03/04: JAMES-2714 Deleted Messages Vault xdoc configuration documentation

2019-04-17 Thread aduprat
This is an automated email from the ASF dual-hosted git repository.

aduprat pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit 02d492c54843e963e60017a9d8b3a0744da4ade3
Author: Tran Tien Duc 
AuthorDate: Wed Apr 10 15:51:45 2019 +0700

JAMES-2714 Deleted Messages Vault xdoc configuration documentation
---
 src/site/xdoc/server/config-listeners.xml |  2 +-
 src/site/xdoc/server/config-vault.xml | 59 +++
 src/site/xdoc/server/config.xml   |  6 +++-
 3 files changed, 65 insertions(+), 2 deletions(-)

diff --git a/src/site/xdoc/server/config-listeners.xml 
b/src/site/xdoc/server/config-listeners.xml
index 3eae89f..0f9a41c 100644
--- a/src/site/xdoc/server/config-listeners.xml
+++ b/src/site/xdoc/server/config-listeners.xml
@@ -25,7 +25,7 @@
 
 
 
-
+
 
 
   Note: This feature requires Guice wiring. This is not 
implemented using Spring wiring.
diff --git a/src/site/xdoc/server/config-vault.xml 
b/src/site/xdoc/server/config-vault.xml
new file mode 100644
index 000..289a339
--- /dev/null
+++ b/src/site/xdoc/server/config-vault.xml
@@ -0,0 +1,59 @@
+
+
+
+
+
+Apache James Server 3 - Deleted Messages Vault 
Configuration
+
+
+
+
+
+Deleted Messages Vault is the component in charge of retaining 
messages before they are going to be deleted.
+Messages stored in the Deleted Messages Vault could be deleted 
after exceeding their retentionPeriod (explained below).
+It also supports to restore or export messages matching with 
defined criteria in https://james.apache.org/server/manage-webadmin.html#Deleted_Messages_Vault";>WebAdmin
 deleted messages vault document
+by using https://james.apache.org/server/manage-webadmin.html#Deleted_Messages_Vault";>WebAdmin
 endpoints
+
+
+
+
+Note: This feature requires Guice wiring.
+To make James use DeletedMessageVault, you also need to 
configure the PreDeletionHook for it.
+Example is at Mailbox 
Listener Configuration
+
+
+
+
+Consult https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/deletedMessageVault.properties";>deletedMessageVault.properties
+to get some examples and hints.
+
+
+urlPrefix
+Define prefix value of namespace in MailRepository 
where deleted messages are stored (default: default mail repository protocol + 
var/deletedMessages/vault)
+
+retentionPeriod
+Deleted messages stored in the Deleted Messages Vault 
are expired after this period, (default: 1 year)
+
+
+
+
+
+
+
diff --git a/src/site/xdoc/server/config.xml b/src/site/xdoc/server/config.xml
index ce19d31..013c4e2 100644
--- a/src/site/xdoc/server/config.xml
+++ b/src/site/xdoc/server/config.xml
@@ -133,7 +133,11 @@
 WebAdmin Configuration
 
   
-
+  
+https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/deletedMessageVault.properties";>deletedMessageVault.properties
+Deleted Messages Vault 
Configuration
+
+  
 
 
 For most advanced system configuration, you can configure James for the 
following:


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



[james-project] branch master updated (e0bfaea -> 8d008f5)

2019-04-17 Thread aduprat
This is an automated email from the ASF dual-hosted git repository.

aduprat pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git.


from e0bfaea  JAMES-2694 fix unit test for insuring that assertion 
containsOnlyEntriesMatching is not sensitive to order
 new a539b92  JAMES-2714 PreDeletionHook configuration documentation in 
xdoc config-listeners.xml
 new 89a12a2  JAMES-2714 Update dead link in config-webadmin.xml
 new 02d492c  JAMES-2714 Deleted Messages Vault xdoc configuration 
documentation
 new 8d008f5  JAMES-2714 Link configuration details to howTo

The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 src/homepage/howTo/deleted-messages-vault.html |  6 +++
 src/site/xdoc/server/config-listeners.xml  | 25 ++-
 src/site/xdoc/server/config-vault.xml  | 59 ++
 src/site/xdoc/server/config-webadmin.xml   |  2 +-
 src/site/xdoc/server/config.xml|  6 ++-
 5 files changed, 94 insertions(+), 4 deletions(-)
 create mode 100644 src/site/xdoc/server/config-vault.xml


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



[james-project] 04/04: JAMES-2714 Link configuration details to howTo

2019-04-17 Thread aduprat
This is an automated email from the ASF dual-hosted git repository.

aduprat pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit 8d008f5cc05e03159a03002de871d0b46e6f802e
Author: Tran Tien Duc 
AuthorDate: Thu Apr 11 14:33:17 2019 +0700

JAMES-2714 Link configuration details to howTo
---
 src/homepage/howTo/deleted-messages-vault.html | 6 ++
 1 file changed, 6 insertions(+)

diff --git a/src/homepage/howTo/deleted-messages-vault.html 
b/src/homepage/howTo/deleted-messages-vault.html
index d4720a5..0cf7d0c 100644
--- a/src/homepage/howTo/deleted-messages-vault.html
+++ b/src/homepage/howTo/deleted-messages-vault.html
@@ -163,6 +163,9 @@ layout: default
 urlPrefix=cassandra://var/deletedMessages/vault
 retentionPeriod=1 year
 
+
+More details about configuration & example is at Deleted Messages Vault Configuration
+
 
 
 Make James uses Deleted Messages Vault by 
configuring Pre Deletion Hooks
@@ -188,6 +191,9 @@ layout: default
 
 
 
+
+More details about configuration & example is at Pre Deletion Hook Configuration
+
 
 
 Starting James with enabled Deleted Message 
Vault by docker compose


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



[james-project] 02/04: JAMES-2714 Update dead link in config-webadmin.xml

2019-04-17 Thread aduprat
This is an automated email from the ASF dual-hosted git repository.

aduprat pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit 89a12a2fdeb2d0fe3d3c9f1881c88a683d27c046
Author: Tran Tien Duc 
AuthorDate: Wed Apr 10 15:37:51 2019 +0700

JAMES-2714 Update dead link in config-webadmin.xml
---
 src/site/xdoc/server/config-webadmin.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/site/xdoc/server/config-webadmin.xml 
b/src/site/xdoc/server/config-webadmin.xml
index 31ed7de..a651556 100644
--- a/src/site/xdoc/server/config-webadmin.xml
+++ b/src/site/xdoc/server/config-webadmin.xml
@@ -27,7 +27,7 @@
 
   
 
-Consult https://github.com/apache/james-project/server/container/guice/memory-guice/sample-configuration/webadmin.properties";>webadmin.properties
 in GIT to get some examples and hints.
+Consult https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/webadmin.properties";>webadmin.properties
 in GIT to get some examples and hints.
 
 Use this configuration to define the WebAdmin's responding host and 
port.
 


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