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

Commit

Permalink
chore: Added acknowledgements
Browse files Browse the repository at this point in the history
  • Loading branch information
dikayx committed Aug 12, 2024
1 parent 423bba9 commit 605ef25
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

0 comments on commit 605ef25

Please sign in to comment.