org.apache.james.mailbox

Interface MessageManager

All Known Implementing Classes:

HBaseMessageManager, JCRMessageManager, JPAMessageManager, OpenJPAMessageManager, StoreMessageManager

public interface MessageManager

Interface which represent a Mailbox A MessageManager should be valid for the whole MailboxSession

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageManager.MetaData Meta data about the current state of the mailbox.

Method Summary

Methods

Modifier and Type	Method and Description
long	appendMessage(InputStream msgIn, Date internalDate, MailboxSession mailboxSession, boolean isRecent, javax.mail.Flags flags) Appends a message to this mailbox.
Iterator<Long>	expunge(MessageRange set, MailboxSession mailboxSession) Expunges messages in the given range from this mailbox.
long	getMessageCount(MailboxSession mailboxSession) Deprecated. use getMetaData(boolean, MailboxSession, org.apache.james.mailbox.MessageManager.MetaData.FetchGroup)
MessageResultIterator	getMessages(MessageRange set, MessageResult.FetchGroup fetchGroup, MailboxSession mailboxSession) Gets messages in the given range.
MessageManager.MetaData	getMetaData(boolean resetRecent, MailboxSession mailboxSession, MessageManager.MetaData.FetchGroup fetchGroup) Gets current meta data for the mailbox. Consolidates common calls together to allow improved performance. The meta-data returned should be immutable and represent the current state of the mailbox.
boolean	hasRight(MailboxACL.MailboxACLRight right, MailboxSession session) Tells whether the given MailboxSession's user has the given MailboxACL.MailboxACLRight for this MessageManager's mailbox.
boolean	isModSeqPermanent(MailboxSession session) Deprecated. use getMetaData(boolean, MailboxSession, org.apache.james.mailbox.MessageManager.MetaData.FetchGroup)
boolean	isWriteable(MailboxSession session) Deprecated. use getMetaData(boolean, MailboxSession, org.apache.james.mailbox.MessageManager.MetaData.FetchGroup)
MailboxACL.MailboxACLRights[]	listRigths(MailboxACL.MailboxACLEntryKey identifier, MailboxSession session) Computes a result suitable for the LISTRIGHTS IMAP command.
MailboxACL.MailboxACLRights	myRights(MailboxSession session) Returns the rights applicable to the user who has sent the current request.
Iterator<Long>	search(SearchQuery searchQuery, MailboxSession mailboxSession) Searches for messages matching the given query.
Map<Long,javax.mail.Flags>	setFlags(javax.mail.Flags flags, boolean value, boolean replace, MessageRange set, MailboxSession mailboxSession) Sets flags on messages within the given range.
void	setRights(MailboxACL.MailboxACLEntryKey identifier, MailboxACL.EditMode editMode, MailboxACL.MailboxACLRights mailboxAclRights) TODO setRights.

Method Detail

getMessageCount

@Deprecated
long getMessageCount(MailboxSession mailboxSession)
                     throws MailboxException

Deprecated. use getMetaData(boolean, MailboxSession, org.apache.james.mailbox.MessageManager.MetaData.FetchGroup)

Return the count

Parameters:

mailboxSession -

Returns:

count

Throws:

MailboxException

isWriteable

@Deprecated
boolean isWriteable(MailboxSession session)
                    throws MailboxException

Deprecated. use getMetaData(boolean, MailboxSession, org.apache.james.mailbox.MessageManager.MetaData.FetchGroup)

Return if the Mailbox is writable

Parameters:

session -

Returns:

writable

Throws:

MailboxException

isModSeqPermanent

boolean isModSeqPermanent(MailboxSession session)

Deprecated. use getMetaData(boolean, MailboxSession, org.apache.james.mailbox.MessageManager.MetaData.FetchGroup)

Return true if MessageMetaData.getModSeq() is stored in a permanent way.

Parameters:

session -

Returns:

modSeqPermanent

search

Iterator<Long> search(SearchQuery searchQuery,
                    MailboxSession mailboxSession)
                      throws MailboxException

Searches for messages matching the given query. The result must be ordered

Parameters:

mailboxSession - not null

Returns:

uid iterator

Throws:

UnsupportedCriteriaException - when any of the search parameters are not supported by this mailbox

MailboxException - when search fails for other reasons

expunge

Iterator<Long> expunge(MessageRange set,
                     MailboxSession mailboxSession)
                       throws MailboxException

Expunges messages in the given range from this mailbox.

Parameters:

set - not null

mailboxSession - not null

Returns:

uid iterator

Throws:

MailboxException - if anything went wrong

setFlags

Map<Long,javax.mail.Flags> setFlags(javax.mail.Flags flags,
                                  boolean value,
                                  boolean replace,
                                  MessageRange set,
                                  MailboxSession mailboxSession)
                                    throws MailboxException

Sets flags on messages within the given range. The new flags are returned for each message altered.

Parameters:

flags - Flags to be set

value - true = set, false = unset

replace - replace all Flags with this flags, value has to be true

set - the range of messages

mailboxSession - not null

Returns:

new flags indexed by UID

Throws:

MailboxException

appendMessage

long appendMessage(InputStream msgIn,
                 Date internalDate,
                 MailboxSession mailboxSession,
                 boolean isRecent,
                 javax.mail.Flags flags)
                   throws MailboxException

Appends a message to this mailbox. This method must return a higher UID as the last call in every case which also needs to be unique for the lifetime of the mailbox.

Parameters:

internalDate - the time of addition to be set, not null

mailboxSession - not null

isRecent - true when the message should be marked recent, false otherwise

flags - optionally set these flags on created message, or null when no additional flags should be set

Returns:

uid for the newly added message

Throws:

MailboxException - when message cannot be appended

getMessages

MessageResultIterator getMessages(MessageRange set,
                                MessageResult.FetchGroup fetchGroup,
                                MailboxSession mailboxSession)
                                  throws MailboxException

Gets messages in the given range. The messages may get fetched under the-hood in batches so the caller should check if MessageResultIterator.getException() returns null after Iterator.hasNext() returns false.

Parameters:

set -

fetchGroup - data to fetch

mailboxSession - not null

Returns:

MessageResult with the fields defined by FetchGroup

Throws:

MailboxException

hasRight

boolean hasRight(MailboxACL.MailboxACLRight right,
               MailboxSession session)
                 throws MailboxException

Tells whether the given MailboxSession's user has the given MailboxACL.MailboxACLRight for this MessageManager's mailbox.

Parameters:

right -

session -

Returns:

true if the given MailboxSession's user has the given MailboxACL.MailboxACLRight for this MessageManager's mailbox; false otherwise.

Throws:

MailboxException

myRights

MailboxACL.MailboxACLRights myRights(MailboxSession session)
                                     throws MailboxException

Returns the rights applicable to the user who has sent the current request.

Parameters:

session -

Returns:

the rights applicable to the user who has sent the request, returns SimpleMailboxACL.NO_RIGHTS if session.getUser() is null.

Throws:

UnsupportedRightException

MailboxException

listRigths

MailboxACL.MailboxACLRights[] listRigths(MailboxACL.MailboxACLEntryKey identifier,
                                       MailboxSession session)
                                         throws UnsupportedRightException

Computes a result suitable for the LISTRIGHTS IMAP command. The result is computed for this mailbox and the given identifier. From RFC 4314 section 3.7: The first element of the resulting array contains the (possibly empty) set of rights the identifier will always be granted in the mailbox. Following this are zero or more right sets the identifier can be granted in the mailbox. Rights mentioned in the same set are tied together. The server MUST either grant all tied rights to the identifier in the mailbox or grant none. The same right MUST NOT be listed more than once in the LISTRIGHTS command.

Parameters:

identifier - the identifier from the LISTRIGHTS command.

session -

Returns:

Throws:

UnsupportedRightException

setRights

void setRights(MailboxACL.MailboxACLEntryKey identifier,
             MailboxACL.EditMode editMode,
             MailboxACL.MailboxACLRights mailboxAclRights)
               throws UnsupportedRightException

TODO setRights.

Parameters:

identifier -

editMode -

mailboxAclRights -

Throws:

UnsupportedRightException

getMetaData

MessageManager.MetaData getMetaData(boolean resetRecent,
                                  MailboxSession mailboxSession,
                                  MessageManager.MetaData.FetchGroup fetchGroup)
                                    throws MailboxException

Gets current meta data for the mailbox.
Consolidates common calls together to allow improved performance.
The meta-data returned should be immutable and represent the current state of the mailbox.

Parameters:

resetRecent - true when recent flags should be reset, false otherwise

mailboxSession - context, not null

fetchGroup - describes which optional data should be returned

Returns:

meta data, not null

Throws:

MailboxException