Aspose::Email::Storage::Zimbra::TgzReader Class Reference

The mailbox items reader of Zimbra tgz storage. More...

Inherits IDisposable.

Public Member Functions

System::String get_CurrentDirectory () const
 Gets the current directory name. More...
 
System::SharedPtr< MailMessageget_CurrentMessage () const
 Gets the current message. More...
 
 TgzReader (System::String fileName)
 Initializes a new instance of the TgzReader class. More...
 
 TgzReader (System::SharedPtr< System::IO::Stream > stream)
 Initializes a new instance of the TgzReader class. More...
 
void ExportTo (System::String path)
 Save messages and directory structure using given path. More...
 
int32_t GetTotalItemsCount ()
 Gets the total count of items. More...
 
bool ReadNextMessage ()
 Reads the next message. More...
 
void Dispose () override
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Detailed Description

The mailbox items reader of Zimbra tgz storage.

See also
System::IDisposable

Constructor & Destructor Documentation

◆ TgzReader() [1/2]

Aspose::Email::Storage::Zimbra::TgzReader::TgzReader ( System::String  fileName)

Initializes a new instance of the TgzReader class.

Parameters
fileNameThe filename.
Exceptions
ArgumentNullExceptionthrows if file name is null or empty

◆ TgzReader() [2/2]

Aspose::Email::Storage::Zimbra::TgzReader::TgzReader ( System::SharedPtr< System::IO::Stream >  stream)

Initializes a new instance of the TgzReader class.

Parameters
streamThe stream.
Exceptions
ArgumentNullExceptionthrows if stream is null

Member Function Documentation

◆ Dispose()

void Aspose::Email::Storage::Zimbra::TgzReader::Dispose ( )
override

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ ExportTo()

void Aspose::Email::Storage::Zimbra::TgzReader::ExportTo ( System::String  path)

Save messages and directory structure using given path.

Parameters
pathThe main directory path to save storage structure.
Exceptions
ArgumentNullExceptionthrows if file name is null or empty

◆ get_CurrentDirectory()

System::String Aspose::Email::Storage::Zimbra::TgzReader::get_CurrentDirectory ( ) const

Gets the current directory name.

The name of directory.

◆ get_CurrentMessage()

System::SharedPtr<MailMessage> Aspose::Email::Storage::Zimbra::TgzReader::get_CurrentMessage ( ) const

Gets the current message.

The MailMessage.

◆ GetTotalItemsCount()

int32_t Aspose::Email::Storage::Zimbra::TgzReader::GetTotalItemsCount ( )

Gets the total count of items.

Returns
An integer representing the total count of items.

◆ ReadNextMessage()

bool Aspose::Email::Storage::Zimbra::TgzReader::ReadNextMessage ( )

Reads the next message.

Returns