Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/teverett/olmreader

A Java reader for MS Outlook for Mac OLM files
https://github.com/teverett/olmreader

email java ms-outlook olm outlook

Last synced: 2 months ago
JSON representation

A Java reader for MS Outlook for Mac OLM files

Awesome Lists containing this project

README

        

![CI](https://github.com/teverett/OLMReader/workflows/CI/badge.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7c1ef374e6fb42408e915a849c498798)](https://www.codacy.com/app/teverett/OLMReader?utm_source=github.com&utm_medium=referral&utm_content=teverett/OLMReader&utm_campaign=Badge_Grade)
[![DepShield Badge](https://depshield.sonatype.org/badges/teverett/OLMReader/depshield.svg)](https://depshield.github.io)

# OLMReader

A Java library for reading MS Outlook for Mac [OLM](https://support.office.com/en-us/article/Export-or-manually-archive-Outlook-items-281a62bf-cc42-46b1-9ad5-6bda80ca3106) archives

## Supported objects

* Email
* Contacts
* Contact Groups
* Appointments
* Categories
* Notes
* Tasks

## Schema

Schemas for OLM XML can be found [here](https://github.com/teverett/OLMReader/blob/master/src/main/resources/schema/)

# Maven Coordinates

```
com.khubla.olmreader
olmreader
1.9.0
jar
```

# Using OLMReader

To use OLMReader, provide a class which implements [OLMMessageCallback](https://github.com/teverett/OLMReader/blob/master/src/main/java/com/khubla/olmreader/olm/OLMMessageCallback.java), [OLMRawMessageCallback](https://github.com/teverett/OLMReader/blob/master/src/main/java/com/khubla/olmreader/olm/OLMRawMessageCallback.java) and pass those implementations to [OLMReader](https://github.com/teverett/OLMReader/blob/master/src/main/java/com/khubla/olmreader/olm/OLMFile.java).readOLMFile.

# Installation / Operation

To run this application you must first have the [Java Platform (JDK) 12](https://www.oracle.com/technetwork/java/javase/downloads/jdk12-downloads-5295953.html) and [Apache Maven](https://maven.apache.org/).

Ensure you set your `JAVA_HOME` as well as adding Maven to your `PATH`. [Instructions](https://maven.apache.org/install.html)

After that is done make sure to flag the `.sh` files as executable

```
chmod +x run_example.sh
```

and then execute using `./run_example.sh`

# Troubleshooting

If you have issues with the build, try running `mvn clean install` in the git root directory for this application.