org.apache.james.mailbox

Interface SubscriptionManager

All Superinterfaces:

RequestAware

All Known Implementing Classes:

JCRSubscriptionManager, JPASubscriptionManager, StoreSubscriptionManager

public interface SubscriptionManager
extends RequestAware

Subscribes mailboxes to users. This is only needed to implement if the Mailbox should be usable via IMAP. For POP3 only you don't need this at all.

Method Summary

Methods

Modifier and Type	Method and Description
void	subscribe(MailboxSession session, String mailbox) Subscribes the user in the session to the given mailbox.
Collection<String>	subscriptions(MailboxSession session) Finds all subscriptions for the user in the session.
void	unsubscribe(MailboxSession session, String mailbox) Unsubscribes the user in the session from the given mailbox.

Methods inherited from interface org.apache.james.mailbox.RequestAware

endProcessingRequest, startProcessingRequest

Method Detail

subscribe

void subscribe(MailboxSession session,
             String mailbox)
               throws SubscriptionException

Subscribes the user in the session to the given mailbox.

Parameters:

session - not null

mailbox - not null

Throws:

SubscriptionException - when subscription fails

subscriptions

Collection<String> subscriptions(MailboxSession session)
                                 throws SubscriptionException

Finds all subscriptions for the user in the session.

Parameters:

session - not null

Returns:

not null

Throws:

SubscriptionException - when subscriptions cannot be read

unsubscribe

void unsubscribe(MailboxSession session,
               String mailbox)
                 throws SubscriptionException

Unsubscribes the user in the session from the given mailbox.

Parameters:

session - not null

mailbox - not null

Throws:

SubscriptionException - when subscriptions cannot be read