com.icegreen.greenmail.imap

Interface ImapHostManager

All Known Implementing Classes:

ImapHostManagerImpl

public interface ImapHostManager

A host machine that has an IMAP4rev1 messaging server. There should be one instance of this class per instance of James. An IMAP messaging system may span more than one host.

String parameters representing mailbox names must be the full hierarchical name of the target, with namespace, as used by the specified user. Examples: '#mail.Inbox' or '#shared.finance.Q2Earnings'.

An imap Host must keep track of existing and deleted mailboxes.

References: rfc 2060, rfc 2193, rfc 2221

Version:

$Revision: 109034 $

Author:

Charles Benett, Darrell DeBoer <darrell@apache.org>

Method Summary

Modifier and Type	Method and Description
MailFolder	createMailbox(GreenMailUser user, String mailboxName) Returns a reference to a newly created Mailbox.
void	createPrivateMailAccount(GreenMailUser user) Registers a user with the ImapHost, creating a personal mail space and INBOX for that user.
void	deleteMailbox(GreenMailUser user, String mailboxName) Deletes an existing MailBox.
void	deletePrivateMailAccount(GreenMailUser user) Deletes given user data, such as mail boxes or quotas.
List<StoredMessage>	getAllMessages() Returns all messages.
MailFolder	getFolder(GreenMailUser user, String mailboxName) Returns a reference to an existing Mailbox.
MailFolder	getFolder(GreenMailUser user, String mailboxName, boolean mustExist) Returns a reference to an existing Mailbox.
char	getHierarchyDelimiter() Returns the hierarchy delimiter for mailboxes on this host.
MailFolder	getInbox(GreenMailUser user) Returns a reference to the user's INBOX.
Store	getStore() Gets the store underneath.
Collection<MailFolder>	listMailboxes(GreenMailUser user, String mailboxPattern) Returns an collection of mailboxes on this host.
Collection<MailFolder>	listSubscribedMailboxes(GreenMailUser user, String mailboxPattern) Returns an collection of mailboxes on this host.
void	renameMailbox(GreenMailUser user, String oldMailboxName, String newMailboxName) Renames an existing MailBox.
void	subscribe(GreenMailUser user, String mailbox) Subscribes a user to a mailbox.
void	unsubscribe(GreenMailUser user, String mailbox) Unsubscribes from a given mailbox.

Method Detail

getAllMessages

List<StoredMessage> getAllMessages()

Returns all messages.

Returns:

a list of messages.

getHierarchyDelimiter

char getHierarchyDelimiter()

Returns the hierarchy delimiter for mailboxes on this host.

Returns:

The hierarchy delimiter character.

getFolder

MailFolder getFolder(GreenMailUser user,
                     String mailboxName)

Returns a reference to an existing Mailbox. The requested mailbox must already exists on this server and the requesting user must have at least lookup rights.

TODO: should default behaviour be to return null?

Parameters:

user - User making the request.

mailboxName - String name of the target.

Returns:

an Mailbox reference.

getFolder

MailFolder getFolder(GreenMailUser user,
                     String mailboxName,
                     boolean mustExist)
              throws FolderException

Returns a reference to an existing Mailbox. If mustExist == true, an exception is thrown if the requested mailbox doesn't exists on this server or the requesting user doesn't have at least lookup rights. If mustExist == false, simply returns null in this case.

Parameters:

user - User making the request.

mailboxName - String name of the target.

mustExist - Specified behaviour where a mailbox is missing or non-viewable.

Returns:

an Mailbox reference.

Throws:

FolderException - if mailbox does not exist locally, and mustExist is true.

getInbox

MailFolder getInbox(GreenMailUser user)
             throws FolderException

Returns a reference to the user's INBOX. The user must have been registered on the server by the createPrivateMailAccount(com.icegreen.greenmail.user.GreenMailUser) method.

Parameters:

user - The user making the request.

Returns:

The user's Inbox.

Throws:

FolderException - if the user doesn't have an inbox on this server.

createPrivateMailAccount

void createPrivateMailAccount(GreenMailUser user)
                       throws FolderException

Registers a user with the ImapHost, creating a personal mail space and INBOX for that user.

Parameters:

user - The user to register with the Host.

Throws:

FolderException - if an error occurred creating the user account.

deletePrivateMailAccount

void deletePrivateMailAccount(GreenMailUser user)

Deletes given user data, such as mail boxes or quotas.

Parameters:

user - the user.

createMailbox

MailFolder createMailbox(GreenMailUser user,
                         String mailboxName)
                  throws AuthorizationException,
                         FolderException

Returns a reference to a newly created Mailbox. The request should specify a mailbox that does not already exist on this server, that could exist on this server and that the user has rights to create. If a system allocates different namespaces to different hosts then a request to create a mailbox in a namespace not served by this host would be an error. It is an error to create a mailbox with the name of a mailbox that has been deleted, if that name is still in use.

Parameters:

user - User making the request.

mailboxName - String name of the target

Returns:

an Mailbox reference.

Throws:

FolderException - if mailbox already exists, locally or remotely, or if mailbox cannot be created locally.

AuthorizationException - if mailbox could be created locally but user does not have create rights.

deleteMailbox

void deleteMailbox(GreenMailUser user,
                   String mailboxName)
            throws FolderException,
                   AuthorizationException

Deletes an existing MailBox. Specified mailbox must already exist on this server, and the user must have rights to delete it. (Mailbox delete rights are implementation defined, one way is if the user would have the right to create it).

Parameters:

user - User making the request.

mailboxName - String name of the target

Throws:

FolderException - if mailbox does not exist locally or is any identities INBOX.

AuthorizationException - if mailbox exists locally but user does not have rights to delete it.

renameMailbox

void renameMailbox(GreenMailUser user,
                   String oldMailboxName,
                   String newMailboxName)
            throws FolderException,
                   AuthorizationException

Renames an existing MailBox. The specified mailbox must already exist locally, the requested name must not exist locally already but must be able to be created locally and the user must have rights to delete the existing mailbox and create a mailbox with the new name. Any inferior hierarchical names must also be renamed. If INBOX is renamed, the contents of INBOX are transferred to a new folder with the new name, but INBOX is not deleted. If INBOX has inferior mailboxes these are not renamed. It is an error to create a mailbox with the name of a mailbox that has been deleted, if that name is still in use.

Parameters:

user - User making the request.

oldMailboxName - String name of the existing mailbox

newMailboxName - String target new name

Throws:

FolderException - if mailbox does not exist locally, or there is an existing mailbox with the new name.

AuthorizationException - if user does not have rights to delete the existing mailbox or create the new mailbox.

listMailboxes

Collection<MailFolder> listMailboxes(GreenMailUser user,
                                     String mailboxPattern)
                              throws FolderException

Returns an collection of mailboxes on this host. The specified user must have at least lookup rights for each mailbox returned. If the subscribedOnly flag is set, only mailboxes to which the specified user is currently subscribed should be returned. Implementations that may export circular hierarchies SHOULD restrict the levels of hierarchy returned. The depth suggested by rfc 2683 is 20 hierarchy levels.

The reference name must be non-empty. If the mailbox name is empty, implementations must not throw either exception but must return a single String (described below) if the reference name specifies a local mailbox accessible to the user and a one-character String containing the hierarchy delimiter of the referenced namespace, otherwise.

Each String returned should be a space seperated triple of name attributes, hierarchy delimiter and full mailbox name. The mailbox name should include the namespace and be relative to the specified user.

RFC comments: Implementations SHOULD return quickly. They SHOULD NOT go to excess trouble to calculate\Marked or \Unmarked status.

JAMES comment: By elimination, implementations should usually include \Noinferiors or \Noselect, if appropriate. Also, if the reference name and mailbox name resolve to a single local mailbox, implementations should establish all attributes.

Parameters:

user - User making the request

mailboxPattern - String name of a mailbox possible including a wildcard.

Returns:

Collection of mailboxes matching the pattern.

Throws:

FolderException - if the referenceName is not local or if referenceName and mailbox name resolve to a single mailbox which does not exist locally.

listSubscribedMailboxes

Collection<MailFolder> listSubscribedMailboxes(GreenMailUser user,
                                               String mailboxPattern)
                                        throws FolderException

Returns an collection of mailboxes on this host. The specified user must have at least lookup rights for each mailbox returned. If the subscribedOnly flag is set, only mailboxes to which the specified user is currently subscribed should be returned. Implementations that may export circular hierarchies SHOULD restrict the levels of hierarchy returned. The depth suggested by rfc 2683 is 20 hierarchy levels.

The reference name must be non-empty. If the mailbox name is empty, implementations must not throw either exception but must return a single String (described below) if the reference name specifies a local mailbox accessible to the user and a one-character String containing the hierarchy delimiter of the referenced namespace, otherwise.

Each String returned should be a space seperated triple of name attributes, hierarchy delimiter and full mailbox name. The mailbox name should include the namespace and be relative to the specified user.

RFC comments: Implementations SHOULD return quickly. They SHOULD NOT go to excess trouble to calculate\Marked or \Unmarked status.

JAMES comment: By elimination, implementations should usually include \Noinferiors or \Noselect, if appropriate. Also, if the reference name and mailbox name resolve to a single local mailbox, implementations should establish all attributes.

Note that servers cannot unilaterally remove mailboxes from the subscribed list. A request that attempts to list a deleted, but subscribed, mailbox must return that mailbox with the \Noselect attribute.

Parameters:

user - User making the request

mailboxPattern - String name of a mailbox possible including a wildcard.

Returns:

Collection of mailboxes matching the pattern.

Throws:

FolderException - if the referenceName is not local or if referenceName and mailbox name resolve to a single mailbox which does not exist locally.

subscribe

void subscribe(GreenMailUser user,
               String mailbox)
        throws FolderException

Subscribes a user to a mailbox. The mailbox must exist locally and the user must have at least lookup rights to it.

Parameters:

user - User making the request

mailbox - String representation of a mailbox name.

Throws:

FolderException - if the mailbox does not exist locally (for the user).

unsubscribe

void unsubscribe(GreenMailUser user,
                 String mailbox)
          throws FolderException

Unsubscribes from a given mailbox.

Parameters:

user - String representation of an email address

mailbox - String representation of a mailbox name.

Throws:

FolderException - if the mailbox does not exist locally (for the user).

getStore

Store getStore()

Gets the store underneath.

Returns:

the store.