net.bluemind.backend.mail.api

Interface IMailboxItems

All Superinterfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<MailboxItem>, IReadByIdSupport<MailboxItem>, ISortingSupport

All Known Subinterfaces:

IInternalMailboxItems

All Known Implementing Classes:

ImapMailboxRecordsService

@Path(value="/mail_items/{replicatedMailboxUid}")
public interface IMailboxItems
extends IChangelogSupport, ICrudByIdSupport<MailboxItem>, ICountingSupport, ISortingSupport

Container of MailboxItem. The container is created by the IMailboxFolders service when a new replicated folder is created.

Method Summary

Modifier and Type	Method and Description
Ack	addFlag(FlagUpdate flagUpdate) Add one flag to multiple MailboxItem.
ImapItemIdentifier	create(MailboxItem value)
ImapAck	createById(long id, MailboxItem value)
void	deleteById(long id)
Ack	deleteFlag(FlagUpdate flagUpdate) Delete one flag to multiple MailboxItem.
void	expunge() Mark deleted items as ready for removal.
Stream	fetch(long imapUid, java.lang.String address, java.lang.String encoding, java.lang.String mime, java.lang.String charset, java.lang.String filename) Fetch a single part from an email mime tree.
Stream	fetchComplete(long imapUid)
ItemValue<MailboxItem>	getCompleteById(long id)
ItemValue<MailboxItem>	getForUpdate(long id) Decompose EML in temporary parts, useful to update drafts
java.util.List<ItemValue<MailboxItem>>	multipleById(java.util.List<java.lang.Long> ids)
java.util.List<ItemValue<MailboxItem>>	multipleGetById(java.util.List<java.lang.Long> ids)
java.util.List<java.lang.Long>	recentItems(java.util.Date deliveredOrUpdatedAfter) Get the list of ItemValue.internalId for MailboxItem delivered or updated after or at the given date.
void	removePart(java.lang.String partId) Remove a part uploaded through uploadPart(Stream)
void	resync() Removes extra records (missing on imap server)
java.util.List<java.lang.Long>	sortedIds(SortDescriptor sorted) Returns all items in a container matching a sort criteria
ItemIdentifier	unexpunge(long itemId) Re-injects a deleted item into the current folder
java.util.List<java.lang.Long>	unreadItems() Get the list of unread items, applying the per-user overlay when dealing with a shared folder.
ImapAck	updateById(long id, MailboxItem value)
java.lang.String	uploadPart(Stream part) Upload an email part (eg.

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

allIds, changeset, changesetById, containerChangelog, filteredChangesetById, getVersion, itemChangelog

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

multipleDeleteById

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

count

Method Detail

uploadPart

@PUT
 @Path(value="_part")
java.lang.String uploadPart(Stream part)

Upload an email part (eg. attachment, html body). The returned address can be used as MessageBody.Part.address when creating or updating a MailboxItem. The uploaded parts need to be cleaned-up explicitly with removePart(String)

Parameters:

part - a re-usable email part.

Returns:

an address usable as MessageBody.Part.address

unreadItems

@GET
 @Path(value="_unread")
java.util.List<java.lang.Long> unreadItems()

Get the list of unread items, applying the per-user overlay when dealing with a shared folder.

Returns:

the list of ItemValue.internalId

resync

void resync()

Removes extra records (missing on imap server)

recentItems

@GET
 @Path(value="_recent")
java.util.List<java.lang.Long> recentItems(java.util.Date deliveredOrUpdatedAfter)

Get the list of ItemValue.internalId for MailboxItem delivered or updated after or at the given date.

Parameters:

deliveredOrUpdatedAfter -

Returns:

removePart

@DELETE
 @Path(value="{partId}/_part")
void removePart(@PathParam(value="partId")
                                                       java.lang.String partId)

Remove a part uploaded through uploadPart(Stream)

Parameters:

partId - an address returned by a previous uploadPart call

getCompleteById

@GET
 @Path(value="{id}/completeById")
ItemValue<MailboxItem> getCompleteById(@PathParam(value="id")
                                                                              long id)

Specified by:

getCompleteById in interface IReadByIdSupport<MailboxItem>

updateById

@POST
 @Path(value="id/{id}")
ImapAck updateById(@PathParam(value="id")
                                                 long id,
                                                 MailboxItem value)

Specified by:

updateById in interface ICrudByIdSupport<MailboxItem>

createById

@PUT
 @Path(value="id/{id}")
ImapAck createById(@PathParam(value="id")
                                                long id,
                                                MailboxItem value)

Specified by:

createById in interface ICrudByIdSupport<MailboxItem>

create

@PUT
ImapItemIdentifier create(MailboxItem value)

deleteById

@DELETE
 @Path(value="id/{id}")
void deleteById(@PathParam(value="id")
                                                long id)

Specified by:

deleteById in interface ICrudByIdSupport<MailboxItem>

multipleById

@POST
 @Path(value="_multipleById")
java.util.List<ItemValue<MailboxItem>> multipleById(java.util.List<java.lang.Long> ids)

Parameters:

ids -

Returns:

multipleGetById

@POST
 @Path(value="_mgetById")
java.util.List<ItemValue<MailboxItem>> multipleGetById(java.util.List<java.lang.Long> ids)

Specified by:

multipleGetById in interface IReadByIdSupport<MailboxItem>

fetch

@GET
 @Path(value="part/{imapUid}/{address}")
 @Produces(value="application/octet-stream")
Stream fetch(@PathParam(value="imapUid")
                                                                                                        long imapUid,
                                                                                                        @PathParam(value="address")
                                                                                                        java.lang.String address,
                                                                                                        @QueryParam(value="encoding")
                                                                                                        java.lang.String encoding,
                                                                                                        @QueryParam(value="mime")
                                                                                                        java.lang.String mime,
                                                                                                        @QueryParam(value="charset")
                                                                                                        java.lang.String charset,
                                                                                                        @QueryParam(value="filename")
                                                                                                        java.lang.String filename)

Fetch a single part from an email mime tree. The address, encoding & charset are specified in the MessageBody.Part objects from MessageBody.structure.

Parameters:

imapUid -

address -

encoding - set null to fetch pristine part

mime - override the mime type of the response

charset - override the charset of the response

filename - set a part name (useful for download purpose)

Returns:

a stream of the (optionally) decoded part

unexpunge

@POST
 @Path(value="_unexpunge/{itemId}")
ItemIdentifier unexpunge(@PathParam(value="itemId")
                                                                   long itemId)

Re-injects a deleted item into the current folder

Parameters:

itemId - the item id of a deleted or deleted+expunged message

Returns:

expunge

@POST
 @Path(value="_expunge")
void expunge()

Mark deleted items as ready for removal. Physical will removal will occur later (cyr_expire & co)

fetchComplete

@GET
 @Path(value="eml/{imapUid}")
 @Produces(value="message/rfc822")
Stream fetchComplete(@PathParam(value="imapUid")
                                                                                           long imapUid)

Parameters:

imapUid -

Returns:

addFlag

@PUT
 @Path(value="_addFlag")
Ack addFlag(FlagUpdate flagUpdate)

Add one flag to multiple MailboxItem.

Parameters:

flagUpdate -

Returns:

the new container version

deleteFlag

@POST
 @Path(value="_deleteFlag")
Ack deleteFlag(FlagUpdate flagUpdate)

Delete one flag to multiple MailboxItem.

Parameters:

flagUpdate -

Returns:

the new container version

sortedIds

@POST
 @Path(value="_sorted")
java.util.List<java.lang.Long> sortedIds(SortDescriptor sorted)

Description copied from interface: ISortingSupport

Returns all items in a container matching a sort criteria

Specified by:

sortedIds in interface ISortingSupport

Parameters:

sorted - sorting criteria

Returns:

a list of ItemValue.internalId sorted

getForUpdate

@GET
 @Path(value="{id}/getForUpdate")
ItemValue<MailboxItem> getForUpdate(@PathParam(value="id")
                                                                           long id)

Decompose EML in temporary parts, useful to update drafts

Parameters:

message - id

Returns:

message structure with temporary addresses