Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohammadrezaamani/mailtracker
powerful Python FastAPI mail and content tracker
https://github.com/mohammadrezaamani/mailtracker
fastapi inui mailtrack python view
Last synced: 29 days ago
JSON representation
powerful Python FastAPI mail and content tracker
- Host: GitHub
- URL: https://github.com/mohammadrezaamani/mailtracker
- Owner: MohammadrezaAmani
- License: mit
- Created: 2023-10-06T18:39:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-07T00:22:03.000Z (over 1 year ago)
- Last Synced: 2024-11-13T22:23:00.641Z (3 months ago)
- Topics: fastapi, inui, mailtrack, python, view
- Language: Python
- Homepage:
- Size: 328 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 💌 FastAPI Mail Tracker
## Introduction
Python Mail Tracker is a powerful tool for tracking emails and website views, providing detailed information such as IP addresses, locations, headers, devices, browsers, timestamps, and more. This FastAPI-based application is designed to help you monitor and analyze user interactions with your emails or website, giving you valuable insights into user behavior.
## Features
- Track emails and website views with ease.
- Collect comprehensive information about each interaction.
- Analyze user data to improve your communication and website content.
- FastAPI backend for high-performance tracking.
- Easy-to-use API for integrating tracking into your applications.
## Table of Contents
- [💌 Python Mail Tracker](#-python-mail-tracker)
- [Introduction](#introduction)
- [Features](#features)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
## Installation
To get started with Python Mail Tracker, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/MohammadrezaAmani/MailTracker.git
cd MailTracker
```
1- Install the required dependencies:
```bash
pip install -r requirements.txt
```
1. Configure your settings (see Configuration below).
2. Run the FastAPI application:
```bash
uvicorn main:app --host 0.0.0.0 --port 8000 --reload
```
### Usage
Once you have the application up and running, you can start tracking emails or website views by making API requests. Here's a basic example of how to track an email:
```python
import requests
# Replace with your server's address
base_url = 'http://localhost:8000'
# Track an email
response = requests.post(f'{base_url}/track/email', json={
'recipient_email': '[email protected]',
'email_subject': 'Important News',
'email_content': 'Check out our latest newsletter!',
})
print(response.json())
```
For more advanced usage and API endpoints, please refer to the API Documentation section below.
### API Documentation
For detailed information on available API endpoints and how to use them, please check the API Documentation.
### Configuration
To customize the behavior of Python Mail Tracker, you can edit the config.py file. Here, you can configure database settings, logging, and other application-specific options.
### Contributing
We welcome contributions to make Python Mail Tracker even better! If you'd like to contribute, please follow our Contribution Guidelines.
### License
This project is licensed under the MIT License - see the LICENSE file for details.