org.apache.james.mailbox.maildir.mail

Class MaildirMessageMapper

java.lang.Object

org.apache.james.mailbox.store.transaction.TransactionalMapper

org.apache.james.mailbox.store.mail.AbstractMessageMapper<Integer>

org.apache.james.mailbox.maildir.mail.MaildirMessageMapper

All Implemented Interfaces:

MessageMapper<Integer>, Mapper

public class MaildirMessageMapper
extends AbstractMessageMapper<Integer>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.store.mail.MessageMapper

MessageMapper.FetchType

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

Mapper.Transaction<T>, Mapper.VoidTransaction

Field Summary

Fields inherited from class org.apache.james.mailbox.store.mail.AbstractMessageMapper

mailboxSession

Constructor Summary

Constructors

Constructor and Description
MaildirMessageMapper(MailboxSession session, MaildirStore maildirStore)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	begin() Begin transaction
protected void	commit() Commit transaction
protected MessageMetaData	copy(Mailbox<Integer> mailbox, long uid, long modSeq, Message<Integer> original) Copy the Message to the Mailbox, using the given uid and modSeq for the new Message
long	countMessagesInMailbox(Mailbox<Integer> mailbox) Return the count of messages in the mailbox
long	countUnseenMessagesInMailbox(Mailbox<Integer> mailbox) Return the count of unseen messages in the mailbox
void	delete(Mailbox<Integer> mailbox, Message<Integer> message) Delete the given Message
void	endRequest() IMAP Request was complete.
Map<Long,MessageMetaData>	expungeMarkedForDeletionInMailbox(Mailbox<Integer> 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<Integer> mailbox) Return the uid of the first unseen message.
Iterator<Message<Integer>>	findInMailbox(Mailbox<Integer> mailbox, MessageRange set, MessageMapper.FetchType fType, int max) Return a Iterator which holds the messages for the given criterias The list must be ordered by the Message uid
List<Long>	findRecentMessageUidsInMailbox(Mailbox<Integer> mailbox) Return a List of Message which are recent.
protected void	rollback() Rollback transaction
protected MessageMetaData	save(Mailbox<Integer> mailbox, Message<Integer> message) Save the Message for the given Mailbox and return the MessageMetaData
Iterator<UpdatedFlags>	updateFlags(Mailbox<Integer> mailbox, javax.mail.Flags flags, boolean value, boolean replace, MessageRange set) Update flags for the given MessageRange.

Methods inherited from class org.apache.james.mailbox.store.mail.AbstractMessageMapper

add, copy, getHighestModSeq, getLastUid

Methods inherited from class org.apache.james.mailbox.store.transaction.TransactionalMapper

execute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

execute

Constructor Detail

MaildirMessageMapper

public MaildirMessageMapper(MailboxSession session,
                    MaildirStore maildirStore)

Method Detail

countMessagesInMailbox

public long countMessagesInMailbox(Mailbox<Integer> mailbox)
                            throws MailboxException

Description copied from interface: MessageMapper

Return the count of messages in the mailbox

Returns:

count

Throws:

MailboxException

See Also:

MessageMapper.countMessagesInMailbox(org.apache.james.mailbox.store.mail.model.Mailbox)

countUnseenMessagesInMailbox

public long countUnseenMessagesInMailbox(Mailbox<Integer> mailbox)
                                  throws MailboxException

Description copied from interface: MessageMapper

Return the count of unseen messages in the mailbox

Returns:

unseenCount

Throws:

MailboxException

See Also:

MessageMapper.countUnseenMessagesInMailbox(org.apache.james.mailbox.store.mail.model.Mailbox)

delete

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

Description copied from interface: MessageMapper

Delete the given Message

Throws:

MailboxException

See Also:

MessageMapper.delete(org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.store.mail.model.Message)

findInMailbox

public Iterator<Message<Integer>> findInMailbox(Mailbox<Integer> mailbox,
                                       MessageRange set,
                                       MessageMapper.FetchType fType,
                                       int max)
                                         throws MailboxException

Description copied from interface: MessageMapper

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

max - 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

See Also:

MessageMapper.findInMailbox(org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.model.MessageRange, org.apache.james.mailbox.store.mail.MessageMapper.FetchType, int)

findRecentMessageUidsInMailbox

public List<Long> findRecentMessageUidsInMailbox(Mailbox<Integer> mailbox)
                                          throws MailboxException

Description copied from interface: MessageMapper

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

Returns:

recentList

Throws:

MailboxException

See Also:

MessageMapper.findRecentMessageUidsInMailbox(org.apache.james.mailbox.store.mail.model.Mailbox)

findFirstUnseenMessageUid

public Long findFirstUnseenMessageUid(Mailbox<Integer> mailbox)
                               throws MailboxException

Description copied from interface: MessageMapper

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

Returns:

uid or null

Throws:

MailboxException

See Also:

MessageMapper.findFirstUnseenMessageUid(org.apache.james.mailbox.store.mail.model.Mailbox)

endRequest

public void endRequest()

Description copied from interface: Mapper

IMAP Request was complete. Cleanup all Request scoped stuff

See Also:

Mapper.endRequest()

copy

protected MessageMetaData copy(Mailbox<Integer> mailbox,
                   long uid,
                   long modSeq,
                   Message<Integer> original)
                        throws MailboxException

Description copied from class: AbstractMessageMapper

Copy the Message to the Mailbox, using the given uid and modSeq for the new Message

Specified by:

copy in class AbstractMessageMapper<Integer>

Returns:

metaData

Throws:

MailboxException

See Also:

AbstractMessageMapper.copy(org.apache.james.mailbox.store.mail.model.Mailbox, long, long, org.apache.james.mailbox.store.mail.model.Message)

save

protected MessageMetaData save(Mailbox<Integer> mailbox,
                   Message<Integer> message)
                        throws MailboxException

Description copied from class: AbstractMessageMapper

Save the Message for the given Mailbox and return the MessageMetaData

Specified by:

save in class AbstractMessageMapper<Integer>

Returns:

metaData

Throws:

MailboxException

See Also:

AbstractMessageMapper.save(org.apache.james.mailbox.store.mail.model.Mailbox, org.apache.james.mailbox.store.mail.model.Message)

begin

protected void begin()
              throws MailboxException

Description copied from class: TransactionalMapper

Begin transaction

Specified by:

begin in class TransactionalMapper

Throws:

MailboxException

See Also:

TransactionalMapper.begin()

commit

protected void commit()
               throws MailboxException

Description copied from class: TransactionalMapper

Commit transaction

Specified by:

commit in class TransactionalMapper

Throws:

MailboxException

See Also:

TransactionalMapper.commit()

rollback

protected void rollback()
                 throws MailboxException

Description copied from class: TransactionalMapper

Rollback transaction

Specified by:

rollback in class TransactionalMapper

Throws:

MailboxException

See Also:

TransactionalMapper.rollback()

updateFlags

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

Description copied from interface: MessageMapper

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

Specified by:

updateFlags in interface MessageMapper<Integer>

Overrides:

updateFlags in class AbstractMessageMapper<Integer>

Returns:

updatedFlags

Throws:

MailboxException

See Also:

MessageMapper.updateFlags(org.apache.james.mailbox.store.mail.model.Mailbox, javax.mail.Flags, boolean, boolean, org.apache.james.mailbox.model.MessageRange)

expungeMarkedForDeletionInMailbox

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

Description copied from interface: MessageMapper

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

Returns:

uids

Throws:

MailboxException