PersonalStorage Class |
Represents Personal Storage Table (.pst) file.
Inheritance HierarchyNamespace: Aspose.Email.Storage.Pst
Assembly: Aspose.Email (in Aspose.Email.dll) Version: 22.4
SyntaxThe PersonalStorage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PersonalStorage | Initializes a new instance of the PersonalStorage class.
Allows setting a callback method for handling exceptions that occur during PST traversal. |
Properties| Name | Description | |
|---|---|---|
 | CanWrite |
Gets a value indicating whether
the current pst supports writing.
|
| Format |
Gets the file format.
|
| IsUnicode |
Gets a value indicating whether the PST file format is Unicode.
There are two versions of the PST file format: Unicode and ANSI.
|
| RootFolder |
Gets the root folder of PST.
|
| Store |
Gets the PST message store.
|
Methods| Name | Description | |
|---|---|---|
| ChangeMessage |
Changes the message properties.
|
| ConvertTo |
Converts the current object to the specified format.
|
 | Create(Stream, FileFormatVersion) |
Creates the PST in a stream.
|
| Create(String, FileFormatVersion) |
Creates the new PST file with the specified file name.
|
| Create(Stream, FileFormatVersion, Boolean) |
Creates the PST in a stream.
|
| Create(Stream, FileFormatVersion, CancellationToken) |
Creates the PST in a stream.
|
| Create(String, FileFormatVersion, CancellationToken) |
Creates the new PST file with the specified file name.
|
| Create(Stream, FileFormatVersion, Boolean, CancellationToken) |
Creates the PST in a stream.
|
| CreatePredefinedFolder(String, StandardIpmFolder) |
Creates the standard interpersonal message (IPM) folder.
|
| CreatePredefinedFolder(String, StandardIpmFolder, Boolean) |
Creates the standard interpersonal message (IPM) folder.
|
| Dispose |
Performs application-defined tasks associated with freeing,
releasing, or resetting unmanaged resources.
|
 | Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
|
| EnumerateMessages(String) |
Exposes the enumerator, which supports an iteration of messages in folder.
|
| EnumerateMessages(String, Int32, Int32) |
Exposes the enumerator, which supports an iteration of messages in folder.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExtractAttachments(String) |
Extracts the attachments.
|
| ExtractAttachments(MessageInfo) |
Extracts the attachments.
|
| ExtractMessage(Byte) |
Get the message from PST.
|
| ExtractMessage(String) |
Get the message from PST.
|
| ExtractMessage(MessageInfo) |
Get the message from PST.
|
| ExtractProperty |
Gets the specified property of item, without extract the item fully.
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindMessages |
Finds the identifiers of messages for for the current folder.
It might be useful in case of reading corrupted pst when the GetContents and EnumerateMessages methods could throw an exception.
|
| FindSubfolders |
Finds the identifiers of subfolders for for the current folder.
It might be useful in case of reading corrupted pst when the GetSubfolders and EnumerateFolders methods could throw an exception.
|
| FromFile(String) |
Load PST from file.
|
| FromFile(String, PersonalStorageLoadOptions) |
Load PST from file.
|
| FromFile(String, Boolean) |
Load PST from file.
|
| FromFile(String, CancellationToken) |
Load PST from file.
|
| FromFile(String, PersonalStorageLoadOptions, CancellationToken) |
Load PST from file.
|
| FromFile(String, Boolean, CancellationToken) | |
| FromStream(Stream) |
Load PST from stream.
|
| FromStream(Stream, PersonalStorageLoadOptions) |
Load PST from stream.
|
| FromStream(Stream, Boolean) |
Load PST from stream.
|
| FromStream(Stream, CancellationToken) |
Load PST from file.
|
| FromStream(Stream, PersonalStorageLoadOptions, CancellationToken) |
Load PST from file.
|
| FromStream(Stream, Boolean, CancellationToken) | |
| GetFolderById(Byte) |
Gets the personal folder from PST.
|
| GetFolderById(String) |
Gets the personal folder from PST.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetParentFolder(Byte) |
Gets the parent folder of message.
|
| GetParentFolder(String) |
Gets the parent folder of message.
|
| GetPredefinedFolder |
Gets the standard interpersonal message (IPM) folder from PST.
Outlook can create a number of default folders,
such as Outbox, Deleted Items, Sent Items etc.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Load(Stream) |
Load PST from stream.
This method is used when a PersonalStorage object is created using the constructor.
|
| Load(String) |
Load PST from file.
This method is used when a PersonalStorage object is created using the constructor.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MergeWith(Stream) |
Merges the pst storage with one or more other pst streams.
Thus, the combined stream are sources.
|
| MergeWith(String) |
Merges the pst storage with one or more other pst files.
Thus, the combined files are sources.
|
| MoveItem(FolderInfo, FolderInfo) |
Moves a specified folder to a new parent folder within the current pst.
|
| MoveItem(MessageInfo, FolderInfo) |
Moves a specified message to a new folder within the current pst.
|
| SaveAs(Stream, FileFormat) |
Saves the current object to a specified file format in a stream.
|
| SaveAs(String, FileFormat) |
Saves the current object to a specified file format in a different file.
|
| SaveMessageToStream |
Saves the message, with specified entryID, to a stream.
|
| SplitInto(Int64, String) |
Splits the pst storage into less sized parts.
|
| SplitInto(IListMailQuery, String) |
Splits the pst storage based on criteria.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryToGetFolderById | Gets the folder associated with the specified entry ID. |
| TryToSaveMessage |
Saves the message, with specified entryID, to a stream.
|
Events| Name | Description | |
|---|---|---|
 | ItemMoved |
Occurs when an item is moved to the another folder.
|
| StorageProcessed |
Occurs in splitting and merging operations when a new chunk of pst
is created or the next file is processed and is to be merged.
|
See Also