From 605ef252443cd4d5c93727ced45bf35dbc685779 Mon Sep 17 00:00:00 2001 From: Dan Koller <57103678+dan-koller@users.noreply.github.com> Date: Mon, 12 Aug 2024 08:25:05 +0200 Subject: [PATCH] chore: Added acknowledgements --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f8359ba..32e8826 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,20 @@ [![Python3](https://img.shields.io/badge/Python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/) [![Build Status](https://github.com/dan-koller/mapy/actions/workflows/python-app.yml/badge.svg)](https://github.com/dan-koller/mapy/actions/workflows/python-app.yml) -MAPy is a small utility tool for **M**ail **A**nalysis in **Py**thon. It is designed to help you parse email data and extract useful information from it. +MAPy is a small utility tool for **M**ail **A**nalysis in **Py**thon inspired by CyberDefenders' [Email-Header-Analyzer](https://github.com/cyberdefenders/email-header-analyzer). It is designed to help you parse email data and extract useful information from it. ![Screenshot of the app](assets/screenshot.png) ## 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 content of the mail -- 📦 Get the attachments of the mail -- 🕒 Visualize the delays between different steps +- 📝 Extract the messages +- 📦 Download attachments ## Get started @@ -44,3 +45,11 @@ Follow the instructions in the terminal to start the app. By default, it will be 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](docs/USER_GUIDE.md). + +## Acknowledgements + +I would like to thank the [CyberDefenders](https://github.com/cyberdefenders) team for their great work and for providing the inspiration for this project. They have created a fantastic tool and I hope that this project can help others in the same way their tool has helped me. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.