Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.
/ mapy Public archive

Email analysis and visualization tool.

License

Notifications You must be signed in to change notification settings

dikayx/mapy

Repository files navigation

MAPy

Python3 License Build Status

MAPy is a small utility tool for Mail Analysis in Python inspired by CyberDefenders' Email-Header-Analyzer. It is designed to help you parse email data and extract useful information from it.

Screenshot of the app

Features

  • 📧 Get an overview of basic mail data (like subject, recipient, etc.)
  • 🕒 Visualize the delays between different steps
  • 📌 Identify the mail servers involved
  • 📅 Extract date and time information
  • 📬 Identify the source of the mail
  • 🌍 Display the path the mail took
  • 📝 Extract the messages
  • 📦 Download attachments
  • 📄 Generate a PDF report

Get started

Download the latest release from the releases page and use the setup.sh (Mac & Linux) or setup.bat (Windows) script to set up the app via Docker or locally. For more detailed instructions, see the installation guide.

If you are already familiar with Git, you can use the commands below to clone the repository and run the setup script.

Quickstart

To get the app up and running on Mac or Linux, run:

git clone https://github.com/dikayx/mapy.git && cd mapy && chmod +x setup.sh && ./setup.sh

On Windows, open a command prompt (cmd) and run:

git clone https://github.com/dikayx/mapy.git && cd mapy && setup.bat

Follow the instructions in the terminal to start the app. By default, it will be available at http://localhost:8080. If you want to use SSL, see the Securing the app with SSL section in the installation guide.

Usage

It's simple! Just copy the email data you want to analyze and paste it into the input field and click the "Analyze" button. The app will then display the results in a structured way.

To learn more about the app, how to use it and how to obtain the email data you want to analyze, see the user guide.

Acknowledgements

I would like to thank the CyberDefenders team for their exceptional work which served as both an inspiration and a foundation for this project. Certain parts of the code are directly or indirectly derived from their work. I hope that this project can continue to build on the great work they've done and provide similar value to others.

License

This project is licensed under the MIT License with special permission from the author of the original MHA project, which is licensed under the GPLv3. I deeply appreciate the author’s generosity in allowing this flexibility, enabling me to use the MIT License for this project. See the LICENSE file for details.