public class OlmFolder extends Object
Represents folder information in OLM storage.
Modifier and Type | Method and Description |
---|---|
com.aspose.ms.System.Collections.Generic.IGenericEnumerable<MapiMessage> |
enumerateMapiMessages()
Exposes the enumerator, which supports an iteration of messages in folder.
|
com.aspose.ms.System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> |
enumerateMessages()
Exposes the enumerator, which supports an iteration of messages in folder.
|
com.aspose.ms.System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> |
enumerateMessages(int startIndex,
int count)
Exposes the enumerator, which supports an iteration of messages in folder.
|
com.aspose.ms.System.Collections.Generic.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. |
public final String getName()
Gets the folder name.
Value: The name.public final List<OlmFolder> getSubFolders()
Gets the list of sub-folders.
Value: The list of sub-folders.public final boolean hasMessages()
Gets a value indicating whether the current folder has messages.
public final int getMessageCount()
Gets the message count.
Value: The message count.public final String getPath()
Gets the path.
Value: The folder path.public final OlmFolder getSubFolder(String subfolderName, boolean ignoreCase)
Gets the subfolder by name.
subfolderName
- Name of subfolder.ignoreCase
- A value that indicates whether the name to match is case insensitive.public final com.aspose.ms.System.Collections.Generic.IGenericEnumerable<MapiMessage> enumerateMapiMessages()
Exposes the enumerator, which supports an iteration of messages in folder.
System.Collections.Generic.IEnumerableltTgt
,
that represents an enumerator that iterates through a messages in folder.public final com.aspose.ms.System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> enumerateMessages()
Exposes the enumerator, which supports an iteration of messages in folder.
System.Collections.Generic.IEnumerableltTgt
,
that represents an enumerator that iterates through a messages in folder.public final com.aspose.ms.System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> enumerateMessages(int startIndex, int count)
Exposes the enumerator, which supports an iteration of messages in folder.
startIndex
- The start message index.count
- The number of messages that will be retrieved.
System.Collections.Generic.IEnumerableltTgt
,
that represents an enumerator that iterates through a messages in folder.com.aspose.ms.System.ArgumentOutOfRangeException
- throws, if startIndex less than 0.com.aspose.ms.System.ArgumentOutOfRangeException
- throws, if startIndex more or equal to total message count that folder contains.public final com.aspose.ms.System.Collections.Generic.IGenericEnumerable<OlmMessageInfo> enumerateMessages(MailQuery query)
Exposes the enumerator, which supports an iteration of messages in folder.
query
- MailQuery
that represents search query.System.Collections.Generic.IEnumerableltTgt
,
that represents an enumerator that iterates through a messages in folder.Copyright (c) 2008-2021 Aspose Pty Ltd. All Rights Reserved.