FolderInfo (Aspose.Email for Java 24.9 API Documentation)

java.lang.Object
- com.aspose.email.FolderInfo

```
public final class FolderInfo
extends Object
```
Represents information about personal folder in PST.

Field Summary

Fields
Modifier and Type	Field and Description
`Event<ItemMovedEventHandler>`	`ItemMoved` Occurs when an item is moved to the another folder.
`Event<MessageAddedEventHandler>`	`MessageAdded` Occurs when a message is added to the current folder.

Constructor Summary

Constructors
Constructor and Description

FolderInfo()
Initializes a new instance of the FolderInfo class.

Constructors
Constructor and Description
`FolderInfo()` Initializes a new instance of the `FolderInfo` class.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`addFile(String fileName, String messageClass)` Adds a file into pst folder.
`String`	`addMapiMessageItem(IMapiMessageItem item)` Adds the IMapiMessageItem object into folder.
`String`	`addMessage(MapiMessage message)` Adds a new message into folder.
`void`	`addMessages(Iterable<MapiMessage> messages)` Provides message adding in a bulk mode.
`FolderInfo`	`addSubFolder(String name)` Adds the new sub-folder.
`FolderInfo`	`addSubFolder(String name, boolean createHierarchy)` Adds the new sub-folder.
`FolderInfo`	`addSubFolder(String name, FolderCreationOptions creationOptions)` Adds a subfolder with the specified name to the current folder using the provided creation options.
`FolderInfo`	`addSubFolder(String name, String containerClass)` Adds the new subfolder.
`void`	`changeContainerClass(String containerClass)` Changes the container class.
`void`	`changeDisplayName(String newName)` Changes the display name.
`void`	`changeMessages(Iterable<String> entryIdCollection, MapiPropertyCollection updatedProperties)` Changes the messages in folder.
`void`	`changeMessages(MapiPropertyCollection updatedProperties)` Changes all messages in folder.
`void`	`deleteChildItem(byte[] entryId)` Deletes the item (folder or message) by it's entryId.
`void`	`deleteChildItems(Iterable<String> entryIdCollection)` Deletes the child messages.
`IGenericEnumerable<FolderInfo>`	`enumerateFolders()` Exposes the enumerator, which supports an iteration of subfolders in folder.
`IGenericEnumerable<FolderInfo>`	`enumerateFolders(int kind)` Exposes the enumerator, which supports an iteration of subfolders in folder.
`IGenericEnumerable<MapiMessage>`	`enumerateMapiMessages()` Exposes the enumerator, which supports an iteration of messages in folder.
`IGenericEnumerable<MessageObject>`	`enumerateMessageObjects()` Exposes the enumerator, which supports an iteration of messages in folder.
`IGenericEnumerable<MessageInfo>`	`enumerateMessages()` Exposes the enumerator, which supports an iteration of messages in folder.
`IGenericEnumerable<String>`	`enumerateMessagesEntryId()` Enumerates the entryID of messages.
`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. Method is used to display brief message information `MessageInfo` like subject, sender, recipients.
`MessageInfoCollection`	`getContents(boolean tryToReadCorruptedContents)` Get collection of messages. Method is used to display brief message information `MessageInfo` like subject, sender, recipients.
`MessageInfoCollection`	`getContents(int kind)` Get collection of messages. Method is used to display brief message information `MessageInfo` like subject, sender, recipients.
`MessageInfoCollection`	`getContents(int startIndex, int count)` Gets the collection of messages. Method is used to display brief message information `MessageInfo` like subject, sender, recipients.
`MessageInfoCollection`	`getContents(MailQuery query)` Get collection of messages. Method is used to display brief message information `MessageInfo` like subject, sender, recipients.
`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()` Gets the last modification time.
`int`	`getPredefinedType(boolean getForTopLevelParent)` Gets the type of predefined folder.
`MapiPropertyCollection`	`getProperties()` Gets the folder properties.
`FolderInfo`	`getSubFolder(String name)` Get subfolder.
`FolderInfo`	`getSubFolder(String name, boolean ignoreCase)` Gets the subfolder.
`FolderInfo`	`getSubFolder(String name, boolean ignoreCase, boolean handlePathSeparator)` Retrieves a subfolder with the specified name from the current folder.
`FolderInfoCollection`	`getSubFolders()` Gets collection of subfolders.
`FolderInfoCollection`	`getSubFolders(int kind)` Gets collection of subfolders.
`FolderInfoCollection`	`getSubFolders(MailQuery query)` Gets collection of subfolders.
`boolean`	`hasSubFolders()` Gets a value indicating whether the Folder object has any subfolders.
`void`	`mergeWith(FolderInfo sourceFolder)` Merges the folder with the folder from another pst.
`void`	`mergeWith(FolderInfo sourceFolder, boolean recursiveHandler)` Merges the folder with the folder from another pst.
`void`	`moveContents(FolderInfo newFolder)` Moves the contents to a new folder.
`void`	`moveSubfolders(FolderInfo newFolder)` Moves the subfolders to a new parent folder.
`String`	`retrieveFullPath()` Retrieves the full path of folder within the PST file.
`void`	`updateMessage(String entryId, MapiMessageItemBase updatedMessage)` Updates the message in folder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MessageAdded
```
public final Event<MessageAddedEventHandler> MessageAdded
```
    Occurs when a message is added to the current folder.
  - ItemMoved
```
public Event<ItemMovedEventHandler> ItemMoved
```
    Occurs when an item is moved to the another folder.
- Constructor Detail
  - FolderInfo
```
public FolderInfo()
```
    Initializes a new instance of the FolderInfo class.
- Method Detail
  - getDisplayName
```
public final String getDisplayName()
```
    Gets the display name of folder.
    Value: The display name.
  - getContentCount
```
public final int getContentCount()
```
    Gets the total number of items in the folder.
    Value: The content count.
  - getContentUnreadCount
```
public final int getContentUnreadCount()
```
    Gets the number of unread items in the folder.
    Value: The content unread count.
  - hasSubFolders
```
public final boolean hasSubFolders()
```
    Gets a value indicating whether the Folder object has any subfolders.
    Value: The has sub folders.
  - getContainerClass
```
public final String getContainerClass()
```
    Gets container class of the folder object.
    Value: The container class.
  - getLastModificationTime
```
public final Date getLastModificationTime()
```
    Gets the last modification time.
    Value: The last modification time. If the folder doesn't have PR_LAST_MODIFICATION_TIME property, DateTime.MinValue is returned.
  - getEntryId
```
public final byte[] getEntryId()
```
    Gets the entry ID.
    Value: The entry id.
  - getEntryIdString
```
public final String getEntryIdString()
```
    Gets string representation of entry ID.
    Value: The entry id string.
  - getProperties
```
public final MapiPropertyCollection getProperties()
```
    Gets the folder properties.
  - getSubFolder
```
public final FolderInfo getSubFolder(String name)
```
    Get subfolder.
    
    Parameters:
    name - Name of subfolder.
    
    Returns:
    A FolderInfo object.
  - getSubFolder
```
public final FolderInfo getSubFolder(String name,
                      boolean ignoreCase)
```
    Gets the subfolder.
    
    Parameters:
    name - Name of subfolder.
    ignoreCase - Indicates that a search should ignore case sensitivity when matching the folder name.
    
    Returns:
    A FolderInfo object.
  - getSubFolder
```
public final FolderInfo getSubFolder(String name,
                      boolean ignoreCase,
                      boolean handlePathSeparator)
```
    Retrieves a subfolder with the specified name from the current folder.
    
    Parameters:
    name - The name of the subfolder to retrieve.
    ignoreCase - Specifies whether to perform a case-insensitive search for folders with the given name.
    handlePathSeparator - Specifies whether the specified folder name should be treated as a path if it contains backslashes.
    The name parameter specifies the name of the subfolder to retrieve. The ignoreCase parameter determines whether the search for the subfolder name should be case-sensitive or case-insensitive. If set to true, the search will be case-insensitive, otherwise, it will be case-sensitive. The handlePathSeparator parameter specifies whether the specified folder name should be treated as a path if it contains backslashes. If set to true, the method will interpret the folder name as a path, attempting to navigate to the subfolder using the path. If set to false, the method will treat the folder name as a simple name, searching for a subfolder with an exact name match. If the subfolder is found, the method returns the FolderInfo object representing the retrieved subfolder. If the subfolder is not found, the method returns null.
    
    Returns:
    The FolderInfo representing the retrieved subfolder, or null if the subfolder is not found.
  - getSubFolders
```
public final FolderInfoCollection getSubFolders()
```
    Gets collection of subfolders.
    
    Returns:
    The FolderInfo collection.
  - getSubFolders
```
public final FolderInfoCollection getSubFolders(int kind)
```
    Gets collection of subfolders.
    
    Parameters:
    kind - The FolderKind that represents kind of folder.
    
    Returns:
    The FolderInfo collection.
  - getSubFolders
```
public final FolderInfoCollection getSubFolders(MailQuery query)
```
    Gets collection of subfolders.
    
    Parameters:
    query - MailQuery that represents search query.
    
    Returns:
    The FolderInfo collection.
  - getContents
```
public final MessageInfoCollection getContents(boolean tryToReadCorruptedContents)
```
    Get collection of messages.
    Method is used to display brief message information MessageInfo like subject, sender, recipients. In terms of performance, this is the most suitable option for obtaining primary information about messages. To extract complete message data, the PersonalStorage.extractMessage(MessageInfo) method is provided.
    
    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.
  - getContents
```
public final MessageInfoCollection getContents()
```
    Get collection of messages.
    Method is used to display brief message information MessageInfo like subject, sender, recipients. In terms of performance, this is the most suitable option for obtaining primary information about messages. To extract complete message data, the PersonalStorage.extractMessage(MessageInfo) method is provided.
    
    Returns:
    Collection of MessageInfo.
  - getContents
```
public final MessageInfoCollection getContents(int kind)
```
    Get collection of messages.
    Method is used to display brief message information MessageInfo like subject, sender, recipients. In terms of performance, this is the most suitable option for obtaining primary information about messages. To extract complete message data, the PersonalStorage.extractMessage(MessageInfo) method is provided.
    
    Parameters:
    kind - The message kind.
    
    Returns:
    Collection of MessageInfo.
  - getContents
```
public final MessageInfoCollection getContents(MailQuery query)
```
    Get collection of messages.
    Method is used to display brief message information MessageInfo like subject, sender, recipients. In terms of performance, this is the most suitable option for obtaining primary information about messages. To extract complete message data, the PersonalStorage.extractMessage(MessageInfo) method is provided.
    
    Parameters:
    query - MailQuery that represents search query.
    
    Returns:
    Collection of MessageInfo.
  - getContents
```
public final MessageInfoCollection getContents(int startIndex,
                                int count)
```
    Gets the collection of messages.
    Method is used to display brief message information MessageInfo like subject, sender, recipients. In terms of performance, this is the most suitable option for obtaining primary information about messages. To extract complete message data, the PersonalStorage.extractMessage(MessageInfo) method is provided.
    
    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:
    Collection of MessageInfo.
    
    Throws:
    
    ArgumentOutOfRangeException - throws, if startIndex less than 0.
    
    ArgumentOutOfRangeException - throws, if startIndex more or equal to total message count that folder contains.
  - enumerateFolders
```
public final IGenericEnumerable<FolderInfo> enumerateFolders()
```
    Exposes the enumerator, which supports an iteration of subfolders in folder.
    
    Returns:
    System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a subfolders in folder.
  - enumerateFolders
```
public final IGenericEnumerable<FolderInfo> enumerateFolders(int kind)
```
    Exposes the enumerator, which supports an iteration of subfolders in folder.
    
    Parameters:
    kind - The FolderKind that represents kind of folder.
    
    Returns:
    System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a subfolders in folder.
  - enumerateMessages
```
public final IGenericEnumerable<MessageInfo> 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.
  - enumerateMessageObjects
```
public final IGenericEnumerable<MessageObject> enumerateMessageObjects()
```
    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.
  - 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.
  - enumerateMessagesEntryId
```
public final IGenericEnumerable<String> enumerateMessagesEntryId()
```
    Enumerates the entryID of messages.
    
    Returns:
    System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through entryID of messages in folder.
  - retrieveFullPath
```
public final String retrieveFullPath()
```
    Retrieves the full path of folder within the PST file.
    
    Returns:
    The string that represents the full path.
  - addSubFolder
```
public final FolderInfo addSubFolder(String name,
                      boolean createHierarchy)
```
    Adds the new sub-folder.
    
    Parameters:
    name - The name of sub-folder.
    createHierarchy - if set to true, it is possible to create a folder hierarchy using string notation. Backslash ('\') is used as path separator.
    
    Returns:
    The new sub-folder.
    
    Throws:
    
    NotImplementedException - throws, if a PST file version is ANSI.
    
    ArgumentNullException - throws, if a sub-folder name is null or empty.
    
    InvalidOperationException - throws, if a PST is open for reading only.
  - addSubFolder
```
public final FolderInfo addSubFolder(String name)
```
    Adds the new sub-folder.
    
    Parameters:
    name - The name of sub-folder.
    
    Returns:
    The new sub-folder.
    
    Throws:
    
    NotImplementedException - throws, if a PST file version is ANSI.
    
    ArgumentNullException - throws, if a sub-folder name is null or empty.
    
    InvalidOperationException - throws, if a PST is open for reading only.
  - addSubFolder
```
public final FolderInfo addSubFolder(String name,
                      String containerClass)
```
    Adds the new subfolder.
    
    Parameters:
    name - The name of subfolder.
    containerClass - Container class of the sub-Folder object.
    
    Returns:
    The new subfolder.
    
    Throws:
    
    NotImplementedException - throws, if a PST file version is ANSI.
    
    ArgumentNullException - throws, if a subfolder name is null or empty.
    
    InvalidOperationException - throws, if a PST is open for reading only.
    
    InvalidOperationException - throws, if a folder with same name already exists. The comparison will be case-insensitive, and the folder creation operation will consider folders with the same name but different casing as duplicates.
  - addSubFolder
```
public final FolderInfo addSubFolder(String name,
                      FolderCreationOptions creationOptions)
```
    Adds a subfolder with the specified name to the current folder using the provided creation options.
    
    Parameters:
    name - The name of the subfolder to add.
    creationOptions - The options for creating the subfolder.
    The name parameter specifies the name of the subfolder to add. The creationOptions parameter allows customization of the subfolder creation behavior, such as specifying whether to create the hierarchy of parent folders and the container class of the new subfolder. If the subfolder with the specified name already exists, the behavior depends on the value of FolderCreationOptions.AllowNameCaseDifference(FolderCreationOptions.getAllowNameCaseDifference()/FolderCreationOptions.setAllowNameCaseDifference(boolean)). If FolderCreationOptions.AllowNameCaseDifference(FolderCreationOptions.getAllowNameCaseDifference()/FolderCreationOptions.setAllowNameCaseDifference(boolean)) is set to true, a difference in name casing will be allowed, and the subfolder will be added even if an existing folder with the same name but in a different case exists. If FolderCreationOptions.AllowNameCaseDifference(FolderCreationOptions.getAllowNameCaseDifference()/FolderCreationOptions.setAllowNameCaseDifference(boolean)) is set to false, the comparison will be case-insensitive, and an InvalidOperationException will be thrown to indicate that a folder with the specified name already exists. The name may contain backslash (\) as the path separators (for example, "parent1\parent2\subfolder"). In this case if FolderCreationOptions.CreateHierarchy(FolderCreationOptions.getCreateHierarchy()/FolderCreationOptions.setCreateHierarchy(boolean)) is set to true, the hierarchy of parent folders should be created.
    
    Returns:
    The FolderInfo representing the added subfolder.
    
    Throws:
    
    NotImplementedException - throws, if a PST file version is ANSI.
    
    ArgumentNullException - throws, if a subfolder name is null or empty.
    
    InvalidOperationException - throws, if a PST is open for reading only.
    
    InvalidOperationException - throws, if a folder with same name already exists. Whether folders have the same name will depend on the FolderCreationOptions.AllowNameCaseDifference(FolderCreationOptions.getAllowNameCaseDifference()/FolderCreationOptions.setAllowNameCaseDifference(boolean)) parameter.
  - addMessage
```
public final String addMessage(MapiMessage message)
```
    Adds a new message into folder.
    
    Parameters:
    message - The message necessary to add.
    
    Returns:
    The string that represents the EntryId of the added message.
    
    Throws:
    
    NotImplementedException - throws, if a PST file version is ANSI.
    
    ArgumentNullException - throws, if a message to add is null.
    
    InvalidOperationException - throws, if a PST is open for reading only.
  - addFile
```
public final String addFile(String fileName,
             String messageClass)
```
    Adds a file into pst folder.
    
    Parameters:
    fileName - The name of file necessary to add.
    messageClass - The message class.
    
    Returns:
    The string that represents the EntryId of the added message.
    
    Throws:
    
    NotImplementedException - throws, if a PST file version is ANSI.
    
    ArgumentNullException - throws, if a name of file to add is null or empty.
    
    InvalidOperationException - throws, if a PST is open for reading only.
  - addMapiMessageItem
```
public final String addMapiMessageItem(IMapiMessageItem item)
```
    Adds the IMapiMessageItem object into folder.
    
    Parameters:
    item - The item necessary to add.
    
    Returns:
    The string that represents the EntryId of the added item.
    
    Throws:
    
    NotImplementedException - throws, if a PST file version is ANSI.
    
    ArgumentNullException - throws, if an item to add is null.
    
    InvalidOperationException - throws, if a PST is open for reading only.
    
    NotSupportedException - Thrown when MessageClass doesn't belong to IPM.Note, IPM.StickyNote, IPM.Contact, IPM.Activity, IPM.Appointment, IPM.Schedule.meeting, IPM.Task.
    
    InvalidOperationException - Thrown when MessageClass doesn't correspond to the folder's ContainerClass.
  - addMessages
```
public final void addMessages(Iterable<MapiMessage> messages)
```
    Provides message adding in a bulk mode.
    
    Parameters:
    messages - An IEnumerator representing the enumerator, which supports iteration over a collection of MapiMessage.
    
    Throws:
    
    NotImplementedException - Thrown when attempting to edit the ANSI file version.
  - moveContents
```
public final void moveContents(FolderInfo newFolder)
```
    Moves the contents to a new folder.
    
    Parameters:
    newFolder - The new folder.
    
    Throws:
    
    NotImplementedException - Thrown when attempting to edit the ANSI file version.
    
    ArgumentNullException - Thrown when new folder is null.
  - moveSubfolders
```
public final void moveSubfolders(FolderInfo newFolder)
```
    Moves the subfolders to a new parent folder.
    
    Parameters:
    newFolder - The new parent folder.
    
    Throws:
    
    NotImplementedException - Thrown when attempting to edit the ANSI file version.
    
    ArgumentNullException - Thrown when new folder is null.
  - mergeWith
```
public final void mergeWith(FolderInfo sourceFolder)
```
    Merges the folder with the folder from another pst.
    
    Parameters:
    sourceFolder - The source folder.
    
    Throws:
    
    InvalidOperationException - Throws when the source folder is located in the same pst.
    
    NotImplementedException - Thrown when attempting to edit the ANSI file version.
  - mergeWith
```
public final void mergeWith(FolderInfo sourceFolder,
             boolean recursiveHandler)
```
    Merges the folder with the folder from another pst. OnItemMoved event is called on both messages and directories.
    
    Parameters:
    sourceFolder - The source folder.
    recursiveHandler - If true, OnItemMoved will be called on all messages, including messages in sub-directories, otherwise OnItemMoved will be called only for messages in the current directory.
    
    Throws:
    
    InvalidOperationException - Throws when the source folder is located in the same pst.
    
    NotImplementedException - Thrown when attempting to edit the ANSI file version.
  - deleteChildItem
```
public final void deleteChildItem(byte[] entryId)
```
    Deletes the item (folder or message) by it's entryId.
    
    Parameters:
    entryId - The entry id.
    The item must be contained in a folder.
    
    Throws:
    
    ArgumentNullException - throws, if entryId is null.
    
    InvalidOperationException - throws, if the item doesn't belong to the folder or the item can't be deleted or entryID has the incorrect value.
    
    InvalidOperationException - throws, if a PST is open for reading only.
    
    NotImplementedException - Thrown when attempting to edit the ANSI file version.
  - deleteChildItems
```
public final void deleteChildItems(Iterable<String> entryIdCollection)
```
    Deletes the child messages.
    
    Parameters:
    entryIdCollection - The entry id collection.
    
    Throws:
    
    InvalidOperationException - The PST is open for reading only. or The item, to be deleted, doesn't belong to this folder. or The search folder cannot be deleted. or The \Deleted Items\ folder cannot be deleted. or The entryId is incorrect.
    
    ArgumentNullException - entryId;The entryId cannot be null.
    
    NotImplementedException - Thrown when attempting to edit the ANSI file version.
  - updateMessage
```
public final void updateMessage(String entryId,
                 MapiMessageItemBase updatedMessage)
```
    Updates the message in folder.
    
    Parameters:
    entryId - The message entry identifier.
    updatedMessage - The updated message.
    
    Throws:
    
    NotImplementedException - The ANSI file version editing is not implemented.
    
    InvalidOperationException - The PST is open for reading only. or The entryId is incorrect.
    
    ArgumentNullException - entryId; The entry id cannot be null or empty. or updatedMessage; The message cannot be null.
  - changeMessages
```
public final void changeMessages(Iterable<String> entryIdCollection,
                  MapiPropertyCollection updatedProperties)
```
    Changes the messages in folder.
    
    Parameters:
    entryIdCollection - The entry identifier collection.
    updatedProperties - The updated properties.
    
    Throws:
    
    NotImplementedException - The ANSI file version editing is not implemented.
    
    InvalidOperationException - The PST is open for reading only. or The entryId is incorrect.
    
    ArgumentNullException - entryIdCollection;The collection of entry ids cannot be null. or updatedProperties;The collection of properties cannot be null.
  - changeMessages
```
public final void changeMessages(MapiPropertyCollection updatedProperties)
```
    Changes all messages in folder.
    
    Parameters:
    updatedProperties - The updated properties.
    
    Throws:
    
    NotImplementedException - The ANSI file version editing is not implemented.
    
    InvalidOperationException - The PST is open for reading only. or The entryId is incorrect.
    
    ArgumentNullException - entryIdCollection;The collection of entry ids cannot be null. or updatedProperties;The collection of properties cannot be null.
  - changeContainerClass
```
public final void changeContainerClass(String containerClass)
```
    Changes the container class.
    
    Parameters:
    containerClass - Container class of the of the folder object.
    
    Throws:
    
    InvalidOperationException - throws, if a PST is open for reading only.
    
    NotImplementedException - throws, if a PST file version is ANSI.
  - changeDisplayName
```
public final void changeDisplayName(String newName)
```
    Changes the display name.
    
    Parameters:
    newName - A new name.
    
    Throws:
    
    InvalidOperationException - throws, if a PST is open for reading only.
    
    NotImplementedException - throws, if a PST file version is ANSI.
  - getPredefinedType
```
public final int getPredefinedType(boolean getForTopLevelParent)
```
    Gets the type of predefined folder.
    
    Parameters:
    getForTopLevelParent - If true, returns the predefined type for the top-level parent folder. This determines whether the current folder is a subfolder of a predefined folder. If false, it returns the predefined type for the current folder.
    Checks if the folder is predefined by returning the corresponding type.
    
    Returns:
    The StandardIpmFolder enum value. If the folder is not predefined, it returns StandardIpmFolder.Unspecified

Class FolderInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MessageAdded

ItemMoved

Constructor Detail

FolderInfo

Method Detail

getDisplayName

getContentCount

getContentUnreadCount

hasSubFolders

getContainerClass

getLastModificationTime

getEntryId

getEntryIdString

getProperties

getSubFolder

getSubFolder

getSubFolder

getSubFolders

getSubFolders

getSubFolders

getContents

getContents

getContents

getContents

getContents

enumerateFolders

enumerateFolders

enumerateMessages

enumerateMessageObjects

enumerateMapiMessages

enumerateMessagesEntryId

retrieveFullPath

addSubFolder

addSubFolder

addSubFolder

addSubFolder

addMessage

addFile

addMapiMessageItem

addMessages

moveContents

moveSubfolders

mergeWith

mergeWith

deleteChildItem

deleteChildItems

updateMessage

changeMessages

changeMessages

changeContainerClass

changeDisplayName

getPredefinedType