Interface ISharedMailbox

All Superinterfaces:
IRestoreDirEntryWithMailboxSupport<SharedMailbox>, IRestoreSupport<SharedMailbox>
@Path("/shared_mailboxes/{domainUid}") public interface ISharedMailbox extends IRestoreDirEntryWithMailboxSupport<SharedMailbox>

  • Method Details

    • getComplete

      @GET @Path("{uid}/complete") ItemValue<SharedMailbox> getComplete(@PathParam("uid") String uid) throws ServerFault
      Fetches a SharedMailbox by its unique id
      Specified by:
      getComplete in interface IRestoreDirEntryWithMailboxSupport<SharedMailbox>
      Parameters:
      uid - the shared mailbox's unique id
      Returns:
      the shared mailbox item value, or null if the shared mailbox does not exist
      Throws:
      ServerFault - standard error object (unchecked exception)

    • getLight

      @GET @Path("{uid}/light") ItemValue<SharedMailbox> getLight(@PathParam("uid") String uid) throws ServerFault
      Fetches a SharedMailbox by its unique id, without vcard or mailbox
      Parameters:
      uid -
      Returns:
      Throws:
      ServerFault

    • byEmail

      @GET @Path("byEmail/{email}") ItemValue<SharedMailbox> byEmail(@PathParam("email") String email) throws ServerFault
      Fetches a SharedMailbox by its email
      Parameters:
      email - the shared mailbox's email
      Returns:
      the shared mailbox item value, or null if the shared mailbox does not exist
      Throws:
      ServerFault - standard error object (unchecked exception)

    • byName

      @GET @Path("byName/{login}") ItemValue<SharedMailbox> byName(@PathParam("login") String login) throws ServerFault
      Fetches a SharedMailbox by its name
      Parameters:
      login - the shared mailbox's login/name
      Returns:
      the shared mailbox item value, or null if the shared mailbox does not exist
      Throws:
      ServerFault - standard error object (unchecked exception)

    • delete

      @DELETE @Path("{uid}") TaskRef delete(@PathParam("uid") String uid) throws ServerFault
      Deletes a SharedMailbox. Also deletes all shared mailbox related objects and the shared mailbox's mailbox
      Specified by:
      delete in interface IRestoreDirEntryWithMailboxSupport<SharedMailbox>
      Parameters:
      uid - the shared mailbox's unique id
      Throws:
      ServerFault - standard error object (unchecked exception)

    • allUids

      @GET @Path("_alluids") List<String> allUids() throws ServerFault
      Retrieve all existing SharedMailbox uids
      Returns:
      a list of all existing SharedMailbox uids
      Throws:
      ServerFault - standard error object (unchecked exception)

    • getVCard

      @GET @Path("{uid}/vcard") VCard getVCard(@PathParam("uid") String uid) throws ServerFault
      Retrieves a SharedMailbox's contact informations (VCard)
      Parameters:
      uid - shared mailbox's unique id
      Returns:
      the shared mailbox's contact informations
      Throws:
      ServerFault - standard error object (unchecked exception)

    • setCalendarReadExtended

      @POST @Path("{uid}/_calendarReadExtended") void setCalendarReadExtended(@PathParam("uid") String uid, ReadExtendedGrantsAndRevokes rights) throws ServerFault
      Grants or revokes the ReadExtended right on every calendar owned by a shared mailbox, on behalf of its sharing/delegation editor. The addressbook/calendar/todolist/notes containers of a shared mailbox cannot be edited directly through the generic container ACL endpoint (they are kept in sync with the mailboxacl container by SharedMailboxAclManager); ReadExtended is the only right this endpoint may set, every other verb stays exclusively derived from the mailboxacl container.
      Parameters:
      uid - uid of the shared mailbox
      rights - subjects to grant or revoke ReadExtended for
      Throws:
      ServerFault