OlmFolder

Inheritance: java.lang.Object

public class OlmFolder

Represents folder information in OLM storage.

Methods

Method Description
enumerateMapiMessages() Exposes the enumerator, which supports an iteration of messages in folder.
enumerateMessages() Exposes the enumerator, which supports an iteration of messages in folder.
enumerateMessages(MailQuery query) Exposes the enumerator, which supports an iteration of messages in folder.
enumerateMessages(int startIndex, int count) Exposes the enumerator, which supports an iteration of messages in folder.
equals(Object arg0)
getClass()
getMessageCount() Gets the message count.
getName() Gets the folder name.
getPath() Gets the path.
getSubFolder(String subfolderName, boolean ignoreCase) Gets the subfolder by name.
getSubFolders() Gets the list of sub-folders.
hasMessages() Gets a value indicating whether the current folder has messages.
hashCode()
notify()
notifyAll()
toString() Returns a String that represents this instance.
wait()
wait(long arg0)
wait(long arg0, int arg1)

enumerateMapiMessages()

public final System.Collections.Generic.IGenericEnumerable<MapiMessage> enumerateMapiMessages()

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

Returns: com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.email.MapiMessage> - System.Collections.Generic.IEnumerableltTgt , that represents an enumerator that iterates through a messages in folder.

enumerateMessages()

public final System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> enumerateMessages()

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

Returns: com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.email.OlmMessageInfo> - System.Collections.Generic.IEnumerableltTgt , that represents an enumerator that iterates through a messages in folder.

enumerateMessages(MailQuery query)

public final System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> enumerateMessages(MailQuery query)

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

Parameters:

Parameter Type Description
query MailQuery MailQuery that represents search query.

Returns: com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.email.OlmMessageInfo> - System.Collections.Generic.IEnumerableltTgt , that represents an enumerator that iterates through a messages in folder.

enumerateMessages(int startIndex, int count)

public final System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> enumerateMessages(int startIndex, int count)

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

Parameters:

Parameter Type Description
startIndex int The start message index.
count int 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: com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.email.OlmMessageInfo> - System.Collections.Generic.IEnumerableltTgt , that represents an enumerator that iterates through a messages in folder.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter Type Description
arg0 java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getMessageCount()

public final int getMessageCount()

Gets the message count.

Value: The message count.

Returns: int

getName()

public final String getName()

Gets the folder name.

Value: The name.

Returns: java.lang.String

getPath()

public final String getPath()

Gets the path.

Value: The folder path.

Returns: java.lang.String

getSubFolder(String subfolderName, boolean ignoreCase)

public final OlmFolder getSubFolder(String subfolderName, boolean ignoreCase)

Gets the subfolder by name.

Parameters:

Parameter Type Description
subfolderName java.lang.String Name of subfolder.
ignoreCase boolean A value that indicates whether the name to match is case insensitive.

Returns: OlmFolder - An OlmFolder object.

getSubFolders()

public final List<OlmFolder> getSubFolders()

Gets the list of sub-folders.

Value: The list of sub-folders.

Returns: java.util.List<com.aspose.email.OlmFolder>

hasMessages()

public final boolean hasMessages()

Gets a value indicating whether the current folder has messages.

Returns: boolean - true if the current folder has messages; otherwise, false.

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

toString()

public String toString()

Returns a String that represents this instance.

Returns: java.lang.String - A String that represents this instance.

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter Type Description
arg0 long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter Type Description
arg0 long
arg1 int