org.apache.james.mailrepository.api

Interface MailRepository

All Known Implementing Classes:

AbstractMailRepository, FileMailRepository, JCRMailRepository, JDBCMailRepository, MBoxMailRepository

public interface MailRepository

Interface for a Repository to store Mails.

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<String>	list() List string keys of messages in repository.
boolean	lock(String key) Obtains a lock on a message identified by key
void	remove(Collection<org.apache.mailet.Mail> mails) Remove an Collection of mails from the repository
void	remove(org.apache.mailet.Mail mail) Removes a specified message
void	remove(String key) Removes a message identified by key.
org.apache.mailet.Mail	retrieve(String key) Retrieves a message given a key.
void	store(org.apache.mailet.Mail mc) Stores a message in this repository.
boolean	unlock(String key) Releases a lock on a message identified the key

Method Detail

store

void store(org.apache.mailet.Mail mc)
           throws javax.mail.MessagingException

Stores a message in this repository. TODO: Shouldn't this return the key under which it is stored?

Parameters:

mc - the mail message to store

Throws:

javax.mail.MessagingException

list

Iterator<String> list()
                      throws javax.mail.MessagingException

List string keys of messages in repository.

Returns:

an Iterator over the list of keys in the repository

Throws:

javax.mail.MessagingException

retrieve

org.apache.mailet.Mail retrieve(String key)
                                throws javax.mail.MessagingException

Retrieves a message given a key. At the moment, keys can be obtained from list() in superinterface Store.Repository

Parameters:

key - the key of the message to retrieve

Returns:

the mail corresponding to this key, null if none exists

Throws:

javax.mail.MessagingException

remove

void remove(org.apache.mailet.Mail mail)
            throws javax.mail.MessagingException

Removes a specified message

Parameters:

mail - the message to be removed from the repository

Throws:

javax.mail.MessagingException

remove

void remove(Collection<org.apache.mailet.Mail> mails)
            throws javax.mail.MessagingException

Remove an Collection of mails from the repository

Parameters:

mails - The Collection of MailImpl's to delete

Throws:

javax.mail.MessagingException

Since:

2.2.0

remove

void remove(String key)
            throws javax.mail.MessagingException

Removes a message identified by key.

Parameters:

key - the key of the message to be removed from the repository

Throws:

javax.mail.MessagingException

lock

boolean lock(String key)
             throws javax.mail.MessagingException

Obtains a lock on a message identified by key

Parameters:

key - the key of the message to be locked

Returns:

true if successfully obtained the lock, false otherwise

Throws:

javax.mail.MessagingException

unlock

boolean unlock(String key)
               throws javax.mail.MessagingException

Releases a lock on a message identified the key

Parameters:

key - the key of the message to be unlocked

Returns:

true if successfully released the lock, false otherwise

Throws:

javax.mail.MessagingException