com.aspose.email

Class OlmStorage

java.lang.Object

com.aspose.email.OlmStorage

All Implemented Interfaces:

IDisposable, Closeable, AutoCloseable

public class OlmStorage
extends Object
implements IDisposable, Closeable

Represents an Outlook for Mac (.OLM) storage file and provides functionality to access and manipulate the data within the file such as emails, contacts, calendars, tasks, and notes.

The OlmStorage class allows users to read from and interact with the contents of .OLM files typically used by Microsoft Outlook for Mac. This class handles the various data types stored within an .OLM file by providing methods to enumerate and extract information.

Example:

 try (OlmStorage olm = OlmStorage.fromFile("storage.olm")) {
     // Retrieve the total number of items in the OLM storage.
     int totalItemsCount = olm.getTotalItemsCount();
     System.out.println("Total items count: " + totalItemsCount);

     // Iterate through each folder in the OLM storage.
     for (OlmFolder olmFolder : olm.getFolders()) {
         // Print the name of the currently iterated folder and the count of messages it contains.
         System.out.println("Folder: " + olmFolder.getName());
         System.out.println("Total items: " + olmFolder.getMessageCount());

         // Iterate through each message in the current folder.
         for (OlmMessageInfo messageInfo : olmFolder.enumerateMessages()) {
             // Print the subject of the current message to the console.
             System.out.println("Subject: " + messageInfo.getSubject());

             // Extract the full message object from the OLM storage.
             MapiMessage msg = olm.extractMapiMessage(messageInfo);

             // Save the extracted message as a .msg file.
             msg.save(msg.getSubject() + ".msg");
         }
     }
 } catch (Exception e) {
     e.printStackTrace();
 }
 
 

Constructor Summary

Constructors

Constructor and Description
OlmStorage(InputStream stream) Initializes a new instance of the OlmStorage class.
OlmStorage(String fileName) Initializes a new instance of the OlmStorage class.
OlmStorage(TraversalExceptionsCallback callback) Initializes a new instance of the OlmStorage 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.
protected void	dispose(boolean disposing) Releases unmanaged and - optionally - managed resources.
IGenericEnumerable<MapiMessage>	enumerateMessages(OlmFolder folder) Exposes the enumerator, which supports an iteration of messages in folder.
MapiMessage	extractMapiMessage(OlmMessageInfo messageInfo) Get the message from OLM storage.
MapiMessage	extractMapiMessage(String id) Get the message from OLM.
static OlmStorage	fromFile(String fileName) Load OLM storage from file.
static OlmStorage	fromStream(InputStream stream) Load OLM from stream.
List<OlmItemCategory>	getCategories() Gets the supported item categories.
OlmFolder	getFolder(String name, boolean ignoreCase) Gets the folder by name.
List<OlmFolder>	getFolderHierarchy() Gets the folder hierarchy.
List<OlmFolder>	getFolders() Gets collection of folders.
int	getTotalItemsCount() Gets the total items count.
boolean	load(InputStream stream) Load OLM storage from stream.
boolean	load(String fileName) Load OLM storage from file.

Methods inherited from class java.lang.Object

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

Constructor Detail

OlmStorage

public OlmStorage(TraversalExceptionsCallback callback)

Initializes a new instance of the OlmStorage class. Allows setting a callback method for handling exceptions that occur during OLM storage traversal.

Parameters:

callback - The exception callback.

OlmStorage

public OlmStorage(String fileName)

Initializes a new instance of the OlmStorage class.

Parameters:

fileName - OLM file name.

Throws:

ArgumentNullException - throws if file name is null or empty

OlmStorage

public OlmStorage(InputStream stream)

Initializes a new instance of the OlmStorage class.

Parameters:

stream - Source stream InputStream with OLM storage data.

Throws:

ArgumentNullException - throws if stream is null

Method Detail

getFolderHierarchy

public final List<OlmFolder> getFolderHierarchy()

Gets the folder hierarchy.

Value: The folder hierarchy.

load

public final boolean load(InputStream stream)

Load OLM storage from stream. This method is used when a OlmStorage object is created using constructor with the TraversalExceptionsCallback parameter.

Parameters:

stream - The stream.

Returns:

'true' if the file has been loaded successfully and further traversal is possible; otherwise, false.

load

public final boolean load(String fileName)

Load OLM storage from file. This method is used when a OlmStorage object is created using constructor with the TraversalExceptionsCallback parameter.

Parameters:

fileName - The file name.

Returns:

'true' if the file has been loaded successfully and further traversal is possible; otherwise, false.

fromFile

public static OlmStorage fromFile(String fileName)

Load OLM storage from file.

Parameters:

fileName - Name of .olm file.

Returns:

An OlmStorage object that represents the current OLM file.

fromStream

public static OlmStorage fromStream(InputStream stream)

Load OLM from stream.

Parameters:

stream - The System.IO.Stream.

Returns:

An OlmStorage object that represents the current OLM storage.

getFolders

public final List<OlmFolder> getFolders()

Gets collection of folders.

Returns:

The collection of folders that belong to the storage, i.e. the sub-folders of the current OLMStorage object.

getFolder

public final OlmFolder getFolder(String name,
                  boolean ignoreCase)

Gets the folder by name.

Parameters:

name - Name of folder.

ignoreCase - A value that indicates whether the name to match is case insensitive.

Returns:

An OlmFolder object.

getCategories

public final List<OlmItemCategory> getCategories()

Gets the supported item categories.

Returns:

A list of OlmItemCategory objects.

extractMapiMessage

public final MapiMessage extractMapiMessage(String id)

Get the message from OLM.

Parameters:

id - String representation of EntryId.

Returns:

A MapiMessage object.

extractMapiMessage

public final MapiMessage extractMapiMessage(OlmMessageInfo messageInfo)

Get the message from OLM storage.

Parameters:

messageInfo - An OlmMessageInfo object that represents information about message.

Returns:

A MapiMessage object.

getTotalItemsCount

public final int getTotalItemsCount()

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

Returns:

Total message items count.

enumerateMessages

public final IGenericEnumerable<MapiMessage> enumerateMessages(OlmFolder folder)

Exposes the enumerator, which supports an iteration of messages in folder.

Parameters:

folder - OlmFolder that represents information about folder in OLM storage.

Returns:

System.Collections.Generic.IEnumerableltTgt, that represents an enumerator that iterates through a messages in folder.

Throws:

ArgumentNullException - throws if folder is null

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

dispose

protected void dispose(boolean disposing)

Releases unmanaged and - optionally - managed resources.

Parameters:

disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.