org.apache.james.mailbox.store.mail

Interface MessageMapper<Id>

All Superinterfaces:

Mapper

All Known Implementing Classes:

AbstractMessageMapper, HBaseMessageMapper, InMemoryMessageMapper, JCRMessageMapper, JPAMessageMapper, MaildirMessageMapper

public interface MessageMapper<Id>
extends Mapper

Maps Message in a MessageManager. A MessageMapper has a lifecycle from the start of a request to the end of the request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessageMapper.FetchType Specify what data needs to get filled in a Message before returning it

Nested classes/interfaces inherited from interface org.apache.james.mailbox.store.transaction.Mapper

Mapper.Transaction<T>, Mapper.VoidTransaction

Method Summary

Methods

Modifier and Type	Method and Description
MessageMetaData	add(Mailbox<Id> mailbox, Message<Id> message) Add the given Message to the underlying storage.
MessageMetaData	copy(Mailbox<Id> mailbox, Message<Id> original) Copy the given Message to a new mailbox and return the uid of the copy.
long	countMessagesInMailbox(Mailbox<Id> mailbox) Return the count of messages in the mailbox
long	countUnseenMessagesInMailbox(Mailbox<Id> mailbox) Return the count of unseen messages in the mailbox
void	delete(Mailbox<Id> mailbox, Message<Id> message) Delete the given Message
Map<Long,MessageMetaData>	expungeMarkedForDeletionInMailbox(Mailbox<Id> mailbox, MessageRange set) Return a Iterator which holds the uids for all deleted Messages for the given MessageRange which are marked for deletion The list must be ordered
Long	findFirstUnseenMessageUid(Mailbox<Id> mailbox) Return the uid of the first unseen message.
Iterator<Message<Id>>	findInMailbox(Mailbox<Id> mailbox, MessageRange set, MessageMapper.FetchType type, int limit) Return a Iterator which holds the messages for the given criterias The list must be ordered by the Message uid
List<Long>	findRecentMessageUidsInMailbox(Mailbox<Id> mailbox) Return a List of Message which are recent.
long	getHighestModSeq(Mailbox<Id> mailbox) Return the higest mod-sequence which were used for storing a Message in the Mailbox
long	getLastUid(Mailbox<Id> mailbox) Return the last uid which were used for storing a Message in the Mailbox
Iterator<UpdatedFlags>	updateFlags(Mailbox<Id> mailbox, javax.mail.Flags flags, boolean value, boolean replace, MessageRange set) Update flags for the given MessageRange.

Methods inherited from interface org.apache.james.mailbox.store.transaction.Mapper

endRequest, execute

Method Detail

findInMailbox

Iterator<Message<Id>> findInMailbox(Mailbox<Id> mailbox,
                                  MessageRange set,
                                  MessageMapper.FetchType type,
                                  int limit)
                                    throws MailboxException

Return a Iterator which holds the messages for the given criterias The list must be ordered by the Message uid

Parameters:

mailbox - The mailbox to search

set - message range for batch processing

type -

limit - the maximal limit of returned Message's. Use -1 to set no limit. In any case the caller MUST not expect the limit to get applied in all cases as the implementation MAY just ignore it

Throws:

MailboxException

expungeMarkedForDeletionInMailbox

Map<Long,MessageMetaData> expungeMarkedForDeletionInMailbox(Mailbox<Id> mailbox,
                                                          MessageRange set)
                                                            throws MailboxException

Return a Iterator which holds the uids for all deleted Messages for the given MessageRange which are marked for deletion The list must be ordered

Parameters:

mailbox -

set -

Returns:

uids

Throws:

MailboxException

countMessagesInMailbox

long countMessagesInMailbox(Mailbox<Id> mailbox)
                            throws MailboxException

Return the count of messages in the mailbox

Parameters:

mailbox -

Returns:

count

Throws:

MailboxException

countUnseenMessagesInMailbox

long countUnseenMessagesInMailbox(Mailbox<Id> mailbox)
                                  throws MailboxException

Return the count of unseen messages in the mailbox

Parameters:

mailbox -

Returns:

unseenCount

Throws:

StorageException

MailboxException

delete

void delete(Mailbox<Id> mailbox,
          Message<Id> message)
            throws MailboxException

Delete the given Message

Parameters:

mailbox -

message -

Throws:

StorageException

MailboxException

findFirstUnseenMessageUid

Long findFirstUnseenMessageUid(Mailbox<Id> mailbox)
                               throws MailboxException

Return the uid of the first unseen message. If non can be found null will get returned

Parameters:

mailbox -

Returns:

uid or null

Throws:

StorageException

MailboxException

findRecentMessageUidsInMailbox

List<Long> findRecentMessageUidsInMailbox(Mailbox<Id> mailbox)
                                          throws MailboxException

Return a List of Message which are recent. The list must be ordered by the Message uid.

Parameters:

mailbox -

Returns:

recentList

Throws:

StorageException

MailboxException

add

MessageMetaData add(Mailbox<Id> mailbox,
                  Message<Id> message)
                    throws MailboxException

Add the given Message to the underlying storage. Be aware that implementation may choose to replace the uid of the given message while storing. So you should only depend on the returned uid.

Parameters:

mailbox -

message -

Returns:

uid

Throws:

StorageException

MailboxException

updateFlags

Iterator<UpdatedFlags> updateFlags(Mailbox<Id> mailbox,
                                 javax.mail.Flags flags,
                                 boolean value,
                                 boolean replace,
                                 MessageRange set)
                                   throws MailboxException

Update flags for the given MessageRange. Only the flags may be modified after a message was saved to a mailbox.

Parameters:

mailbox -

flags -

value -

replace -

set -

Returns:

updatedFlags

Throws:

MailboxException

copy

MessageMetaData copy(Mailbox<Id> mailbox,
                   Message<Id> original)
                     throws MailboxException

Copy the given Message to a new mailbox and return the uid of the copy. Be aware that the given uid is just a suggestion for the uid of the copied message. Implementation may choose to use a different one, so only depend on the returned uid!

Parameters:

mailbox - the Mailbox to copy to

original - the original to copy

Throws:

StorageException

MailboxException

getLastUid

long getLastUid(Mailbox<Id> mailbox)
                throws MailboxException

Return the last uid which were used for storing a Message in the Mailbox

Parameters:

mailbox -

Returns:

lastUid

Throws:

MailboxException

getHighestModSeq

long getHighestModSeq(Mailbox<Id> mailbox)
                      throws MailboxException

Return the higest mod-sequence which were used for storing a Message in the Mailbox

Parameters:

mailbox -

Returns:

lastUid

Throws:

MailboxException