PersonalStorage Class

Represents Personal Storage Table (.pst) file.
Inheritance Hierarchy
SystemObject
  Aspose.Email.Storage.PstPersonalStorage

Namespace:  Aspose.Email.Storage.Pst
Assembly:  Aspose.Email (in Aspose.Email.dll) Version: 22.4
Syntax
public class PersonalStorage : IDisposable

The PersonalStorage type exposes the following members.

Constructors
  NameDescription
Public methodPersonalStorage
Initializes a new instance of the PersonalStorage class. Allows setting a callback method for handling exceptions that occur during PST traversal.
Properties
  NameDescription
Public propertyCanWrite
Gets a value indicating whether the current pst supports writing.
Public propertyFormat
Gets the file format.
Public propertyIsUnicode
Gets a value indicating whether the PST file format is Unicode. There are two versions of the PST file format: Unicode and ANSI.
Public propertyRootFolder
Gets the root folder of PST.
Public propertyStore
Gets the PST message store.
Methods
  NameDescription
Public methodChangeMessage
Changes the message properties.
Public methodConvertTo
Converts the current object to the specified format.
Public methodStatic memberCreate(Stream, FileFormatVersion)
Creates the PST in a stream.
Public methodStatic memberCreate(String, FileFormatVersion)
Creates the new PST file with the specified file name.
Public methodStatic memberCreate(Stream, FileFormatVersion, Boolean)
Creates the PST in a stream.
Public methodStatic memberCreate(Stream, FileFormatVersion, CancellationToken)
Creates the PST in a stream.
Public methodStatic memberCreate(String, FileFormatVersion, CancellationToken)
Creates the new PST file with the specified file name.
Public methodStatic memberCreate(Stream, FileFormatVersion, Boolean, CancellationToken)
Creates the PST in a stream.
Public methodCreatePredefinedFolder(String, StandardIpmFolder)
Creates the standard interpersonal message (IPM) folder.
Public methodCreatePredefinedFolder(String, StandardIpmFolder, Boolean)
Creates the standard interpersonal message (IPM) folder.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Public methodEnumerateMessages(String)
Exposes the enumerator, which supports an iteration of messages in folder.
Public methodEnumerateMessages(String, Int32, Int32)
Exposes the enumerator, which supports an iteration of messages in folder.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExtractAttachments(String)
Extracts the attachments.
Public methodExtractAttachments(MessageInfo)
Extracts the attachments.
Public methodExtractMessage(Byte)
Get the message from PST.
Public methodExtractMessage(String)
Get the message from PST.
Public methodExtractMessage(MessageInfo)
Get the message from PST.
Public methodExtractProperty
Gets the specified property of item, without extract the item fully.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindMessages
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.
Public methodFindSubfolders
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.
Public methodStatic memberFromFile(String)
Load PST from file.
Public methodStatic memberFromFile(String, PersonalStorageLoadOptions)
Load PST from file.
Public methodStatic memberFromFile(String, Boolean)
Load PST from file.
Public methodStatic memberFromFile(String, CancellationToken)
Load PST from file.
Public methodStatic memberFromFile(String, PersonalStorageLoadOptions, CancellationToken)
Load PST from file.
Public methodStatic memberFromFile(String, Boolean, CancellationToken)
Public methodStatic memberFromStream(Stream)
Load PST from stream.
Public methodStatic memberFromStream(Stream, PersonalStorageLoadOptions)
Load PST from stream.
Public methodStatic memberFromStream(Stream, Boolean)
Load PST from stream.
Public methodStatic memberFromStream(Stream, CancellationToken)
Load PST from file.
Public methodStatic memberFromStream(Stream, PersonalStorageLoadOptions, CancellationToken)
Load PST from file.
Public methodStatic memberFromStream(Stream, Boolean, CancellationToken)
Public methodGetFolderById(Byte)
Gets the personal folder from PST.
Public methodGetFolderById(String)
Gets the personal folder from PST.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetParentFolder(Byte)
Gets the parent folder of message.
Public methodGetParentFolder(String)
Gets the parent folder of message.
Public methodGetPredefinedFolder
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.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoad(Stream)
Load PST from stream. This method is used when a PersonalStorage object is created using the constructor.
Public methodLoad(String)
Load PST from file. This method is used when a PersonalStorage object is created using the constructor.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMergeWith(Stream)
Merges the pst storage with one or more other pst streams. Thus, the combined stream are sources.
Public methodMergeWith(String)
Merges the pst storage with one or more other pst files. Thus, the combined files are sources.
Public methodMoveItem(FolderInfo, FolderInfo)
Moves a specified folder to a new parent folder within the current pst.
Public methodMoveItem(MessageInfo, FolderInfo)
Moves a specified message to a new folder within the current pst.
Public methodSaveAs(Stream, FileFormat)
Saves the current object to a specified file format in a stream.
Public methodSaveAs(String, FileFormat)
Saves the current object to a specified file format in a different file.
Public methodSaveMessageToStream
Saves the message, with specified entryID, to a stream.
Public methodSplitInto(Int64, String)
Splits the pst storage into less sized parts.
Public methodSplitInto(IListMailQuery, String)
Splits the pst storage based on criteria.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryToGetFolderById
Gets the folder associated with the specified entry ID.
Public methodTryToSaveMessage
Saves the message, with specified entryID, to a stream.
Events
  NameDescription
Public eventItemMoved
Occurs when an item is moved to the another folder.
Public eventStorageProcessed
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