[james-project] 13/15: [Refactoring] JavaDoc for sensibleInformationFree

[bt...@apache.org]

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 0b77f72cb02821866a91347de06af1f797d3e69f
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Mon May 11 10:50:14 2020 +0700

    [Refactoring] JavaDoc for sensibleInformationFree
---
 .../api/src/main/java/org/apache/james/mailbox/MessageManager.java   | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java b/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java
index 975c777..1ddd74b 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java
@@ -392,6 +392,11 @@ public interface MessageManager {
             NO_COUNT
         }
 
+        /**
+         * Neutral MailboxMetaData to be safely displayed for mailboxes a user can Lookup without Read write.
+         *
+         * @return MailboxMetaData with default values for all fields
+         */
         public static MailboxMetaData sensibleInformationFree(MailboxACL resolvedAcl, UidValidity uidValidity, boolean writeable, boolean modSeqPermanent) throws MailboxException {
             ImmutableList<MessageUid> recents = ImmutableList.of();
             MessageUid uidNext = MessageUid.MIN_VALUE;


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