com.openexchange.mail.utils

Class MailFolderUtility

java.lang.Object

com.openexchange.mail.utils.MailFolderUtility

public final class MailFolderUtility
extends java.lang.Object

MailFolderUtility - Provides utility methods for mail folders.

Author:

Thorben Betten

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	decode(java.lang.String encoded) Performs mailbox decoding.
static java.lang.String	encode(java.lang.String fullName) Performs mailbox encoding.
static boolean	equalsFullname(java.lang.String fullnameArgument, java.lang.String fullname) Checks if specified full name argument's real full name equals given full name.
static boolean	isEmpty(java.lang.String string) Tests if specified string is empty; either null, zero length, or only consists of white space characters.
static java.lang.String	prepareFullname(int accountId, java.lang.String fullname) Prepends MailFolder.DEFAULT_FOLDER_ID plus the default separator (obtained by MailConfig#getDefaultSeparator()) to given folder full name.
static FullnameArgument	prepareMailFolderParam(java.lang.String fullnameArgument) Parses specified full name argument to an appropriate instance of FullnameArgument.
static java.lang.String	sanitizeFullName(java.lang.String fullName) Sanitizes given folder full name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encode

public static java.lang.String encode(java.lang.String fullName)

Performs mailbox encoding.

Parameters:

fullName - The full name

Returns:

The encoded full name

decode

public static java.lang.String decode(java.lang.String encoded)

Performs mailbox decoding.

Parameters:

encoded - The encoded full name

Returns:

The decoded full name

prepareMailFolderParam

public static FullnameArgument prepareMailFolderParam(java.lang.String fullnameArgument)

Parses specified full name argument to an appropriate instance of FullnameArgument.

Cuts off starting MailFolder.DEFAULT_FOLDER_ID plus the default separator from specified folder full name argument only if full name argument is not null and is not equal to MailFolder.DEFAULT_FOLDER_ID.
Example:

 "default/INBOX" -> "INBOX"
 

Parameters:

fullnameArgument - The groupware's mail folder full name

Returns:

The stripped mail folder full name argument

equalsFullname

public static boolean equalsFullname(java.lang.String fullnameArgument,
                     java.lang.String fullname)

Checks if specified full name argument's real full name equals given full name.

Parameters:

fullnameArgument - The full name argument

fullname - The full name to compare with

Returns:

true if specified full name argument's real full name equals given full name; otherwise false

prepareFullname

public static java.lang.String prepareFullname(int accountId,
                               java.lang.String fullname)

Prepends MailFolder.DEFAULT_FOLDER_ID plus the default separator (obtained by MailConfig#getDefaultSeparator()) to given folder full name.
Example:

 "INBOX" -> "default2/INBOX"
 

Parameters:

accountId - The account ID

fullname - The folder full name

Returns:

The groupware's mail folder full name

isEmpty

public static boolean isEmpty(java.lang.String string)

Tests if specified string is empty; either null, zero length, or only consists of white space characters.

Parameters:

str - The string to test

Returns:

true if specified string is empty; otherwise false.

sanitizeFullName

public static java.lang.String sanitizeFullName(java.lang.String fullName)

Sanitizes given folder full name.

Common problem are messed-up folder full names like:

   "INBOX/default0/actual/folder/path"
     ==>
   "actual/folder/path"
 

Parameters:

fullName - The full name

Returns:

The possibly sanitized full name