org.nuxeo.cm.service
Interface MailboxManagementService

All Superinterfaces:

Serializable

All Known Subinterfaces:

LocalMailboxManagementService, RemoteMailboxManagementService

All Known Implementing Classes:

MailboxManagementBean, MailboxManagementServiceImpl

public interface MailboxManagementService
extends Serializable

Correspondence service.

Method Summary

List<Mailbox>	createPersonalMailboxes(org.nuxeo.ecm.core.api.CoreSession session, String userId) Create the personal Mailbox with the registered
Mailbox	getMailbox(org.nuxeo.ecm.core.api.CoreSession session, String muid) Returns the mailbox with given unique identifier.
List<Mailbox>	getMailboxes(org.nuxeo.ecm.core.api.CoreSession session, List<String> muids) Returns the mailboxes with given unique identifiers.
List<MailboxHeader>	getMailboxesHeaders(org.nuxeo.ecm.core.api.CoreSession session, List<String> muids) Returns the mailboxes with given unique identifiers and a session.
MailboxHeader	getMailboxHeader(org.nuxeo.ecm.core.api.CoreSession documentManager, String fav)
List<Mailbox>	getUserMailboxes(org.nuxeo.ecm.core.api.CoreSession session, String userId) Returns all mailboxes for given user.
Mailbox	getUserPersonalMailbox(org.nuxeo.ecm.core.api.CoreSession session, String userId) Returns the personal mailbox of the given user.
Mailbox	getUserPersonalMailboxForEmail(org.nuxeo.ecm.core.api.CoreSession session, String email) Returns a mailbox for given email
String	getUserPersonalMailboxId(String user) Returns the personal mailbox id for this user.
boolean	hasMailbox(org.nuxeo.ecm.core.api.CoreSession session, String muid) Returns true if a mailbox with given id exists
boolean	hasUserPersonalMailbox(org.nuxeo.ecm.core.api.CoreSession session, String userId) Test if the user has a personal mailbox created
List<MailboxHeader>	searchMailboxes(org.nuxeo.ecm.core.api.CoreSession session, String pattern, String type) Search mailboxes with given pattern

Method Detail

getMailbox

Mailbox getMailbox(org.nuxeo.ecm.core.api.CoreSession session,
                   String muid)

Returns the mailbox with given unique identifier.

Parameters:

session -

muid - User id

hasMailbox

boolean hasMailbox(org.nuxeo.ecm.core.api.CoreSession session,
                   String muid)

Returns true if a mailbox with given id exists

Parameters:

session -

muid - mailbox id

getMailboxesHeaders

List<MailboxHeader> getMailboxesHeaders(org.nuxeo.ecm.core.api.CoreSession session,
                                        List<String> muids)

Returns the mailboxes with given unique identifiers and a session. Giving session can be helpful when you already are in an unrestrictedSessionRunner.

Parameters:

session -

muids -

Returns:

getMailboxes

List<Mailbox> getMailboxes(org.nuxeo.ecm.core.api.CoreSession session,
                           List<String> muids)

Returns the mailboxes with given unique identifiers.

Parameters:

session - a Core Session

muids - Users ids

getUserPersonalMailboxId

String getUserPersonalMailboxId(String user)

Returns the personal mailbox id for this user.

Parameters:

user - User id

getUserMailboxes

List<Mailbox> getUserMailboxes(org.nuxeo.ecm.core.api.CoreSession session,
                               String userId)

Returns all mailboxes for given user. Creates a personal mailbox for real users if needed.

Parameters:

session -

userId - User id

getUserPersonalMailbox

Mailbox getUserPersonalMailbox(org.nuxeo.ecm.core.api.CoreSession session,
                               String userId)

Returns the personal mailbox of the given user.

Parameters:

session -

userId - User id

getUserPersonalMailboxForEmail

Mailbox getUserPersonalMailboxForEmail(org.nuxeo.ecm.core.api.CoreSession session,
                                       String email)

Returns a mailbox for given email

Parameters:

session -

email -

searchMailboxes

List<MailboxHeader> searchMailboxes(org.nuxeo.ecm.core.api.CoreSession session,
                                    String pattern,
                                    String type)

Search mailboxes with given pattern

Parameters:

session -

pattern - matching the box title

type - mailbox type (generic, personal, etc... or null to match all)

createPersonalMailboxes

List<Mailbox> createPersonalMailboxes(org.nuxeo.ecm.core.api.CoreSession session,
                                      String userId)

Create the personal Mailbox with the registered

Parameters:

session -

userId -

Returns:

personal mailbox list.

hasUserPersonalMailbox

boolean hasUserPersonalMailbox(org.nuxeo.ecm.core.api.CoreSession session,
                               String userId)

Test if the user has a personal mailbox created

Parameters:

session -

userId -

Returns:

true if the user has a personal mailbox

getMailboxHeader

MailboxHeader getMailboxHeader(org.nuxeo.ecm.core.api.CoreSession documentManager,
                               String fav)