net.bluemind.backend.mail.api

Interface IMailboxFolders

All Superinterfaces:

IBaseMailboxFolders, IChangelogSupport

All Known Subinterfaces:

IMailboxFoldersByContainer

All Known Implementing Classes:

ImapReplicatedMailboxesService

@Path(value="/mail_folders/{partition}/{mailboxRoot}")
public interface IMailboxFolders
extends IBaseMailboxFolders

API to access the hierarchy of a user or shared mailbox.

partition: vagrant_vmw (domain name with dots replaced by '_')

mailbox_root: user.log^in (for a user with the login log.in) or shar^ed (for a mailshare with the name shar.ed).

The uid of items returned by this API are sometime called the uniqueid of the mailbox folders. You can pass those uid(s) to MailEventAddresses.mailboxContentChanged(String) to obtain the vertx eventbus address that will receive notifications when the content of a folder changes. This API is tied to a container of MailboxFolder with a changelog.

Method Summary

Modifier and Type	Method and Description
ItemIdentifier	createBasic(MailboxFolder value)
ItemIdentifier	createForHierarchy(long hierId, MailboxFolder value)
void	deepDelete(long id) Also delete all known child folders.
void	deleteById(long id)
void	emptyFolder(long id) Empty an email folder including child folders.
ItemValue<MailboxFolder>	getCompleteById(long id)
ImportMailboxItemsStatus	importItems(long folderDestinationId, ImportMailboxItemSet mailboxItems) Import MailboxItems from a source folder describe ImportMailboxItemSet.mailboxFolderId Source and destination folders must be in the same subtree
void	markFolderAsRead(long id) Mark folder as read (does not include sub-folders).
void	removeMessages(long id) Empty an email folder keeping child folders.
Ack	updateById(long id, MailboxFolder value)

Methods inherited from interface net.bluemind.backend.mail.api.IBaseMailboxFolders

all, byName, getComplete, getMultipleById, root, searchItems

Methods inherited from interface net.bluemind.core.container.api.IChangelogSupport

allIds, changeset, changesetById, containerChangelog, filteredChangesetById, getVersion, itemChangelog

Method Detail

getCompleteById

@GET
 @Path(value="{id}/completeById")
ItemValue<MailboxFolder> getCompleteById(@PathParam(value="id")
                                                                                long id)

updateById

@POST
 @Path(value="id/{id}")
Ack updateById(@PathParam(value="id")
                                             long id,
                                             MailboxFolder value)

createForHierarchy

@PUT
 @Path(value="id/{hierarchyId}")
ItemIdentifier createForHierarchy(@PathParam(value="hierarchyId")
                                                                        long hierId,
                                                                        MailboxFolder value)

Parameters:

hierId - the numerical id we want to end up with in IContainersFlatHierarchy

value - the folder to create

Returns:

the identifier allocated in the subtree container

createBasic

@PUT
ItemIdentifier createBasic(MailboxFolder value)

Parameters:

value - the folder to create

Returns:

the identifier allocated in the subtree container

deleteById

@DELETE
 @Path(value="id/{id}")
void deleteById(@PathParam(value="id")
                                                long id)

deepDelete

@DELETE
 @Path(value="deep/{id}")
void deepDelete(@PathParam(value="id")
                                                  long id)

Also delete all known child folders.

Parameters:

id - the folder identifier

emptyFolder

@DELETE
 @Path(value="empty/{id}")
void emptyFolder(@PathParam(value="id")
                                                    long id)

Empty an email folder including child folders.

Parameters:

id - the folder identifier

removeMessages

@DELETE
 @Path(value="removeMessages/{id}")
void removeMessages(@PathParam(value="id")
                                                                long id)

Empty an email folder keeping child folders.

Parameters:

id - the folder identifier

markFolderAsRead

@PUT
 @Path(value="markAsRead/{id}")
void markFolderAsRead(@PathParam(value="id")
                                                           long id)

Mark folder as read (does not include sub-folders).

Parameters:

id - the folder identifier

importItems

@PUT
 @Path(value="importItems/{folderDestinationId}")
ImportMailboxItemsStatus importItems(@PathParam(value="folderDestinationId")
                                                                                            long folderDestinationId,
                                                                                            ImportMailboxItemSet mailboxItems)
                                                                                     throws ServerFault

Import MailboxItems from a source folder describe ImportMailboxItemSet.mailboxFolderId Source and destination folders must be in the same subtree

Parameters:

folderDestinationId -

mailboxItems -

Returns:

Throws:

ServerFault