Interface IMailshare

All Superinterfaces:

IDirEntryPhotoSupport, IRestoreDirEntryWithMailboxSupport<Mailshare>, IRestoreSupport<Mailshare>

All Known Subinterfaces:

IInternalMailshare

@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)	Deprecated.
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 IDirEntryPhotoSupport

deletePhoto, getIcon, getPhoto, setPhoto

Methods inherited from interface IRestoreSupport

get, itemValueExists, restore

Method Details

create

@Deprecated(since="5.5")
@PUT
@Path("{uid}")
void create(@PathParam("uid")
 String uid,
 Mailshare mailshare)
     throws net.bluemind.core.api.fault.ServerFault

Deprecated.

Creates a new Mailshare entry.
Since version 5.5, Mailshare creation has been disabled in favor of shared mailbox creation.
To do this, use PUT /users/{domainUid}/{uid} with the User loginCaps set to false.
However, it is possible, particularly for testing purposes,
to use an internal API to continue creating Mailshares using
IInternalMailshare.createMailshare()

Parameters:

uid - uid of the entry

mailshare - value of the entry

Throws:

net.bluemind.core.api.fault.ServerFault

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String uid,
 Mailshare mailshare)
     throws net.bluemind.core.api.fault.ServerFault

Modifies an existing Mailshare entry.

Parameters:

uid - uid of the entry

mailshare - value of the entry

Throws:

net.bluemind.core.api.fault.ServerFault

getComplete

@GET
@Path("{uid}/complete")
ItemValue<Mailshare> getComplete(@PathParam("uid")
 String uid)
                          throws net.bluemind.core.api.fault.ServerFault

Fetch a Mailshare from its unique uid

Specified by:

getComplete in interface IRestoreDirEntryWithMailboxSupport<Mailshare>

Parameters:

uid -

Returns:

ItemValue<Mailshare>

Throws:

net.bluemind.core.api.fault.ServerFault

allComplete

@GET
@Path("_complete")
List<ItemValue<Mailshare>> allComplete()
                                throws net.bluemind.core.api.fault.ServerFault

Fetches all Mailshares

Returns:

list of all Mailshares

Throws:

net.bluemind.core.api.fault.ServerFault

delete

@DELETE
@Path("{uid}")
TaskRef delete(@PathParam("uid")
 String uid)
        throws net.bluemind.core.api.fault.ServerFault

Delete Mailshare entry

Specified by:

delete in interface IRestoreDirEntryWithMailboxSupport<Mailshare>

Parameters:

uid -

Throws:

net.bluemind.core.api.fault.ServerFault

byEmail

@GET
@Path("_byemail")
ItemValue<Mailshare> byEmail(@QueryParam("email")
 String email)
                      throws net.bluemind.core.api.fault.ServerFault

Throws:

net.bluemind.core.api.fault.ServerFault