org.nuxeo.cm.mailbox
Interface Mailbox

All Superinterfaces:

Comparable<Mailbox>, Serializable

All Known Subinterfaces:

Mailbox

All Known Implementing Classes:

MailboxImpl, MailboxImpl

public interface Mailbox
extends Serializable, Comparable<Mailbox>

Mailbox interface

Author:

Anahide Tchertchian

Method Summary

void	addMailingList(MailingList mailinglist)
void	addParticipantList(ParticipantsList mailinglist) Deprecated.
String	getAffiliatedMailboxId()
List<String>	getAllUsers() Gets the list of member users of this mailbox.
List<String>	getAllUsersAndGroups()
List<String>	getChildrenIds(org.nuxeo.ecm.core.api.CoreSession session) Returns the children ids of this mailbox
Integer	getConfidentiality()
String	getDescription() Returns description of the mailbox.
org.nuxeo.ecm.core.api.DocumentModel	getDocument() Returns the document model representing this mailbox.
List<String>	getFavorites() Gets the list of mailbox ids used as favorites
List<String>	getGroups() Gets the list of member groups of this mailbox.
String	getId() Returns the mailbox identifier.
Calendar	getLastSyncUpdate()
List<String>	getMailingListIds()
List<MailingList>	getMailingLists() Gets the list of MailingList objects of this mailbox.
MailingList	getMailingListTemplate() Returns a new bare mailing list
List<String>	getNotifiedUsers() Gets a users sublist of delegates that should be notified when new casemanagement has arrived in this mailbox.
String	getOrigin()
String	getOwner() Returns owner of the mailbox.
String	getParentId(org.nuxeo.ecm.core.api.CoreSession session) Returns the parentId of this mailbox
List<String>	getParticipantListIds() Deprecated. since 1.7: use getMailingListIds() instead.
List<ParticipantsList>	getParticipantLists() Deprecated. since 1.7: use getMailingLists() instead.
ParticipantsList	getParticipantListTemplate() Deprecated. since 1.7, use getMailingListTemplate() instead.
List<String>	getProfiles() Gets profiles for this mailbox
String	getSynchronizerId()
String	getSynchronizeState()
String	getTitle() Returns title of the mailbox.
String	getType() Returns type of the mailbox.
List<String>	getUsers() Gets the list of users (delegates) of this mailbox.
boolean	hasProfile(String profile) Returns true if mailbox has given profile.
Boolean	isSynchronized()
void	removeMailingList(String mailingListId) Removes mailing list with given id from this mailbox.
void	removeParticipantList(String mailinglistId) Deprecated. since 1.7: use removeMailingList(String) instead.
void	save(org.nuxeo.ecm.core.api.CoreSession session) Persist the Mailbox
void	setAffiliatedMailboxId(String mbid) Sets the affiliated mailbox id.
void	setConfidentiality(Integer confidentiality) Sets the default confidentiality for icoming mails for this mailbox.
void	setDescription(String description) Sets description of the mailbox.
void	setFavorites(List<String> favorites) Sets the list of mailbox ids used as favorites
void	setGroups(List<String> groups) Sets the list of member groups for this mailbox.
void	setId(String id) Sets id of the mailbox.
void	setLastSyncUpdate(Calendar now) Sets the last time this mailbox has been updated by the synchronziation service.
void	setNotifiedUsers(List<String> users) Sets a users sublist of delegates that should be notified when new casemanagement has arrived in this mailbox.
void	setOrigin(String origin) Sets the origin of the Mailbox.
void	setOwner(String owner) Sets owner of the mailbox.
void	setProfiles(List<String> profiles) Sets profiles for this mailbox
void	setSynchronizerId(String synchronizerId) Set the given string parameter as mailbox's synchronizer ID.
void	setSynchronizeState(String state) Sets synchronize state of the mailbox
void	setTitle(String title) Sets title of the mailbox.
void	setType(String type) Sets type of the mailbox.
void	setUsers(List<String> users) Sets the list of users for this mailbox.
Mailbox	updateMailingList(MailingList currentMailingList)

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDocument

org.nuxeo.ecm.core.api.DocumentModel getDocument()

Returns the document model representing this mailbox.

getId

String getId()

Returns the mailbox identifier.

setId

void setId(String id)

Sets id of the mailbox.

getTitle

String getTitle()

Returns title of the mailbox.

setTitle

void setTitle(String title)

Sets title of the mailbox.

getDescription

String getDescription()

Returns description of the mailbox.

setDescription

void setDescription(String description)

Sets description of the mailbox.

getType

String getType()

Returns type of the mailbox.

setType

void setType(String type)

Sets type of the mailbox.

getOwner

String getOwner()

Returns owner of the mailbox.

setOwner

void setOwner(String owner)

Sets owner of the mailbox.

getAllUsers

List<String> getAllUsers()

Gets the list of member users of this mailbox.

Contains delegates and owner.

getUsers

List<String> getUsers()

Gets the list of users (delegates) of this mailbox.

setUsers

void setUsers(List<String> users)

Sets the list of users for this mailbox.

getGroups

List<String> getGroups()

Gets the list of member groups of this mailbox.

setGroups

void setGroups(List<String> groups)

Sets the list of member groups for this mailbox.

getNotifiedUsers

List<String> getNotifiedUsers()

Gets a users sublist of delegates that should be notified when new casemanagement has arrived in this mailbox.

setNotifiedUsers

void setNotifiedUsers(List<String> users)

Sets a users sublist of delegates that should be notified when new casemanagement has arrived in this mailbox.

getFavorites

List<String> getFavorites()
                          throws CaseManagementException

Gets the list of mailbox ids used as favorites

Throws:

CaseManagementException

setFavorites

void setFavorites(List<String> favorites)
                  throws CaseManagementException

Sets the list of mailbox ids used as favorites

Throws:

CaseManagementException

getParticipantListIds

@Deprecated
List<String> getParticipantListIds()

Deprecated. since 1.7: use getMailingListIds() instead.

Gets the id list of mailing lists of this mailbox.

getMailingListIds

List<String> getMailingListIds()

getParticipantLists

@Deprecated
List<ParticipantsList> getParticipantLists()

Deprecated. since 1.7: use getMailingLists() instead.

Gets the list of ParticipantsList objects of this mailbox.

getMailingLists

List<MailingList> getMailingLists()

Gets the list of MailingList objects of this mailbox.

Since:

1.7

getParticipantListTemplate

@Deprecated
ParticipantsList getParticipantListTemplate()

Deprecated. since 1.7, use getMailingListTemplate() instead.

Returns a new bare mailing list.

getMailingListTemplate

MailingList getMailingListTemplate()

Returns a new bare mailing list

Since:

1.7

addParticipantList

@Deprecated
void addParticipantList(ParticipantsList mailinglist)

Deprecated.

Add the given mailing list to this mailbox

Parameters:

mailinglist - the mailing list to add

addMailingList

void addMailingList(MailingList mailinglist)

removeParticipantList

@Deprecated
void removeParticipantList(String mailinglistId)

Deprecated. since 1.7: use removeMailingList(String) instead.

Removes mailing list with given id from this mailbox.

removeMailingList

void removeMailingList(String mailingListId)

Removes mailing list with given id from this mailbox.

Since:

1.7

getProfiles

List<String> getProfiles()

Gets profiles for this mailbox

Returns:

setProfiles

void setProfiles(List<String> profiles)

Sets profiles for this mailbox

Parameters:

profiles -

hasProfile

boolean hasProfile(String profile)

Returns true if mailbox has given profile.

setConfidentiality

void setConfidentiality(Integer confidentiality)

Sets the default confidentiality for icoming mails for this mailbox.

getConfidentiality

Integer getConfidentiality()

save

void save(org.nuxeo.ecm.core.api.CoreSession session)

Persist the Mailbox

Parameters:

session -

getParentId

String getParentId(org.nuxeo.ecm.core.api.CoreSession session)

Returns the parentId of this mailbox

getChildrenIds

List<String> getChildrenIds(org.nuxeo.ecm.core.api.CoreSession session)

Returns the children ids of this mailbox

getAllUsersAndGroups

List<String> getAllUsersAndGroups()

Returns:

list of all users and groups.

getAffiliatedMailboxId

String getAffiliatedMailboxId()

Returns:

the affiliated mailbox id. null if not affiliated mailbox exists.

setAffiliatedMailboxId

void setAffiliatedMailboxId(String mbid)

Sets the affiliated mailbox id.

getSynchronizeState

String getSynchronizeState()

Returns:

Mailbox current synchronized state

setSynchronizeState

void setSynchronizeState(String state)

Sets synchronize state of the mailbox

isSynchronized

Boolean isSynchronized()

Returns:

true if mailbox is synchronized

getSynchronizerId

String getSynchronizerId()

Returns:

mailbox's synchronizer ID.

setSynchronizerId

void setSynchronizerId(String synchronizerId)

Set the given string parameter as mailbox's synchronizer ID.

Parameters:

synchronizerId -

getLastSyncUpdate

Calendar getLastSyncUpdate()

Returns:

the last time this mailbox has been updated by the synchronziation service.

setLastSyncUpdate

void setLastSyncUpdate(Calendar now)

Sets the last time this mailbox has been updated by the synchronziation service.

Parameters:

now -

getOrigin

String getOrigin()

Returns:

The name of the directory from which it has been synchronized or an empty string if it has been created.

setOrigin

void setOrigin(String origin)

Sets the origin of the Mailbox.

Parameters:

origin -

updateMailingList

Mailbox updateMailingList(MailingList currentMailingList)

Parameters:

currentMailingList -

Returns: