mbox-to-json 1.0.3

MBOX to JSON Converter

^{Prakhar Sharma -
Adrita Bhattacharya -}

MBOX to JSON

A command line tool to convert MBOX file to JSON.
Explore the docs » (Currently NA)

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact

About The Project

A small package that converts MBOX files to JSON. Also includes functionality to extract attachments.

(back to top)

Built With

• Python

(back to top)

Getting Started

To run this tool on your system locally, follow the installation steps.

Prerequisites

Make sure you upgrade pip before moving on. All the required dependencies are in requirements.txt which would be installed at the time of running the setup.

pip install --upgrade pip

Installation

1. Download the repository as zip. Unzip.

2. cd to the repository folder

3. Run this command

   pip install .
   

(back to top)

Usage

mbox-to-json -h

Usage example#1

mbox-to-json /Users/prakhar/downloads/random_file.mbox

---> Use -a flag to extract attachments. The files would be available in an attachments folder in the root location of the repo.

Usage example#2

mbox-to-json /Users/prakhar/downloads/random_file.mbox -a

---> Use -o to specify the output file location. It defaults to file.json in the root location of the repo.

Usage example#3

mbox-to-json /Users/prakhar/downloads/random_file.mbox -o /Users/prakhar/downloads/random_output.json

For more examples, please refer to the Documentation

(back to top)

Roadmap

• TBA

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

LinkedIn - Prakhar Sharma, Adrita Bhattacharya

Github: PS1607, adritabhattacharya

Google Developer: PS1607

(back to top)