Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/imap/ImapService.java

@@ -101,7 +101,6 @@ public interface ImapService
      * 
      * @param user User making the request.
      * @param mailboxName String name of the target,
-     * @throws com.icegreen.greenmail.store.FolderException if mailbox has a non-selectable store with children
      */
     public void deleteMailbox(AlfrescoImapUser user, String mailboxName);
 
@@ -189,14 +188,14 @@ public interface ImapService
 //    public List<FileInfo> searchFolders(NodeRef contextNodeRef, String namePattern, boolean includeSubFolders, ImapViewMode viewMode);
 
     /**
-     * Search for emails in specified folder depend on view mode.
-     * 
-     * @param contextNodeRef context folder for search
-     * @param contextNodeRef context NodeRef
-     * @param viewMode (ARCHIVE, MIXED or VIRTUAL)
-     * @return list of emails that context folder contains.
-     */
-    public FolderStatus getFolderStatus(final String userName, final NodeRef contextNodeRef, ImapViewMode viewMode);
+     * Search for emails in specified folder depend on view mode.
+     * 
+     * @param userName user name
+     * @param contextNodeRef context NodeRef
+     * @param viewMode (ARCHIVE, MIXED or VIRTUAL)
+     * @return list of emails that context folder contains.
+     */
+    public FolderStatus getFolderStatus(final String userName, final NodeRef contextNodeRef, ImapViewMode viewMode);
 
     /**
      * Gets a cached MIME message for the given file, complete with message body.
@@ -221,30 +220,30 @@ public interface ImapService
      */
     public void expungeMessage(FileInfo messageFileInfo);    
 
-    /**
-     * Return flags that belong to the specified imap folder.
-     * 
-     * @param messageFileInfo imap folder info.
-     * @return flags.
-     */
-    public Flags getFlags(FileInfo messageFileInfo);
+    /**
+     * Return flags that belong to the specified imap folder.
+     * 
+     * @param messageFileInfo imap folder info.
+     * @return flags.
+     */
+    public Flags getFlags(FileInfo messageFileInfo);
 
-    /**
-     * Set flags to the specified imapFolder.
-     * 
-     * @param messageFileInfo FileInfo of imap Folder.
-     * @param flags flags to set.
-     * @param value value to set.
-     */
+    /**
+     * Set flags to the specified imapFolder.
+     * 
+     * @param messageFileInfo FileInfo of imap Folder.
+     * @param flags flags to set.
+     * @param value value to set.
+     */
     public void setFlags(FileInfo messageFileInfo, Flags flags, boolean value);
 
-    /**
-     * Set flag to the specified imapFolder.
-     * 
-     * @param messageFileInfo FileInfo of imap Folder
-     * @param flag flag to set.
-     * @param value value value to set.
-     */
+    /**
+     * Set flag to the specified imapFolder.
+     * 
+     * @param messageFileInfo FileInfo of imap Folder
+     * @param flag flag to set.
+     * @param value value value to set.
+     */
     public void setFlag(FileInfo messageFileInfo, Flag flag, boolean value);
 
     /**
@@ -276,13 +275,13 @@ public interface ImapService
      * Returns a template for email body. It is either classpath path or NodeRef.toString().
      * This method trying to find a template on the path in the repository first
      * e.g. {@code "Data Dictionary > IMAP Templates >"}. This path should be set as the property of the "imapHelper" bean.
-     * In this case it returns {@code NodeRef.toString()} of the template. If there are no template in the repository it
-     * returns a default template on the classpath.
-     * 
-     * @param type one of the possible body types text/html and text/plain
-     * @return
-     */
-    public String getDefaultEmailBodyTemplate(EmailBodyFormat type);
+     * In this case it returns {@code NodeRef.toString()} of the template. If there are no template in the repository it
+     * returns a default template on the classpath.
+     * 
+     * @param type one of the possible body types text/html and text/plain
+     * @return String
+     */
+    public String getDefaultEmailBodyTemplate(EmailBodyFormat type);
     
     /**
      * Get the node's site container if it belongs to Sites.
@@ -345,7 +344,7 @@ public interface ImapService
     }
 
     /**
-     * @param nodeRef
+     * @param nodeRef NodeRef
      * @return path for node relatively to site root
      */
     public String getPathFromSites(NodeRef nodeRef);