public interface IMailMessageStorageExt extends IMailMessageStorage
IMailMessageStorageExt
- Extends IMailMessageStorage
for mail systems which support to request single header names.EMPTY_RETVAL
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.
|
appendMessages, copyMessages, deleteMessages, getAllMessages, getAttachment, getDeletedMessages, getImageAttachment, getMessage, getMessages, getNewAndModifiedMessages, getPrimaryContents, getThreadSortedMessages, getUnreadMessages, moveMessages, releaseResources, saveDraft, searchMessages, updateMessageColorLabel, updateMessageFlags
void clearCache() throws com.openexchange.exception.OXException
com.openexchange.exception.OXException
- If operation failsMailMessage[] getMessages(java.lang.String fullName, java.lang.String[] mailIds, MailField[] fields, java.lang.String[] headerNames) throws com.openexchange.exception.OXException
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.
fullName
- The folder full namemailIds
- The mail IDsfields
- The fields to pre-fill in returned instances of MailMessage
headerNames
- The header names to pre-fill in returned instances of MailMessage
com.openexchange.exception.OXException
- If message could not be returnedMailMessage[] getMessagesByMessageID(java.lang.String... messageIDs) throws com.openexchange.exception.OXException
If any "Message-ID" header cannot be found, null
is located at associated index position in returned array.
messageIDs
- The "Message-ID" header listcom.openexchange.exception.OXException
- If mail identifiers could not be returned