Interface ISharedMailbox

All Superinterfaces:

IRestoreDirEntryWithMailboxSupport<SharedMailbox>, IRestoreSupport<SharedMailbox>

@Path("/shared_mailboxes/{domainUid}")
public interface ISharedMailbox
extends IRestoreDirEntryWithMailboxSupport<SharedMailbox>

Method Summary

Modifier and Type	Method	Description
List<String>	allUids()	Retrieve all existing SharedMailbox uids
ItemValue<SharedMailbox>	byEmail(String email)	Fetches a SharedMailbox by its email
ItemValue<SharedMailbox>	byName(String login)	Fetches a SharedMailbox by its name
TaskRef	delete(String uid)	Deletes a SharedMailbox.
ItemValue<SharedMailbox>	getComplete(String uid)	Fetches a SharedMailbox by its unique id
ItemValue<SharedMailbox>	getLight(String uid)	Fetches a SharedMailbox by its unique id, without vcard or mailbox
VCard	getVCard(String uid)	Retrieves a SharedMailbox'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 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)