Package net.bluemind.mailbox.api

Interface IMailboxes

@Path("/mailboxes/{domainUid}")
public interface IMailboxes

Method Summary

Modifier and Type	Method	Description
Long	addDomainRule(MailFilterRule rule)
Long	addMailboxRule(String mailboxUid, MailFilterRule rule)
Long	addMailboxRuleRelative(String mailboxUid, RuleMoveRelativePosition position, long anchorId, MailFilterRule rule)
ItemValue<Mailbox>	byEmail(String email)
ItemValue<Mailbox>	byName(String name)
List<String>	byRouting(Mailbox.Routing routing)
List<String>	byType(Mailbox.Type type)
void	create(String uid, Mailbox mailbox)	Creates a new Mailbox entry.
void	delete(String uid)	Delete Mailbox entry
void	deleteDomainRule(long id)
void	deleteMailboxRule(String mailboxUid, long id)
ItemValue<Mailbox>	getComplete(String uid)	Fetch a Mailbox from its unique uid
MailFilter	getDomainFilter()
MailFilterRule	getDomainRule(long id)
List<MailFilterRule>	getDomainRules()
List<AccessControlEntry>	getMailboxAccessControlList(String mailboxUid)
MailboxConfig	getMailboxConfig(String uid)
DelegationRule	getMailboxDelegationRule(String mailboxUid)
MailFilter	getMailboxFilter(String mailboxUid)
MailFilter.Forwarding	getMailboxForwarding(String mailboxUid)
MailboxQuota	getMailboxQuota(String uid)
MailFilterRule	getMailboxRule(String mailboxUid, long id)
List<MailFilterRule>	getMailboxRules(String mailboxUid)
List<MailFilterRule>	getMailboxRulesByClient(String mailboxUid, String client)
MailFilter.Vacation	getMailboxVacation(String mailboxUid)
Integer	getUnreadMessagesCount()	Get the unread mail messages count of the currently logged in user
List<ItemValue<Mailbox>>	list()
List<String>	listUids()
void	moveMailboxRule(String mailboxUid, long id, RuleMoveDirection direction)
void	moveMailboxRuleRelative(String mailboxUid, long id, RuleMoveRelativePosition position, long anchorId)
List<ItemValue<Mailbox>>	multipleGet(List<String> uids)
void	setDomainFilter(MailFilter filter)
void	setMailboxAccessControlList(String mailboxUid, List<AccessControlEntry> accessControlEntries)
void	setMailboxDelegationRule(String mailboxUid, DelegationRule delegationRule)
void	setMailboxFilter(String mailboxUid, MailFilter filter)
void	setMailboxForwarding(String mailboxUid, MailFilter.Forwarding forwarding)
void	setMailboxVacation(String mailboxUid, MailFilter.Vacation vacation)
void	update(String uid, Mailbox mailbox)	Modifies an existing Mailbox entry.
void	updateDomainRule(long id, MailFilterRule rule)
void	updateMailboxRule(String mailboxUid, long id, MailFilterRule rule)

Method Details

create

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

Creates a new Mailbox entry.

Parameters:

uid - uid of the entry

mailbox - value of the entry

Throws:

ServerFault

update

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

Modifies an existing Mailbox entry.

Parameters:

uid - uid of the entry

mailbox - value of the entry

Throws:

ServerFault

getComplete

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

Fetch a Mailbox from its unique uid

Parameters:

uid -

Returns:

ItemValue<Mailbox>

Throws:

ServerFault

getUnreadMessagesCount

@GET
@Path("_unread")
Integer getUnreadMessagesCount()
                        throws ServerFault

Get the unread mail messages count of the currently logged in user

Returns:

unread messages count

Throws:

ServerFault

getMailboxQuota

@GET
@Path("{uid}/_quota")
MailboxQuota getMailboxQuota(@PathParam("uid")
 String uid)
                      throws ServerFault

Throws:

ServerFault

getMailboxConfig

@GET
@Path("{uid}/_config")
MailboxConfig getMailboxConfig(@PathParam("uid")
 String uid)
                        throws ServerFault

Throws:

ServerFault

delete

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

Delete Mailbox entry

Parameters:

uid -

Throws:

ServerFault

byEmail

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

Throws:

ServerFault

byName

@GET
@Path("_byname")
ItemValue<Mailbox> byName(@QueryParam("name")
 String name)
                   throws ServerFault

Throws:

ServerFault

getDomainFilter

@GET
@Path("_filter")
MailFilter getDomainFilter()
                    throws ServerFault

Throws:

ServerFault

setDomainFilter

@POST
@Path("_filter")
void setDomainFilter(MailFilter filter)
              throws ServerFault

Throws:

ServerFault

getDomainRules

@GET
@Path("_rules")
List<MailFilterRule> getDomainRules()
                             throws ServerFault

Throws:

ServerFault

getDomainRule

@GET
@Path("_rules/{id}")
MailFilterRule getDomainRule(@PathParam("id")
 long id)
                      throws ServerFault

Throws:

ServerFault

addDomainRule

@PUT
@Path("_rules")
Long addDomainRule(MailFilterRule rule)
            throws ServerFault

Throws:

ServerFault

updateDomainRule

@POST
@Path("_rules/{id}")
void updateDomainRule(@PathParam("id")
 long id,
 MailFilterRule rule)
               throws ServerFault

Throws:

ServerFault

deleteDomainRule

@DELETE
@Path("_rules/{id}")
void deleteDomainRule(@PathParam("id")
 long id)
               throws ServerFault

Throws:

ServerFault

byType

@GET
@Path("_byType")
List<String> byType(@QueryParam("email")
 Mailbox.Type type)
             throws ServerFault

Throws:

ServerFault

getMailboxVacation

@GET
@Path("{mailboxUid}/_vacation")
MailFilter.Vacation getMailboxVacation(@PathParam("mailboxUid")
 String mailboxUid)

setMailboxVacation

@POST
@Path("{mailboxUid}/_vacation")
void setMailboxVacation(@PathParam("mailboxUid")
 String mailboxUid,
 MailFilter.Vacation vacation)
                 throws ServerFault

Throws:

ServerFault

getMailboxForwarding

@GET
@Path("{mailboxUid}/_forwarding")
MailFilter.Forwarding getMailboxForwarding(@PathParam("mailboxUid")
 String mailboxUid)

setMailboxForwarding

@POST
@Path("{mailboxUid}/_forwarding")
void setMailboxForwarding(@PathParam("mailboxUid")
 String mailboxUid,
 MailFilter.Forwarding forwarding)
                   throws ServerFault

Throws:

ServerFault

getMailboxFilter

@GET
@Path("{mailboxUid}/_filter")
MailFilter getMailboxFilter(@PathParam("mailboxUid")
 String mailboxUid)
                     throws ServerFault

Throws:

ServerFault

setMailboxFilter

@POST
@Path("{mailboxUid}/_filter")
void setMailboxFilter(@PathParam("mailboxUid")
 String mailboxUid,
 MailFilter filter)
               throws ServerFault

Throws:

ServerFault

getMailboxRules

@GET
@Path("{mailboxUid}/_rules")
List<MailFilterRule> getMailboxRules(@PathParam("mailboxUid")
 String mailboxUid)
                              throws ServerFault

Throws:

ServerFault

getMailboxRulesByClient

@GET
@Path("{mailboxUid}/_rulesByClient")
List<MailFilterRule> getMailboxRulesByClient(@PathParam("mailboxUid")
 String mailboxUid,
 @QueryParam("client")
 String client)
                                      throws ServerFault

Throws:

ServerFault

getMailboxRule

@GET
@Path("{mailboxUid}/_rules/{id}")
MailFilterRule getMailboxRule(@PathParam("mailboxUid")
 String mailboxUid,
 @PathParam("id")
 long id)
                       throws ServerFault

Throws:

ServerFault

addMailboxRule

@PUT
@Path("{mailboxUid}/_rules")
Long addMailboxRule(@PathParam("mailboxUid")
 String mailboxUid,
 MailFilterRule rule)
             throws ServerFault

Throws:

ServerFault

addMailboxRuleRelative

@PUT
@Path("{mailboxUid}/_rules/{position}/{anchorId}")
Long addMailboxRuleRelative(@PathParam("mailboxUid")
 String mailboxUid,
 @PathParam("position")
 RuleMoveRelativePosition position,
 @PathParam("anchorId")
 long anchorId,
 MailFilterRule rule)
                     throws ServerFault

Throws:

ServerFault

updateMailboxRule

@POST
@Path("{mailboxUid}/_rules/{id}")
void updateMailboxRule(@PathParam("mailboxUid")
 String mailboxUid,
 @PathParam("id")
 long id,
 MailFilterRule rule)
                throws ServerFault

Throws:

ServerFault

deleteMailboxRule

@DELETE
@Path("{mailboxUid}/_rules/{id}")
void deleteMailboxRule(@PathParam("mailboxUid")
 String mailboxUid,
 @PathParam("id")
 long id)
                throws ServerFault

Throws:

ServerFault

moveMailboxRule

@POST
@Path("{mailboxUid}/_rules/{id}/{direction}")
void moveMailboxRule(@PathParam("mailboxUid")
 String mailboxUid,
 @PathParam("id")
 long id,
 @PathParam("direction")
 RuleMoveDirection direction)
              throws ServerFault

Throws:

ServerFault

moveMailboxRuleRelative

@POST
@Path("{mailboxUid}/_rules/{id}/{position}/{anchorId}")
void moveMailboxRuleRelative(@PathParam("mailboxUid")
 String mailboxUid,
 @PathParam("id")
 long id,
 @PathParam("position")
 RuleMoveRelativePosition position,
 @PathParam("anchorId")
 long anchorId)
                      throws ServerFault

Throws:

ServerFault

setMailboxDelegationRule

@POST
@Path("{mailboxUid}/_delegationRule")
void setMailboxDelegationRule(@PathParam("mailboxUid")
 String mailboxUid,
 DelegationRule delegationRule)
                       throws ServerFault

Throws:

ServerFault

getMailboxDelegationRule

@GET
@Path("{mailboxUid}/_delegationRule")
DelegationRule getMailboxDelegationRule(@PathParam("mailboxUid")
 String mailboxUid)
                                 throws ServerFault

Throws:

ServerFault

getMailboxAccessControlList

@GET
@Path("{mailboxUid}/_acls")
List<AccessControlEntry> getMailboxAccessControlList(@PathParam("mailboxUid")
 String mailboxUid)
                                              throws ServerFault

Throws:

ServerFault

setMailboxAccessControlList

@POST
@Path("{mailboxUid}/_acls")
void setMailboxAccessControlList(@PathParam("mailboxUid")
 String mailboxUid,
 List<AccessControlEntry> accessControlEntries)
                          throws ServerFault

Throws:

ServerFault

list

@GET
@Path("_list")
List<ItemValue<Mailbox>> list()
                       throws ServerFault

Throws:

ServerFault

listUids

@GET
@Path("_listUids")
List<String> listUids()

byRouting

@GET
@Path("_byRouting")
List<String> byRouting(@QueryParam("email")
 Mailbox.Routing routing)
                throws ServerFault

Throws:

ServerFault

multipleGet

@POST
@Path("_mget")
List<ItemValue<Mailbox>> multipleGet(List<String> uids)
                              throws ServerFault

Throws:

ServerFault