davmail.exchange

Class ExchangeSession.Folder

java.lang.Object

davmail.exchange.ExchangeSession.Folder

Direct Known Subclasses:

EwsExchangeSession.Folder, GraphExchangeSession.Folder, GraphExchangeSessionDraft.Folder

Enclosing class:

ExchangeSession

public class ExchangeSession.Folder
extends Object

Exchange folder with IMAP properties

Field Summary

Fields

Modifier and Type	Field and Description
String	ctag Folder content tag (to detect folder content changes).
String	displayName Display Name.
String	etag Folder etag (to detect folder object changes).
String	folderClass Folder class (PR_CONTAINER_CLASS).
String	folderPath Logical (IMAP) folder path.
boolean	hasChildren true if folder has subfolders (DAV:hassubs).
int	messageCount Folder message count.
ExchangeSession.MessageList	messages Folder message list, empty before loadMessages call.
boolean	noInferiors true if folder has no subfolders (DAV:nosubs).
int	recent recent count
long	uidNext Next IMAP uid
int	unreadCount Folder unread message count.

Constructor Summary

Constructors

Constructor and Description
Folder()

Method Summary

Modifier and Type	Method and Description
void	clearCache() drop cached message
int	count() Folder message count.
protected void	fixUids(ExchangeSession.MessageList messages) Restore previous uids changed by a PROPPATCH (flag change).
ExchangeSession.Message	get(int index) Get message at index.
String	getFlags() Get IMAP folder flags.
TreeMap<Long,String>	getImapFlagMap() Get current folder messages imap uids and flags
long	getUidNext() Compute IMAP uidnext.
boolean	isCalendar() Calendar folder flag.
boolean	isContact() Contact folder flag.
boolean	isSpecial() Special folder flag (Sent, Drafts, Trash, Junk).
boolean	isTask() Task folder flag.
void	loadMessages() Load folder messages.
ExchangeSession.MessageList	searchMessages(ExchangeSession.Condition condition) Search messages in folder matching query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

folderPath

public String folderPath

Logical (IMAP) folder path.

displayName

public String displayName

Display Name.

folderClass

public String folderClass

Folder class (PR_CONTAINER_CLASS).

messageCount

public int messageCount

Folder message count.

unreadCount

public int unreadCount

Folder unread message count.

hasChildren

public boolean hasChildren

true if folder has subfolders (DAV:hassubs).

noInferiors

public boolean noInferiors

true if folder has no subfolders (DAV:nosubs).

ctag

public String ctag

Folder content tag (to detect folder content changes).

etag

public String etag

Folder etag (to detect folder object changes).

uidNext

public long uidNext

Next IMAP uid

recent

public int recent

recent count

messages

public ExchangeSession.MessageList messages

Folder message list, empty before loadMessages call.

Constructor Detail

Folder

public Folder()

Method Detail

getFlags

public String getFlags()

Get IMAP folder flags.

Returns:

folder flags in IMAP format

isSpecial

public boolean isSpecial()

Special folder flag (Sent, Drafts, Trash, Junk).

Returns:

true if folder is special

loadMessages

public void loadMessages()
                  throws IOException

Load folder messages.

Throws:

IOException - on error

searchMessages

public ExchangeSession.MessageList searchMessages(ExchangeSession.Condition condition)
                                           throws IOException

Search messages in folder matching query.

Parameters:

condition - search query

Returns:

message list

Throws:

IOException - on error

fixUids

protected void fixUids(ExchangeSession.MessageList messages)

Restore previous uids changed by a PROPPATCH (flag change).

Parameters:

messages - message list

count

public int count()

Folder message count.

Returns:

message count

getUidNext

public long getUidNext()

Compute IMAP uidnext.

Returns:

max(messageuids)+1

get

public ExchangeSession.Message get(int index)

Get message at index.

Parameters:

index - message index

Returns:

message

getImapFlagMap

public TreeMap<Long,String> getImapFlagMap()

Get current folder messages imap uids and flags

Returns:

imap uid list

isCalendar

public boolean isCalendar()

Calendar folder flag.

Returns:

true if this is a calendar folder

isContact

public boolean isContact()

Contact folder flag.

Returns:

true if this is a calendar folder

isTask

public boolean isTask()

Task folder flag.

Returns:

true if this is a task folder

clearCache

public void clearCache()

drop cached message