|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.email.FolderInfo
public final class FolderInfo
Represents information about personal folder in PST.
Constructor Summary | |
---|---|
FolderInfo()
Initializes a new instance of the FolderInfo class. |
Method Summary | |
---|---|
String |
addMessage(MapiMessage message)
Adds a new message into folder. |
FolderInfo |
addSubFolder(String name)
Adds the new subfolder. |
void |
changeDisplayName(String newName)
Changes the display name. |
Iterable<FolderInfo> |
enumerateFolders()
Exposes the enumerator, which supports an iteration of subfolders in folder. |
Iterable<MessageInfo> |
enumerateMessages()
Exposes the enumerator, which supports an iteration of messages in folder. |
String |
getContainerClass()
Gets container class of the folder object. |
int |
getContentCount()
Gets the total number of items in the folder. |
MessageInfoCollection |
getContents()
Get collection of messages. |
MessageInfoCollection |
getContents(boolean tryToReadCorruptedContents)
Get collection of messages. |
int |
getContentUnreadCount()
Gets the number of unread items in the folder. |
String |
getDisplayName()
Gets the display name of folder. |
byte[] |
getEntryId()
Gets the entry ID. |
String |
getEntryIdString()
Gets string representation of entry ID. |
Date |
getLastModificationTime()
|
MapiPropertyCollection |
getProperties()
Gets the folder properties. |
FolderInfo |
getSubFolder(String name)
Get subfolder. |
FolderInfoCollection |
getSubFolders()
Gets collection of subfolders. |
boolean |
hasSubFolders()
Gets a value indicating whether the Folder object has any subfolders. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FolderInfo()
Initializes a new instance of the FolderInfo
class.
Method Detail |
---|
public String getDisplayName()
Gets the display name of folder.
Value: The display name.
public int getContentCount()
Gets the total number of items in the folder.
Value: The content count.
public int getContentUnreadCount()
Gets the number of unread items in the folder.
Value: The content unread count.
public boolean hasSubFolders()
Gets a value indicating whether the Folder object has any subfolders.
Value: The has sub folders.
public String getContainerClass()
Gets container class of the folder object.
Value: The container class.
public Date getLastModificationTime()
public byte[] getEntryId()
Gets the entry ID.
Value: The entry id.
public String getEntryIdString()
Gets string representation of entry ID.
Value: The entry id string.
public MapiPropertyCollection getProperties()
Gets the folder properties.
public FolderInfoCollection getSubFolders()
Gets collection of subfolders.
public FolderInfo getSubFolder(String name)
Get subfolder.
name
- Name of subfolder.
public MessageInfoCollection getContents()
Get collection of messages.
public Iterable<FolderInfo> enumerateFolders()
Exposes the enumerator, which supports an iteration of subfolders in folder.
System.Collections.Generic.IEnumerableltTgt
,
that represents an enumerator that iterates through a subfolders in folder.public Iterable<MessageInfo> 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 MessageInfoCollection getContents(boolean tryToReadCorruptedContents)
Get collection of messages.
tryToReadCorruptedContents
- If the value of this parameter is true,
the method will try to read the content even if the file is corrupted.
This value can be used if the GetContents() method throws an exception about the file corruption.
If the value of this parameter is false,
the method works in the same way as GetContents() method without parameters.
public FolderInfo addSubFolder(String name)
Adds the new subfolder.
name
- The name of subfolder.
com.aspose.ms.System.NotImplementedException
- throws, if a PST file version is ANSI.
com.aspose.ms.System.IllegalArgumentException
- throws, if a subfolder name is null or empty.public String addMessage(MapiMessage message)
Adds a new message into folder.
message
- The message necessary to add.
com.aspose.ms.System.NotImplementedException
- throws, if a PST file version is ANSI.
com.aspose.ms.System.IllegalArgumentException
- throws, if a message to add is null.public void changeDisplayName(String newName)
Changes the display name.
newName
- A new name.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |