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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultFolderNamesProvider.FallbackProvider Provides fall-back values.

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultFolderNamesProvider.FallbackProvider	DEFAULT_PROVIDER The fall-back provider.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getDefaultFolderFullnames(com.openexchange.mailaccount.MailAccount mailAccount, boolean isSpamEnabled) Determines the default folder full names (not names).
java.lang.String[]	getDefaultFolderFullnames(com.openexchange.mailaccount.MailAccountDescription mailAccount, boolean isSpamEnabled) Determines the default folder full names (not names).
java.lang.String[]	getDefaultFolderFullnames(MailConfig mailConfig, boolean isSpamEnabled) Determines the default folder full names (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 full names (not names).
java.lang.String[]	getDefaultFolderNames(com.openexchange.mailaccount.MailAccount mailAccount, boolean isSpamEnabled) Determines the default folder names (not full names).
java.lang.String[]	getDefaultFolderNames(com.openexchange.mailaccount.MailAccountDescription mailAccount, boolean isSpamEnabled) Determines the default folder names (not full names).
java.lang.String[]	getDefaultFolderNames(MailConfig mailConfig, boolean isSpamEnabled) Determines the default folder names (not names).
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 full names).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROVIDER

public static final DefaultFolderNamesProvider.FallbackProvider DEFAULT_PROVIDER

The fall-back provider.

Constructor Detail

DefaultFolderNamesProvider

public DefaultFolderNamesProvider(int accountId,
                          int user,
                          int cid)
                           throws com.openexchange.exception.OXException

Initializes a new DefaultFolderNamesProvider.

Parameters:

accountId - The account ID

user - The user ID

cid - The context ID

Throws:

com.openexchange.exception.OXException - If initialization fails

Method Detail

getDefaultFolderNames

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

Determines the default folder names (not full 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 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 full 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 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(MailConfig mailConfig,
                                       boolean isSpamEnabled)

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

Parameters:

mailConfig - The mail configuration 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 full names). 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 full names (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 full names

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

Returns:

The default folder full names as an array of String

getDefaultFolderFullnames

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

Determines the default folder full names (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 full names

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

Returns:

The default folder full names as an array of String

getDefaultFolderFullnames

public java.lang.String[] getDefaultFolderFullnames(MailConfig mailConfig,
                                           boolean isSpamEnabled)

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

Parameters:

mailConfig - The mail configuration providing the full names

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

Returns:

The default folder full names 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 full names (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 full name

sentFullname - The sent full name

draftsFullname - The drafts full name

spamFullname - The spam full name

confirmedSpamFullname - The confirmed-spam full name

confirmedHamFullname - The confirmed-ham full name

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

Returns:

The default folder full names as an array of String