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

MailMessage[]

getMessages(java.lang.String folder, java.lang.String[] mailIds, MailField[] fields, java.lang.String[] headerNames) Gets the mails located in given folder whose mail ID matches specified ID.

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

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

Method Detail

getMessages

MailMessage[] getMessages(java.lang.String folder,
                          java.lang.String[] mailIds,
                          MailField[] fields,
                          java.lang.String[] headerNames)
                          throws MailException

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:

folder - The folder fullname

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:

MailException - If message could not be returned