net.bluemind.mailbox.identity.api

Interface IMailboxIdentity

All Superinterfaces:

IRestoreCrudSupport<Identity>, IRestoreSupport<Identity>

All Known Implementing Classes:

MailboxIdentityService

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

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String id, Identity identity) Create an Identity.
void	delete(java.lang.String id) Delete an existing Identity.
Identity	get(java.lang.String id) Retrieve an existing Identity
java.util.List<IdentityDescription>	getIdentities() Retrieve mailbox Identitys
java.util.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(java.lang.String id, Identity identity) Update an existing Identity.

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

restore

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.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(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.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(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String id)
                                   throws ServerFault

Delete an existing Identity.

Specified by:

delete in interface IRestoreCrudSupport<Identity>

Parameters:

id -

Throws:

ServerFault

get

@GET
 @Path(value="{uid}")
Identity get(@PathParam(value="uid")
                                        java.lang.String id)
                                 throws ServerFault

Retrieve an existing Identity

Specified by:

get in interface IRestoreSupport<Identity>

Parameters:

id -

Returns:

Throws:

ServerFault

getIdentities

@GET
java.util.List<IdentityDescription> getIdentities()
                                                throws ServerFault

Retrieve mailbox Identitys

Returns:

Throws:

ServerFault

getPossibleIdentities

@GET
 @Path(value="_possible")
java.util.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