com.openexchange.mail.api

Interface ISimplifiedThreadStructure

public interface ISimplifiedThreadStructure

ISimplifiedThreadStructure

Author:

Thorben Betten

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.util.List<MailMessage>>	getThreadSortedMessages(java.lang.String folder, boolean includeSent, boolean cache, IndexRange indexRange, long max, MailSortField sortField, OrderDirection order, MailField[] fields) An optional convenience method that gets the messages located in given folder sorted by message thread reference.

Method Detail

getThreadSortedMessages

java.util.List<java.util.List<MailMessage>> getThreadSortedMessages(java.lang.String folder,
                                                                  boolean includeSent,
                                                                  boolean cache,
                                                                  IndexRange indexRange,
                                                                  long max,
                                                                  MailSortField sortField,
                                                                  OrderDirection order,
                                                                  MailField[] fields)
                                                                    throws com.openexchange.exception.OXException

An optional convenience method that gets the messages located in given folder sorted by message thread reference. By default null is returned assuming that mailing system does not support message thread reference, but may be overridden if it does.

If underlying mailing system is IMAP, this method requires the IMAPv4 SORT extension or in detail the IMAP CAPABILITY command should contain "SORT THREAD=ORDEREDSUBJECT THREAD=REFERENCES".

Parameters:

folder - The folder full name

includeSent - true to include sent mails in thread; otherwise false

cache - Whether caller allows to serve this call with possibly cached content

indexRange - The optional index range

max - The max. number of messages to consider

sortField - The sort field applied to thread root elements

order - Whether ascending or descending sort order

fields - The fields to pre-fill in returned instances of MailMessage

Returns:

The thread-sorted messages or null if SORT is not supported by mail server

Throws:

com.openexchange.exception.OXException - If messages cannot be returned