com.icegreen.greenmail.imap

Class ImapHostManagerImpl

java.lang.Object

com.icegreen.greenmail.imap.ImapHostManagerImpl

All Implemented Interfaces:

ImapConstants, ImapHostManager

public class ImapHostManagerImpl
extends Object
implements ImapHostManager, ImapConstants

An initial implementation of an ImapHost. By default, uses, the InMemoryStore implementation of Store. TODO: Make the underlying store configurable with Phoenix.

Version:

$Revision: 109034 $

Author:

Darrell DeBoer

Field Summary

Fields inherited from interface com.icegreen.greenmail.imap.ImapConstants

BAD, BYE, HIERARCHY_DELIMITER, HIERARCHY_DELIMITER_CHAR, INBOX_NAME, MESSAGES, NAMESPACE_PREFIX, NAMESPACE_PREFIX_CHAR, NO, OK, SP, STORAGE, UNTAGGED, USER_NAMESPACE, VERSION

Constructor Summary

Constructors

Constructor and Description
ImapHostManagerImpl() Hack constructor which creates an in-memory store, and creates a console logger.
ImapHostManagerImpl(Store store)

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.
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 mailboxName) Subscribes a user to a mailbox.
void	unsubscribe(GreenMailUser user, String mailboxName) Unsubscribes from a given mailbox.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImapHostManagerImpl

public ImapHostManagerImpl()

Hack constructor which creates an in-memory store, and creates a console logger.

ImapHostManagerImpl

public ImapHostManagerImpl(Store store)

Method Detail

getAllMessages

public List<StoredMessage> getAllMessages()

Description copied from interface: ImapHostManager

Returns all messages.

Specified by:

getAllMessages in interface ImapHostManager

Returns:

a list of messages.

getHierarchyDelimiter

public char getHierarchyDelimiter()

Description copied from interface: ImapHostManager

Returns the hierarchy delimiter for mailboxes on this host.

Specified by:

getHierarchyDelimiter in interface ImapHostManager

Returns:

The hierarchy delimiter character.

getFolder

public MailFolder getFolder(GreenMailUser user,
                            String mailboxName)

Description copied from interface: ImapHostManager

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?

Specified by:

getFolder in interface ImapHostManager

Parameters:

user - User making the request.

mailboxName - String name of the target.

Returns:

an Mailbox reference.

See Also:

ImapHostManager.getFolder(com.icegreen.greenmail.user.GreenMailUser, java.lang.String)

getFolder

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

Description copied from interface: ImapHostManager

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.

Specified by:

getFolder in interface ImapHostManager

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

public MailFolder getInbox(GreenMailUser user)

Description copied from interface: ImapHostManager

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

Specified by:

getInbox in interface ImapHostManager

Parameters:

user - The user making the request.

Returns:

The user's Inbox.

See Also:

ImapHostManager.getInbox(com.icegreen.greenmail.user.GreenMailUser)

createPrivateMailAccount

public void createPrivateMailAccount(GreenMailUser user)
                              throws FolderException

Description copied from interface: ImapHostManager

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

Specified by:

createPrivateMailAccount in interface ImapHostManager

Parameters:

user - The user to register with the Host.

Throws:

FolderException - if an error occurred creating the user account.

See Also:

ImapHostManager.createPrivateMailAccount(com.icegreen.greenmail.user.GreenMailUser)

createMailbox

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

Description copied from interface: ImapHostManager

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.

Specified by:

createMailbox in interface ImapHostManager

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.

See Also:

ImapHostManager.createMailbox(com.icegreen.greenmail.user.GreenMailUser, java.lang.String)

deleteMailbox

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

Description copied from interface: ImapHostManager

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).

Specified by:

deleteMailbox in interface ImapHostManager

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.

See Also:

ImapHostManager.deleteMailbox(com.icegreen.greenmail.user.GreenMailUser, java.lang.String)

renameMailbox

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

Description copied from interface: ImapHostManager

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.

Specified by:

renameMailbox in interface ImapHostManager

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.

See Also:

ImapHostManager.renameMailbox(com.icegreen.greenmail.user.GreenMailUser, java.lang.String, java.lang.String)

listSubscribedMailboxes

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

Description copied from interface: ImapHostManager

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.

Specified by:

listSubscribedMailboxes in interface ImapHostManager

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.

See Also:

ImapHostManager.listSubscribedMailboxes(com.icegreen.greenmail.user.GreenMailUser, java.lang.String)

listMailboxes

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

Description copied from interface: ImapHostManager

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.

Specified by:

listMailboxes in interface ImapHostManager

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.

See Also:

ImapHostManager.listMailboxes(com.icegreen.greenmail.user.GreenMailUser, java.lang.String)

subscribe

public void subscribe(GreenMailUser user,
                      String mailboxName)
               throws FolderException

Description copied from interface: ImapHostManager

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

Specified by:

subscribe in interface ImapHostManager

Parameters:

user - User making the request

mailboxName - String representation of a mailbox name.

Throws:

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

See Also:

ImapHostManager.subscribe(com.icegreen.greenmail.user.GreenMailUser, java.lang.String)

unsubscribe

public void unsubscribe(GreenMailUser user,
                        String mailboxName)
                 throws FolderException

Description copied from interface: ImapHostManager

Unsubscribes from a given mailbox.

Specified by:

unsubscribe in interface ImapHostManager

Parameters:

user - String representation of an email address

mailboxName - String representation of a mailbox name.

Throws:

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

See Also:

ImapHostManager.unsubscribe(com.icegreen.greenmail.user.GreenMailUser, java.lang.String)

getStore

public Store getStore()

Description copied from interface: ImapHostManager

Gets the store underneath.

Specified by:

getStore in interface ImapHostManager

Returns:

the store.