com.aspose.email

Class TgzReader

java.lang.Object

com.aspose.email.TgzReader

All Implemented Interfaces:

IDisposable, Closeable, AutoCloseable

public class TgzReader
extends Object
implements IDisposable, Closeable

The mailbox items reader of Zimbra tgz storage.

See Also:

IDisposable

Constructor Summary

Constructors

Constructor and Description
TgzReader(Stream stream) Initializes a new instance of the TgzReader class.
TgzReader(String fileName) Initializes a new instance of the TgzReader class.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
void	exportTo(String path) Save messages and directory structure using given path.
String	getCurrentDirectory() Gets the current directory name.
MailMessage	getCurrentMessage() Gets the current message.
int	getTotalItemsCount() Gets the total count of items.
boolean	readNextMessage() Reads the next message.

Methods inherited from class java.lang.Object

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

Constructor Detail

TgzReader

public TgzReader(String fileName)

Initializes a new instance of the TgzReader class.

Parameters:

fileName - The filename.

Throws:

ArgumentNullException - throws if file name is null or empty

TgzReader

public TgzReader(Stream stream)

Initializes a new instance of the TgzReader class.

Parameters:

stream - The stream.

Throws:

ArgumentNullException - throws if stream is null

Method Detail

getCurrentDirectory

public final String getCurrentDirectory()

Gets the current directory name.

Value: The name of directory.

getCurrentMessage

public final MailMessage getCurrentMessage()

Gets the current message.

Value: The MailMessage.

exportTo

public final void exportTo(String path)

Save messages and directory structure using given path.

Parameters:

path - The main directory path to save storage structure.

Throws:

ArgumentNullException - throws if file name is null or empty

getTotalItemsCount

public final int getTotalItemsCount()

Gets the total count of items.

Returns:

An integer representing the total count of items.

readNextMessage

public final boolean readNextMessage()

Reads the next message.

Returns:

dispose

public final void dispose()

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

Specified by:

dispose in interface IDisposable

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable