public interface ISimplifiedThreadStructure
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.
|
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
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".
folder
- The folder full nameincludeSent
- true
to include sent mails in thread; otherwise false
cache
- Whether caller allows to serve this call with possibly cached contentindexRange
- The optional index rangemax
- The max. number of messages to considersortField
- The sort field applied to thread root elementsorder
- Whether ascending or descending sort orderfields
- The fields to pre-fill in returned instances of MailMessage
null
if SORT is not supported by mail servercom.openexchange.exception.OXException
- If messages cannot be returned