com.aspose.email

Class FolderCreationOptions

java.lang.Object

com.aspose.email.FolderCreationOptions

public class FolderCreationOptions
extends Object

Represents the options for creating a subfolder in the Outlook PST message store. This class serves as a container for configuring specific settings related to the creation of subfolders.

Constructor Summary

Constructors

Constructor and Description
FolderCreationOptions() Initializes a new instance of the FolderCreationOptions class with default values.
FolderCreationOptions(boolean createHierarchy, boolean allowNameCaseDifference) Initializes a new instance of the FolderCreationOptions class with the specified parameters.
FolderCreationOptions(boolean createHierarchy, boolean allowNameCaseDifference, String containerClass) Initializes a new instance of the FolderCreationOptions class with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAllowNameCaseDifference() Gets or sets a value indicating whether to allow a difference in name casing when comparing folder names.
String	getContainerClass() Gets or sets the container class for the new subfolder.
boolean	getCreateHierarchy() Gets or sets a value indicating whether to create the hierarchy of parent folders.
boolean	getEnforceContainerClassMatching() Gets or sets a value indicating whether to enforce container class checking.
void	setAllowNameCaseDifference(boolean value) Gets or sets a value indicating whether to allow a difference in name casing when comparing folder names.
void	setContainerClass(String value) Gets or sets the container class for the new subfolder.
void	setCreateHierarchy(boolean value) Gets or sets a value indicating whether to create the hierarchy of parent folders.
void	setEnforceContainerClassMatching(boolean value) Gets or sets a value indicating whether to enforce container class checking.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderCreationOptions

public FolderCreationOptions()

Initializes a new instance of the FolderCreationOptions class with default values.

FolderCreationOptions

public FolderCreationOptions(boolean createHierarchy,
                     boolean allowNameCaseDifference)

Initializes a new instance of the FolderCreationOptions class with the specified parameters.

Parameters:

createHierarchy - A value indicating whether to create the hierarchy of parent folders if they don't exist.

allowNameCaseDifference - A value indicating whether to allow a difference in name casing when comparing folder names.

FolderCreationOptions

public FolderCreationOptions(boolean createHierarchy,
                     boolean allowNameCaseDifference,
                     String containerClass)

Initializes a new instance of the FolderCreationOptions class with the specified parameters.

Parameters:

createHierarchy - A value indicating whether to create the hierarchy of parent folders if they don't exist.

allowNameCaseDifference - A value indicating whether to allow a difference in name casing when comparing folder names.

containerClass - The container class for the new subfolder.

Method Detail

getCreateHierarchy

public final boolean getCreateHierarchy()

Gets or sets a value indicating whether to create the hierarchy of parent folders.

Value: true if the hierarchy of parent folders should be created. In this case, the name of the subfolder to be created is considered as path; false if only the subfolder with specified name should be created. The default value is false.

When specifying the subfolder path, use the backslash (\) as the separator between folder names. For example, "parent1\parent2\subfolder".

setCreateHierarchy

public final void setCreateHierarchy(boolean value)

Gets or sets a value indicating whether to create the hierarchy of parent folders.

Value: true if the hierarchy of parent folders should be created. In this case, the name of the subfolder to be created is considered as path; false if only the subfolder with specified name should be created. The default value is false.

When specifying the subfolder path, use the backslash (\) as the separator between folder names. For example, "parent1\parent2\subfolder".

getAllowNameCaseDifference

public final boolean getAllowNameCaseDifference()

Gets or sets a value indicating whether to allow a difference in name casing when comparing folder names.

Value: true if a difference in name casing should be allowed when comparing folder names; otherwise, false. The default value is false.

If a folder with the same name already exists when adding a new folder and AllowNameCaseDifference(getAllowNameCaseDifference()/setAllowNameCaseDifference(boolean)) is set to true, the folder names will be treated as different even if the casing differs. In this case, no exception will be thrown, and the folder will be added. When AllowNameCaseDifference(getAllowNameCaseDifference()/setAllowNameCaseDifference(boolean)) is set to false, the comparison will be case-insensitive, and the folder creation operation will consider folders with the same name but different casing as duplicates, throwing an InvalidOperationException to indicate that a folder with the specified name already exists.

setAllowNameCaseDifference

public final void setAllowNameCaseDifference(boolean value)

Gets or sets a value indicating whether to allow a difference in name casing when comparing folder names.

Value: true if a difference in name casing should be allowed when comparing folder names; otherwise, false. The default value is false.

If a folder with the same name already exists when adding a new folder and AllowNameCaseDifference(getAllowNameCaseDifference()/setAllowNameCaseDifference(boolean)) is set to true, the folder names will be treated as different even if the casing differs. In this case, no exception will be thrown, and the folder will be added. When AllowNameCaseDifference(getAllowNameCaseDifference()/setAllowNameCaseDifference(boolean)) is set to false, the comparison will be case-insensitive, and the folder creation operation will consider folders with the same name but different casing as duplicates, throwing an InvalidOperationException to indicate that a folder with the specified name already exists.

getEnforceContainerClassMatching

public final boolean getEnforceContainerClassMatching()

Gets or sets a value indicating whether to enforce container class checking.

Value: True if container class checking should be enforced; otherwise, false. Default is false.

Specifies whether to enforce checking the container class of the folder being added against the container class of the parent folder. If set to true, an exception will be thrown if the container classes do not match.

setEnforceContainerClassMatching

public final void setEnforceContainerClassMatching(boolean value)

Gets or sets a value indicating whether to enforce container class checking.

Value: True if container class checking should be enforced; otherwise, false. Default is false.

Specifies whether to enforce checking the container class of the folder being added against the container class of the parent folder. If set to true, an exception will be thrown if the container classes do not match.

getContainerClass

public final String getContainerClass()

Gets or sets the container class for the new subfolder.

The container class represents the message class of the new subfolder. The default value is XVHK4D9KDb.get(new byte[] { (byte)0xc6, (byte)0xa8, (byte)0x74, (byte)0x5c, (byte)0xf0, (byte)0xfb, (byte)0xd7, (byte)0xb9 }).

setContainerClass

public final void setContainerClass(String value)

Gets or sets the container class for the new subfolder.

The container class represents the message class of the new subfolder. The default value is XVHK4D9KDb.get(new byte[] { (byte)0xc6, (byte)0xa8, (byte)0x74, (byte)0x5c, (byte)0xf0, (byte)0xfb, (byte)0xd7, (byte)0xb9 }).