Package net.bluemind.mailbox.identity.api

Interface IMailboxIdentity

All Superinterfaces:

IRestoreCrudSupport<Identity>, IRestoreSupport<Identity>

@Path("/mailboxes/{domainUid}/identity/{mboxUid}")
public interface IMailboxIdentity
extends IRestoreCrudSupport<Identity>

Method Summary

Modifier and Type	Method	Description
void	create(String id, Identity identity)	Create an Identity.
void	delete(String id)	Delete an existing Identity.
Identity	get(String id)	Retrieve an existing Identity
List<IdentityDescription>	getIdentities()	Retrieve mailbox Identitys
List<IdentityDescription>	getPossibleIdentities()	Retrieve all possible mailbox Identitys (for each email defined in mailbox even if no identies are defined ( if identity doesnt exists for one mail, IdentityDescription.id will be null
void	update(String id, Identity identity)	Update an existing Identity.

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

itemValueExists, restore

Method Details

create

@PUT
@Path("{uid}")
void create(@PathParam("uid")
 String id,
 Identity identity)
     throws ServerFault

Create an Identity. An Identity can be used by a user to set the from header in a mail and add a signature.

Parameters:

id -

identity -

Throws:

ServerFault

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String id,
 Identity identity)
     throws ServerFault

Update an existing Identity. An Identity can be used by a user to set the from header in a mail and add a signature.

Parameters:

id -

identity -

Throws:

ServerFault

delete

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

Delete an existing Identity.

Specified by:

delete in interface IRestoreCrudSupport<Identity>

Parameters:

id -

Throws:

ServerFault

get

@GET
@Path("{uid}")
Identity get(@PathParam("uid")
 String id)
      throws ServerFault

Retrieve an existing Identity

Specified by:

get in interface IRestoreSupport<Identity>

Parameters:

id -

Returns:

Throws:

ServerFault

getIdentities

@GET
List<IdentityDescription> getIdentities()
                                 throws ServerFault

Retrieve mailbox Identitys

Returns:

Throws:

ServerFault

getPossibleIdentities

@GET
@Path("_possible")
List<IdentityDescription> getPossibleIdentities()
                                         throws ServerFault

Retrieve all possible mailbox Identitys (for each email defined in mailbox even if no identies are defined ( if identity doesnt exists for one mail, IdentityDescription.id will be null

Returns:

Throws:

ServerFault