Aspose::Email::Storage::Pst::MessageStore Class Reference

Message store is the root of the PST, which is the rough equivalent of the top of a Mailbox. More...

Inherits Object.

Public Member Functions
System::String	get_DisplayName ()
	Gets the display Name of PST. More...
System::SharedPtr< Mapi::MapiPropertyCollection >	get_Properties () const
	Gets the MAPI properties of message store object. The message store contains the top-level PST settings and metadata that are required to access and manage the PST contents. More...
bool	get_IsPasswordProtected ()
	Gets a value indicating whether the storage is password protected. More...
System::ArrayPtr< uint8_t >	get_RecordKey ()
	Gets the record Key. This is the Provider UID of this PST. More...
System::ArrayPtr< uint8_t >	get_RootMailBoxEntryId ()
	Gets the EntryID of the Root Mailbox Folder object. More...
System::ArrayPtr< uint8_t >	get_DeletedItemFolderEntryId ()
	Gets the EntryID of the Deleted Items Folder object. More...
	MessageStore (System::SharedPtr< PstDoer > doer)
	Initializes a new instance of the MessageStore class. More...
int32_t	GetTotalItemsCount ()
	Gets the total items count. Returns the total number of message items contained in the PST. More...
bool	IsPasswordValid (System::String password)
	Determines whether the specified string is a valid password for the storage. More...
void	ChangeDisplayName (System::String newName)
	Changes the pst display name. More...
void	ChangePassword (System::String password)
	Sets the password. More...
void	SetProperty (System::SharedPtr< Mapi::MapiProperty > property)
	Sets the property. More...

Detailed Description

Message store is the root of the PST, which is the rough equivalent of the top of a Mailbox.

Constructor & Destructor Documentation

MessageStore()

Aspose::Email::Storage::Pst::MessageStore::MessageStore

(

System::SharedPtr< PstDoer >

doer

)

Initializes a new instance of the MessageStore class.

Parameters

doer

The doer.

Member Function Documentation

ChangeDisplayName()

void Aspose::Email::Storage::Pst::MessageStore::ChangeDisplayName

(

System::String

newName

)

Changes the pst display name.

Parameters

newName

The new display name of message store.

Exceptions

ArgumentNullException	Thrown when the display name of the message store is provided as null or empty.
NotImplementedException	Thrown when attempting to edit the ANSI file version.

ChangePassword()

void Aspose::Email::Storage::Pst::MessageStore::ChangePassword

(

System::String

password

)

Sets the password.

Parameters

password

The string that represents the password.

Exceptions

NotImplementedException

Thrown when attempting to edit the ANSI file version.

get_DeletedItemFolderEntryId()

System::ArrayPtr<uint8_t> Aspose::Email::Storage::Pst::MessageStore::get_DeletedItemFolderEntryId

(

)

Gets the EntryID of the Deleted Items Folder object.

get_DisplayName()

System::String Aspose::Email::Storage::Pst::MessageStore::get_DisplayName

(

)

Gets the display Name of PST.

The string that represents display name.

get_IsPasswordProtected()

bool Aspose::Email::Storage::Pst::MessageStore::get_IsPasswordProtected

(

)

Gets a value indicating whether the storage is password protected.

true if the storage is password protected; otherwise, false.

get_Properties()

System::SharedPtr<Mapi::MapiPropertyCollection> Aspose::Email::Storage::Pst::MessageStore::get_Properties

(

)

const

Gets the MAPI properties of message store object. The message store contains the top-level PST settings and metadata that are required to access and manage the PST contents.

The MapiProperty collection.

get_RecordKey()

System::ArrayPtr<uint8_t> Aspose::Email::Storage::Pst::MessageStore::get_RecordKey

(

)

Gets the record Key. This is the Provider UID of this PST.

get_RootMailBoxEntryId()

System::ArrayPtr<uint8_t> Aspose::Email::Storage::Pst::MessageStore::get_RootMailBoxEntryId

(

)

Gets the EntryID of the Root Mailbox Folder object.

GetTotalItemsCount()

int32_t Aspose::Email::Storage::Pst::MessageStore::GetTotalItemsCount

(

)

Gets the total items count. Returns the total number of message items contained in the PST.

Returns

Total message items count.

IsPasswordValid()

bool Aspose::Email::Storage::Pst::MessageStore::IsPasswordValid

(

System::String

password

)

Determines whether the specified string is a valid password for the storage.

Parameters

password

The password string.

SetProperty()

void Aspose::Email::Storage::Pst::MessageStore::SetProperty

(

System::SharedPtr< Mapi::MapiProperty >

property

)

Sets the property.

Parameters

property

The property.

Exceptions

NotImplementedException

Thrown when attempting to edit the ANSI file version.