Package net.bluemind.backend.mail.api

Interface IBaseMailboxFolders

All Superinterfaces:

IChangelogSupport

All Known Subinterfaces:

IMailboxFolders, IMailboxFoldersByContainer, IReadOnlyMailboxFolders

public interface IBaseMailboxFolders
extends IChangelogSupport

Method Summary

Modifier and Type	Method	Description
List<ItemValue<MailboxFolder>>	all()
ItemValue<MailboxFolder>	byName(String name)
List<ItemValue<MailboxFolder>>	childrensOf(String folderUid)
ItemValue<MailboxFolder>	getComplete(String uid)
ItemValue<MailboxFolder>	root()
SearchResult	searchItems(MailboxFolderSearchQuery query)
ItemValue<MailboxFolder>	trash()

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

allIds, changeset, changesetById, filteredChangesetById, getVersion, itemChangelog

Method Details

root

@GET
@Path("_root")
ItemValue<MailboxFolder> root()

Returns:

INBOX for user mailboxes or the toplevel mailshare folder

trash

@GET
@Path("_trash")
ItemValue<MailboxFolder> trash()

byName

@GET
@Path("byName/{name}")
ItemValue<MailboxFolder> byName(@PathParam("name")
 String name)

getComplete

@GET
@Path("{uid}/complete")
ItemValue<MailboxFolder> getComplete(@PathParam("uid")
 String uid)

all

@GET
@Path("_all")
List<ItemValue<MailboxFolder>> all()

searchItems

@POST
@Path("_search")
SearchResult searchItems(MailboxFolderSearchQuery query)

childrensOf

@GET
@Path("childensof/{folderUid}")
List<ItemValue<MailboxFolder>> childrensOf(@PathParam("folderUid")
 String folderUid)