net.bluemind.mailbox.api

Interface IMailboxes

All Known Subinterfaces:

IInCoreMailboxes

All Known Implementing Classes:

FakeMailboxes, MailboxesService

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

Method Summary

Modifier and Type	Method and Description
ItemValue<Mailbox>	byEmail(java.lang.String email)
ItemValue<Mailbox>	byName(java.lang.String name)
java.util.List<java.lang.String>	byRouting(Mailbox.Routing routing)
java.util.List<java.lang.String>	byType(Mailbox.Type type)
TaskRef	check(java.lang.String uid) Deprecated.
TaskRef	checkAll() Deprecated.
TaskRef	checkAndRepair(java.lang.String uid) Deprecated.
TaskRef	checkAndRepairAll() Deprecated.
void	create(java.lang.String uid, Mailbox mailbox) Creates a new Mailbox entry.
void	delete(java.lang.String uid) Delete Mailbox entry
ItemValue<Mailbox>	getComplete(java.lang.String uid) Fetch a Mailbox from its unique uid
MailFilter	getDomainFilter()
java.util.List<AccessControlEntry>	getMailboxAccessControlList(java.lang.String mailboxUid)
MailboxConfig	getMailboxConfig(java.lang.String uid)
MailFilter	getMailboxFilter(java.lang.String mailboxUid)
MailboxQuota	getMailboxQuota(java.lang.String uid)
java.lang.Integer	getUnreadMessagesCount() Get the unread mail messages count of the currently logged in user
java.util.List<ItemValue<Mailbox>>	list()
java.util.List<ItemValue<Mailbox>>	multipleGet(java.util.List<java.lang.String> uids)
void	setDomainFilter(MailFilter filter)
void	setMailboxAccessControlList(java.lang.String mailboxUid, java.util.List<AccessControlEntry> accessControlEntries)
void	setMailboxFilter(java.lang.String mailboxUid, MailFilter filter)
void	update(java.lang.String uid, Mailbox mailbox) Modifies an existing Mailbox entry.

Method Detail

create

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

Fetch a Mailbox from its unique uid

Parameters:

uid -

Returns:

ItemValue

Throws:

ServerFault

getUnreadMessagesCount

@GET
 @Path(value="_unread")
java.lang.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(value="{uid}/_quota")
MailboxQuota getMailboxQuota(@PathParam(value="uid")
                                                               java.lang.String uid)
                                                        throws ServerFault

Throws:

ServerFault

getMailboxConfig

@GET
 @Path(value="{uid}/_config")
MailboxConfig getMailboxConfig(@PathParam(value="uid")
                                                                  java.lang.String uid)
                                                           throws ServerFault

Throws:

ServerFault

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Delete Mailbox entry

Parameters:

uid -

Throws:

ServerFault

byEmail

@GET
 @Path(value="_byemail")
ItemValue<Mailbox> byEmail(@QueryParam(value="email")
                                                         java.lang.String email)
                                                  throws ServerFault

Throws:

ServerFault

byName

@GET
 @Path(value="_byname")
ItemValue<Mailbox> byName(@QueryParam(value="name")
                                                       java.lang.String name)
                                                throws ServerFault

Throws:

ServerFault

getDomainFilter

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

Throws:

ServerFault

setDomainFilter

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

Throws:

ServerFault

byType

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

Throws:

ServerFault

getMailboxFilter

@GET
 @Path(value="{mailboxUid}/_filter")
MailFilter getMailboxFilter(@PathParam(value="mailboxUid")
                                                                      java.lang.String mailboxUid)
                                                               throws ServerFault

Throws:

ServerFault

setMailboxFilter

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

Throws:

ServerFault

getMailboxAccessControlList

@GET
 @Path(value="{mailboxUid}/_acls")
java.util.List<AccessControlEntry> getMailboxAccessControlList(@PathParam(value="mailboxUid")
                                                                                                       java.lang.String mailboxUid)
                                                                                                throws ServerFault

Throws:

ServerFault

setMailboxAccessControlList

@POST
 @Path(value="{mailboxUid}/_acls")
void setMailboxAccessControlList(@PathParam(value="mailboxUid")
                                                                          java.lang.String mailboxUid,
                                                                          java.util.List<AccessControlEntry> accessControlEntries)
                                                                   throws ServerFault

Throws:

ServerFault

list

@GET
 @Path(value="_list")
java.util.List<ItemValue<Mailbox>> list()
                                                            throws ServerFault

Throws:

ServerFault

byRouting

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

Throws:

ServerFault

checkAndRepairAll

@Deprecated
 @POST
 @Path(value="_check-and-repair-all")
TaskRef checkAndRepairAll()
                                                                            throws ServerFault

Deprecated.

Use IDirEntryMaintenance.repair(Set)

 
  Set<String> opsIds = IDirEntryMaintenance.getAvailableOperations()
                                        .stream().map(mo -> mo.identifier)
                                        .collect(Collectors.toSet());
 
 for (String entryUid: IDirectory.search(
                        DirEntryQuery.filterKind(Kind.GROUP, Kind.MAILSHARE, Kind.RESOURCE, Kind.USER))
                .values.stream()
                .map(deiv -> deiv.uid)
                .collect()Collectors.toSet()) {
        IDirEntryMaintenance.repair(opsIds);
 }
 
 

Throws:

ServerFault

checkAll

@Deprecated
 @POST
 @Path(value="_check-all")
TaskRef checkAll()
                                                        throws ServerFault

Deprecated.

Use IDirEntryMaintenance.check(Set)

 
  Set<String> opsIds = IDirEntryMaintenance.getAvailableOperations()
                                        .stream().map(mo -> mo.identifier)
                                        .collect(Collectors.toSet());
 
 for (String entryUid: IDirectory.search(
                        DirEntryQuery.filterKind(Kind.GROUP, Kind.MAILSHARE, Kind.RESOURCE, Kind.USER))
                .values.stream()
                .map(deiv -> deiv.uid)
                .collect()Collectors.toSet()) {
        IDirEntryMaintenance.check(opsIds);
 }
 
 

Throws:

ServerFault

checkAndRepair

@Deprecated
 @POST
 @Path(value="{uid}/_check-and-repair")
TaskRef checkAndRepair(@PathParam(value="uid")
                                                                                  java.lang.String uid)
                                                                           throws ServerFault

Deprecated.

Use IDirEntryMaintenance.repair(Set)

 
  Set<String> opsIds = IDirEntryMaintenance.getAvailableOperations()
                                        .stream().map(mo -> mo.identifier)
                                        .collect(Collectors.toSet());
 
        IDirEntryMaintenance.repair(opsIds);
 
 

Throws:

ServerFault

check

@Deprecated
 @POST
 @Path(value="{uid}/_check")
TaskRef check(@PathParam(value="uid")
                                                              java.lang.String uid)
                                                       throws ServerFault

Deprecated.

Use IDirEntryMaintenance.check(Set)

 
  Set<String> opsIds = IDirEntryMaintenance.getAvailableOperations()
                                        .stream().map(mo -> mo.identifier)
                                        .collect(Collectors.toSet());
 
 IDirEntryMaintenance.check(opsIds);
 
 

Throws:

ServerFault

multipleGet

@POST
 @Path(value="_mget")
java.util.List<ItemValue<Mailbox>> multipleGet(java.util.List<java.lang.String> uids)
                                                                    throws ServerFault

Throws:

ServerFault