com.openexchange.mail.utils
Class DefaultFolderNamesProvider

java.lang.Object
  com.openexchange.mail.utils.DefaultFolderNamesProvider

public final class DefaultFolderNamesProvider
extends java.lang.Object

DefaultFolderNamesProvider - Provides the default folder (full-)names for a certain mail account.

Author:

Thorben Betten

Constructor Summary

DefaultFolderNamesProvider(int accountId, int user, int cid)
Initializes a new DefaultFolderNamesProvider.

Method Summary

java.lang.String[]	getDefaultFolderFullnames(com.openexchange.mailaccount.MailAccount mailAccount, boolean isSpamEnabled) Determines the default folder fullnames (not names).
java.lang.String[]	getDefaultFolderFullnames(com.openexchange.mailaccount.MailAccountDescription mailAccount, boolean isSpamEnabled) Determines the default folder fullnames (not names).
java.lang.String[]	getDefaultFolderFullnames(java.lang.String trashFullname, java.lang.String sentFullname, java.lang.String draftsFullname, java.lang.String spamFullname, java.lang.String confirmedSpamFullname, java.lang.String confirmedHamFullname, boolean isSpamEnabled) Determines the default folder fullnames (not names).
java.lang.String[]	getDefaultFolderNames(com.openexchange.mailaccount.MailAccount mailAccount, boolean isSpamEnabled) Determines the default folder names (not fullnames).
java.lang.String[]	getDefaultFolderNames(com.openexchange.mailaccount.MailAccountDescription mailAccount, boolean isSpamEnabled) Determines the default folder names (not fullnames).
java.lang.String[]	getDefaultFolderNames(java.lang.String trash, java.lang.String sent, java.lang.String drafts, java.lang.String spam, java.lang.String confirmedSpam, java.lang.String confirmedHam, boolean isSpamEnabled) Determines the default folder names (not fullnames).

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFolderNamesProvider

public DefaultFolderNamesProvider(int accountId,
                                  int user,
                                  int cid)
                           throws MailException

Initializes a new DefaultFolderNamesProvider.

Parameters:

accountId - The account ID

user - The user ID

cid - The context ID

Throws:

MailException - If initialization fails

Method Detail

getDefaultFolderNames

public java.lang.String[] getDefaultFolderNames(com.openexchange.mailaccount.MailAccount mailAccount,
                                                boolean isSpamEnabled)

Determines the default folder names (not fullnames). The returned array of String indexes the names as given through constants: StorageUtility.INDEX_DRAFTS, StorageUtility.INDEX_SENT, etc.

Parameters:

mailAccount - The mail account providing the names

isSpamEnabled - true if spam is enabled for current user; otherwise false

Returns:

The default folder names as an array of String

getDefaultFolderNames

public java.lang.String[] getDefaultFolderNames(com.openexchange.mailaccount.MailAccountDescription mailAccount,
                                                boolean isSpamEnabled)

Determines the default folder names (not fullnames). The returned array of String indexes the names as given through constants: StorageUtility.INDEX_DRAFTS, StorageUtility.INDEX_SENT, etc.

Parameters:

mailAccount - The mail account providing the names

isSpamEnabled - true if spam is enabled for current user; otherwise false

Returns:

The default folder names as an array of String

getDefaultFolderNames

public java.lang.String[] getDefaultFolderNames(java.lang.String trash,
                                                java.lang.String sent,
                                                java.lang.String drafts,
                                                java.lang.String spam,
                                                java.lang.String confirmedSpam,
                                                java.lang.String confirmedHam,
                                                boolean isSpamEnabled)

Determines the default folder names (not fullnames). The returned array of String indexes the names as given through constants: StorageUtility.INDEX_DRAFTS, StorageUtility.INDEX_SENT, etc.

Parameters:

trash - The trash name

sent - The sent name

drafts - The drafts name

spam - The spam name

confirmedSpam - The confirmed-spam name

confirmedHam - The confirmed-ham name

isSpamEnabled - true if spam is enabled for current user; otherwise false

Returns:

The default folder names as an array of String

getDefaultFolderFullnames

public java.lang.String[] getDefaultFolderFullnames(com.openexchange.mailaccount.MailAccount mailAccount,
                                                    boolean isSpamEnabled)

Determines the default folder fullnames (not names). The returned array of String indexes the names as given through constants: StorageUtility.INDEX_DRAFTS, StorageUtility.INDEX_SENT, etc.

Parameters:

mailAccount - The mail account providing the fullnames

isSpamEnabled - true if spam is enabled for current user; otherwise false

Returns:

The default folder fullnames as an array of String

getDefaultFolderFullnames

public java.lang.String[] getDefaultFolderFullnames(com.openexchange.mailaccount.MailAccountDescription mailAccount,
                                                    boolean isSpamEnabled)

Determines the default folder fullnames (not names). The returned array of String indexes the names as given through constants: StorageUtility.INDEX_DRAFTS, StorageUtility.INDEX_SENT, etc.

Parameters:

mailAccount - The mail account providing the fullnames

isSpamEnabled - true if spam is enabled for current user; otherwise false

Returns:

The default folder fullnames as an array of String

getDefaultFolderFullnames

public java.lang.String[] getDefaultFolderFullnames(java.lang.String trashFullname,
                                                    java.lang.String sentFullname,
                                                    java.lang.String draftsFullname,
                                                    java.lang.String spamFullname,
                                                    java.lang.String confirmedSpamFullname,
                                                    java.lang.String confirmedHamFullname,
                                                    boolean isSpamEnabled)

Determines the default folder fullnames (not names). The returned array of String indexes the names as given through constants: StorageUtility.INDEX_DRAFTS, StorageUtility.INDEX_SENT, etc.

Parameters:

trashFullname - The trash fullname

sentFullname - The sent fullname

draftsFullname - The drafts fullname

spamFullname - The spam fullname

confirmedSpamFullname - The confirmed-spam fullname

confirmedHamFullname - The confirmed-ham fullname

isSpamEnabled - true if spam is enabled for current user; otherwise false

Returns:

The default folder fullnames as an array of String