Package net.bluemind.mailshare.api

Interface IMailshare

All Superinterfaces:

IDirEntryPhotoSupport, IRestoreDirEntryWithMailboxSupport<Mailshare>, IRestoreSupport<Mailshare>

@Path("/mailshares/{domainUid}")
public interface IMailshare
extends IDirEntryPhotoSupport, IRestoreDirEntryWithMailboxSupport<Mailshare>

Method Summary

Modifier and Type	Method	Description
List<ItemValue<Mailshare>>	allComplete()	Fetches all Mailshares
ItemValue<Mailshare>	byEmail(String email)
void	create(String uid, Mailshare mailshare)	Creates a new Mailshare entry.
TaskRef	delete(String uid)	Delete Mailshare entry
ItemValue<Mailshare>	getComplete(String uid)	Fetch a Mailshare from its unique uid
void	update(String uid, Mailshare mailshare)	Modifies an existing Mailshare entry.

Methods inherited from interface net.bluemind.directory.api.IDirEntryPhotoSupport

deletePhoto, getIcon, getPhoto, setPhoto

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

get, itemValueExists, restore

Method Details

create

@PUT
@Path("{uid}")
void create(@PathParam("uid")
 String uid,
 Mailshare mailshare)
     throws ServerFault

Creates a new Mailshare entry.

Parameters:

uid - uid of the entry

mailshare - value of the entry

Throws:

ServerFault

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String uid,
 Mailshare mailshare)
     throws ServerFault

Modifies an existing Mailshare entry.

Parameters:

uid - uid of the entry

mailshare - value of the entry

Throws:

ServerFault

getComplete

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

Fetch a Mailshare from its unique uid

Specified by:

getComplete in interface IRestoreDirEntryWithMailboxSupport<Mailshare>

Parameters:

uid -

Returns:

ItemValue<Mailshare>

Throws:

ServerFault

allComplete

@GET
@Path("_complete")
List<ItemValue<Mailshare>> allComplete()
                                throws ServerFault

Fetches all Mailshares

Returns:

list of all Mailshares

Throws:

ServerFault

delete

@DELETE
@Path("{uid}")
TaskRef delete(@PathParam("uid")
 String uid)
        throws ServerFault

Delete Mailshare entry

Specified by:

delete in interface IRestoreDirEntryWithMailboxSupport<Mailshare>

Parameters:

uid -

Throws:

ServerFault

byEmail

@GET
@Path("_byemail")
ItemValue<Mailshare> byEmail(@QueryParam("email")
 String email)
                      throws ServerFault

Throws:

ServerFault