Package net.bluemind.backend.mail.api

Interface IMailboxFolders

All Superinterfaces:
IBaseMailboxFolders, IChangelogSupport, IReadByIdSupport<MailboxFolder>
All Known Subinterfaces:
IMailboxFoldersByContainer
@Path("/mail_folders/{partition}/{mailboxRoot}") public interface IMailboxFolders extends IBaseMailboxFolders, IReadByIdSupport<MailboxFolder>
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 Details

    • updateById

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

    • createForHierarchy

      @PUT @Path("id/{hierarchyId}") ItemIdentifier createForHierarchy(@PathParam("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("id/{id}") void deleteById(@PathParam("id") long id)

    • deepDelete

      @DELETE @Path("deep/{id}") void deepDelete(@PathParam("id") long id)
      Also delete all known child folders.
      Parameters:
      id - the folder identifier

    • emptyFolder

      @DELETE @Path("empty/{id}") void emptyFolder(@PathParam("id") long id)
      Empty an email folder including child folders.
      Parameters:
      id - the folder identifier

    • removeMessages

      @DELETE @Path("removeMessages/{id}") void removeMessages(@PathParam("id") long id)
      Empty an email folder keeping child folders.
      Parameters:
      id - the folder identifier

    • markFolderAsRead

      @PUT @Path("markAsRead/{id}") void markFolderAsRead(@PathParam("id") long id)
      Mark folder as read (does not include sub-folders).
      Parameters:
      id - the folder identifier

    • importItems

      @PUT @Path("importItems/{folderDestinationId}") ImportMailboxItemsStatus importItems(@PathParam("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