com.aspose.network
Class FolderInfo

java.lang.Object
  extended by com.aspose.network.FolderInfo

public class FolderInfo
extends Object

Represents information about personal folder in PST.


Constructor Summary
FolderInfo()
           Initializes a new instance of the FolderInfo class.
 
Method Summary
 FolderInfo addSubFolder(String name)
           Adds the new subfolder.
 void changeDisplayName(String newName)
           Changes the display name.
 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()
           
 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

FolderInfo

public FolderInfo()

Initializes a new instance of the FolderInfo class.

Method Detail

getDisplayName

public String getDisplayName()

Gets the display name of folder.

Value: The display name.


getContentCount

public int getContentCount()

Gets the total number of items in the folder.

Value: The content count.


getContentUnreadCount

public int getContentUnreadCount()

Gets the number of unread items in the folder.

Value: The content unread count.


hasSubFolders

public boolean hasSubFolders()

Gets a value indicating whether the Folder object has any subfolders.

Value: The has sub folders.


getContainerClass

public String getContainerClass()

Gets container class of the folder object.

Value: The container class.


getLastModificationTime

public Date getLastModificationTime()

getEntryId

public byte[] getEntryId()

Gets the entry ID.

Value: The entry id.


getEntryIdString

public String getEntryIdString()

Gets string representation of entry ID.

Value: The entry id string.


getSubFolders

public FolderInfoCollection getSubFolders()

Gets collection of subfolders.

Returns:
The FolderInfo collection.

getSubFolder

public FolderInfo getSubFolder(String name)

Get subfolder.

Parameters:
name - Name of subfolder.
Returns:
A FolderInfo object.

getContents

public MessageInfoCollection getContents()

Get collection of messages.

Returns:
Collection of MessageInfo.

getContents

public MessageInfoCollection getContents(boolean tryToReadCorruptedContents)

Get collection of messages.

Parameters:
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.
Returns:
Collection of MessageInfo.

addSubFolder

public FolderInfo addSubFolder(String name)

Adds the new subfolder.

Parameters:
name - The name of subfolder.
Returns:
The new subfolder.

changeDisplayName

public void changeDisplayName(String newName)

Changes the display name.

Parameters:
newName - The new name.


Copyright (c) 2002-2011 Aspose Pty Ltd. All Rights Reserved.