com.openexchange.mail.api

Interface IMailMessageStorageExt

All Superinterfaces:

IMailMessageStorage

public interface IMailMessageStorageExt
extends IMailMessageStorage

IMailMessageStorageExt - Extends IMailMessageStorage for mail systems which support to request single header names.

Author:

Thorben Betten

Field Summary

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

EMPTY_RETVAL

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Clears message-related cache.
MailMessage[]	getMessages(java.lang.String fullName, java.lang.String[] mailIds, MailField[] fields, java.lang.String[] headerNames) Gets the mails located in given folder whose mail ID matches specified ID.
MailMessage[]	getMessagesByMessageID(java.lang.String... messageIDs) Gets the identifiers if the mails whose "Message-ID" header is contained in specified list.

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

appendMessages, copyMessages, deleteMessages, getAllMessages, getAttachment, getDeletedMessages, getImageAttachment, getMessage, getMessages, getNewAndModifiedMessages, getPrimaryContents, getThreadSortedMessages, getUnreadMessages, moveMessages, releaseResources, saveDraft, searchMessages, updateMessageColorLabel, updateMessageFlags

Method Detail

clearCache

void clearCache()
                throws com.openexchange.exception.OXException

Clears message-related cache.

Throws:

com.openexchange.exception.OXException - If operation fails

getMessages

MailMessage[] getMessages(java.lang.String fullName,
                        java.lang.String[] mailIds,
                        MailField[] fields,
                        java.lang.String[] headerNames)
                          throws com.openexchange.exception.OXException

Gets the mails located in given folder whose mail ID matches specified ID. The constant IMailMessageStorage.EMPTY_RETVAL may be returned, if folder contains no messages.

The returned instances of MailMessage are pre-filled with specified fields through argument fields.

If any mail ID is invalid, null is returned for that entry.

Parameters:

fullName - The folder full name

mailIds - The mail IDs

fields - The fields to pre-fill in returned instances of MailMessage

headerNames - The header names to pre-fill in returned instances of MailMessage

Returns:

Corresponding mails as an array

Throws:

com.openexchange.exception.OXException - If message could not be returned

getMessagesByMessageID

MailMessage[] getMessagesByMessageID(java.lang.String... messageIDs)
                                     throws com.openexchange.exception.OXException

Gets the identifiers if the mails whose "Message-ID" header is contained in specified list.

If any "Message-ID" header cannot be found, null is located at associated index position in returned array.

Parameters:

messageIDs - The "Message-ID" header list

Returns:

An array providing the looked-up mails with ID and folder set

Throws:

com.openexchange.exception.OXException - If mail identifiers could not be returned