Interface ISharedMailbox
- All Superinterfaces:
IRestoreDirEntryWithMailboxSupport<SharedMailbox>,IRestoreSupport<SharedMailbox>
@Path("/shared_mailboxes/{domainUid}")
public interface ISharedMailbox
extends IRestoreDirEntryWithMailboxSupport<SharedMailbox>
-
Method Summary
Modifier and TypeMethodDescriptionallUids()Retrieve all existingSharedMailboxuidsFetches aSharedMailboxby its emailFetches aSharedMailboxby its nameDeletes aSharedMailbox.getComplete(String uid) Fetches aSharedMailboxby its unique idFetches aSharedMailboxby its unique id, without vcard or mailboxRetrieves aSharedMailbox's contact informations (VCard)Methods inherited from interface net.bluemind.core.container.api.IRestoreSupport
get, itemValueExists, restore
-
Method Details
-
getComplete
@GET @Path("{uid}/complete") ItemValue<SharedMailbox> getComplete(@PathParam("uid") String uid) throws ServerFault Fetches aSharedMailboxby its unique id- Specified by:
getCompletein interfaceIRestoreDirEntryWithMailboxSupport<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 aSharedMailboxby 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 aSharedMailboxby 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 aSharedMailboxby 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
Deletes aSharedMailbox. Also deletes all shared mailbox related objects and the shared mailbox's mailbox- Specified by:
deletein interfaceIRestoreDirEntryWithMailboxSupport<SharedMailbox>- Parameters:
uid- the shared mailbox's unique id- Throws:
ServerFault- standard error object (unchecked exception)
-
allUids
Retrieve all existingSharedMailboxuids- Returns:
- a list of all existing
SharedMailboxuids - Throws:
ServerFault- standard error object (unchecked exception)
-
getVCard
Retrieves aSharedMailbox'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)
-