org.apache.james.mailbox.store.mail

Interface MailboxMapper<Id>

All Superinterfaces:

Mapper

All Known Implementing Classes:

HBaseMailboxMapper, InMemoryMailboxMapper, JCRMailboxMapper, JPAMailboxMapper, MaildirMailboxMapper

public interface MailboxMapper<Id>
extends Mapper

Mapper for Mailbox actions. A MailboxMapper has a lifecycle from the start of a request to the end of the request.

Nested Class Summary

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
void	delete(Mailbox<Id> mailbox) Delete the given Mailbox from the underlying storage
Mailbox<Id>	findMailboxByPath(MailboxPath mailboxName) Return the Mailbox for the given name
List<Mailbox<Id>>	findMailboxWithPathLike(MailboxPath mailboxPath) Return a List of Mailbox which name is like the given name
boolean	hasChildren(Mailbox<Id> mailbox, char delimiter) Return if the given Mailbox has children
List<Mailbox<Id>>	list() Return a unmodifable List of all Mailbox
void	save(Mailbox<Id> mailbox) Save the give Mailbox to the underlying storage

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

endRequest, execute

Method Detail

save

void save(Mailbox<Id> mailbox)
          throws MailboxException

Save the give Mailbox to the underlying storage

Parameters:

mailbox -

Throws:

MailboxException

delete

void delete(Mailbox<Id> mailbox)
            throws MailboxException

Delete the given Mailbox from the underlying storage

Parameters:

mailbox -

Throws:

MailboxException

findMailboxByPath

Mailbox<Id> findMailboxByPath(MailboxPath mailboxName)
                              throws MailboxException,
                                     MailboxNotFoundException

Return the Mailbox for the given name

Parameters:

mailboxName -

Returns:

mailbox

Throws:

MailboxException

MailboxNotFoundException

findMailboxWithPathLike

List<Mailbox<Id>> findMailboxWithPathLike(MailboxPath mailboxPath)
                                          throws MailboxException

Return a List of Mailbox which name is like the given name

Parameters:

mailboxPath -

Returns:

mailboxList

Throws:

MailboxException

hasChildren

boolean hasChildren(Mailbox<Id> mailbox,
                  char delimiter)
                    throws MailboxException,
                           MailboxNotFoundException

Return if the given Mailbox has children

Parameters:

mailbox - not null

delimiter - path delimiter

Returns:

true when the mailbox has children, false otherwise

Throws:

MailboxException

MailboxNotFoundException

list

List<Mailbox<Id>> list()
                       throws MailboxException

Return a unmodifable List of all Mailbox

Returns:

mailboxList

Throws:

MailboxException