com.aspose.email

Class OlmFolder

java.lang.Object

com.aspose.email.OlmFolder

public class OlmFolder
extends Object

Represents folder information in OLM storage.

Method Summary

Methods

Modifier and Type	Method and Description
IGenericEnumerable<MapiMessage>	enumerateMapiMessages() Exposes the enumerator, which supports an iteration of messages in folder.
IGenericEnumerable<OlmMessageInfo>	enumerateMessages() Exposes the enumerator, which supports an iteration of messages in folder.
IGenericEnumerable<OlmMessageInfo>	enumerateMessages(int startIndex, int count) Exposes the enumerator, which supports an iteration of messages in folder.
IGenericEnumerable<OlmMessageInfo>	enumerateMessages(MailQuery query) Exposes the enumerator, which supports an iteration of messages in folder.
int	getMessageCount() Gets the message count.
String	getName() Gets the folder name.
String	getPath() Gets the path.
OlmFolder	getSubFolder(String subfolderName, boolean ignoreCase) Gets the subfolder by name.
List<OlmFolder>	getSubFolders() Gets the list of sub-folders.
boolean	hasMessages() Gets a value indicating whether the current folder has messages.
String	toString() Returns a String that represents this instance.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

Gets the folder name.

Value: The name.

getSubFolders

public final List<OlmFolder> getSubFolders()

Gets the list of sub-folders.

Value: The list of sub-folders.

hasMessages

public final boolean hasMessages()

Gets a value indicating whether the current folder has messages.

Returns:

true if the current folder has messages; otherwise, false.

getMessageCount

public final int getMessageCount()

Gets the message count.

Value: The message count.

getPath

public final String getPath()

Gets the path.

Value: The folder path.

getSubFolder

public final OlmFolder getSubFolder(String subfolderName,
                     boolean ignoreCase)

Gets the subfolder by name.

Parameters:

subfolderName - Name of subfolder.

ignoreCase - A value that indicates whether the name to match is case insensitive.

Returns:

An OlmFolder object.

enumerateMapiMessages

public final IGenericEnumerable<MapiMessage> enumerateMapiMessages()

Exposes the enumerator, which supports an iteration of messages in folder.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in folder.

enumerateMessages

public final IGenericEnumerable<OlmMessageInfo> enumerateMessages()

Exposes the enumerator, which supports an iteration of messages in folder.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in folder.

enumerateMessages

public final IGenericEnumerable<OlmMessageInfo> enumerateMessages(int startIndex,
                                                   int count)

Exposes the enumerator, which supports an iteration of messages in folder.

Parameters:

startIndex - The start message index.

count - The number of messages that will be retrieved.

If "count" param is less than 0 or more than remained message count then remained message count will be returned.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in folder.

Throws:

ArgumentOutOfRangeException - throws, if startIndex less than 0.

ArgumentOutOfRangeException - throws, if startIndex more or equal to total message count that folder contains.

enumerateMessages

public final IGenericEnumerable<OlmMessageInfo> enumerateMessages(MailQuery query)

Exposes the enumerator, which supports an iteration of messages in folder.

Parameters:

query - MailQuery that represents search query.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in folder.

toString

public String toString()

Returns a String that represents this instance.

Overrides:

toString in class Object

Returns:

A String that represents this instance.