Process EML and MSG file types and extract various Indicators of Compromise.

---

Table of Contents

• 📝 Pre-requisites
  • 📦 Installing Required Packages
• 🖥️ Usage
• 🧰 Development
  • 🏢 Virtual environment

---

📝 Pre-requisites

• clone this project with the following command

$ git clone https://github.com/martinkubecka/mailo.git

📦 Installing Required Packages

$ pip install -r requirements.txt

• mail-parser package requires Email::Outlook::Message Perl module for reading Outlook MSG files without need to install Outlook itself
• you can install this Perl module with libemail-outlook-message-perl package on Debian based systems with the following command

$ sudo apt-get install libemail-outlook-message-perl

• for other systems see INSTALLATION section in the email-outlook-message-perl repository

---

🖥️ Usage

usage: mailo.py [-h] [-q] (-i FILENAME | -b PATH)

Process EML and MSG file types and extract various Indicators of Compromise.

options:
  -h, --help                     show this help message and exit
  -q, --quiet                    do not print banner
  -i FILENAME, --input FILENAME  input file (MSG/EML file types supported)
  -b PATH, --bulk-input PATH     input folder (MSG/EML file types supported)

---

🧰 Development

🏢 Virtual environment

1. use your package manager to install python-pip if it is not present on your system
2. install virtualenv
3. verify installation by checking the virtualenv version
4. inside the project directory create a virtual environment called venv
5. activate it by using the source command
6. you can deactivate the virtual environment from the parent folder of venv directory with the deactivate command

$ sudo apt-get install python-pip
$ pip install virtualenv
$ virtualenv --version
$ virtualenv --python=python3 venv
$ source venv/bin/activate
$ deactivate

---

[ Table of Contents ]