com.openexchange.mail.api

Interface IMailFolderStorageEnhanced

All Superinterfaces:

IMailFolderStorage

All Known Subinterfaces:

IMailFolderStorageEnhanced2

public interface IMailFolderStorageEnhanced
extends IMailFolderStorage

IMailFolderStorageEnhanced

Author:

Thorben Betten

Field Summary

Fields inherited from interface com.openexchange.mail.api.IMailFolderStorage

EMPTY_PATH

Method Summary

Methods

Modifier and Type	Method and Description
void	expungeFolder(java.lang.String fullName) Expunge all messages marked as \Deleted and moves them to trash folder.
void	expungeFolder(java.lang.String fullName, boolean hardDelete) Expunge all messages marked as \Deleted.
int	getNewCounter(java.lang.String fullName) Gets the number of new mails for specified folder (since last access to folder).
int	getTotalCounter(java.lang.String fullName) Gets the total number of mails for specified folder.
int	getUnreadCounter(java.lang.String fullName) Gets the number of unread mails for specified folder.

Methods inherited from interface com.openexchange.mail.api.IMailFolderStorage

checkDefaultFolders, clearFolder, clearFolder, createFolder, deleteFolder, deleteFolder, exists, getConfirmedHamFolder, getConfirmedSpamFolder, getDefaultFolderPrefix, getDraftsFolder, getFolder, getMessageQuota, getPath2DefaultFolder, getQuotas, getRootFolder, getSentFolder, getSpamFolder, getStorageQuota, getSubfolders, getTrashFolder, moveFolder, releaseResources, renameFolder, updateFolder

Method Detail

expungeFolder

void expungeFolder(java.lang.String fullName)
                   throws com.openexchange.exception.OXException

Expunge all messages marked as \Deleted and moves them to trash folder.

Parameters:

fullName - The folder full name

Throws:

com.openexchange.exception.OXException - If expunge operation fails

expungeFolder

void expungeFolder(java.lang.String fullName,
                 boolean hardDelete)
                   throws com.openexchange.exception.OXException

Expunge all messages marked as \Deleted.

Parameters:

fullName - The folder full name

hardDelete - true to perform hard-delete; otherwise messages are moved to trash folder

Throws:

com.openexchange.exception.OXException - If expunge operation fails

getUnreadCounter

int getUnreadCounter(java.lang.String fullName)
                     throws com.openexchange.exception.OXException

Gets the number of unread mails for specified folder.

Parameters:

fullName - The folder's full name

Returns:

The unread counter

Throws:

com.openexchange.exception.OXException - If an error occurs

getNewCounter

int getNewCounter(java.lang.String fullName)
                  throws com.openexchange.exception.OXException

Gets the number of new mails for specified folder (since last access to folder).

Parameters:

fullName - The folder's full name

Returns:

The new counter

Throws:

com.openexchange.exception.OXException - If an error occurs

getTotalCounter

int getTotalCounter(java.lang.String fullName)
                    throws com.openexchange.exception.OXException

Gets the total number of mails for specified folder.

Parameters:

fullName - The folder's full name

Returns:

The total counter

Throws:

com.openexchange.exception.OXException - If an error occurs