Effortless Email Automation with Intelligent Precision
Developed with the software and tools below.
Table of Contents
The v-gpt-email-api is a sophisticated email management system designed to enhance productivity by integrating GPT-powered functionalities. It facilitates intelligent email handling, including drafting responses, sorting, and automating common tasks based on user preferences and historical data. Built with FastAPI and containerized through Docker, the API ensures secure and compliant email transmission, with robust validation and error-handling mechanisms. Its primary value lies in streamlining user workflows and personalizing email interactions, making it a valuable tool for efficient and intelligent email management in modern work environments.
| Feature | Description | |
|---|---|---|
| ⚙️ | Architecture | The project follows a microservices architecture, utilizing FastAPI with Uvicorn for handling asynchronous API requests, optimized using Docker to ensure isolated environments. This setup supports modular component integration. |
| 🔩 | Code Quality | The code adheres to modern Python standards with strong type annotations, consistent naming conventions, and comprehensive function documentation, ensuring readability and maintainability. |
| 📄 | Documentation | Comprehensive documentation including a README file, inline comments, and docstrings. Key project files like requirements.txt, Dockerfile, and docker-compose.yml are well-documented to assist in deployment and integration. |
| 🔌 | Integrations | Integrates key libraries such as FastAPI, Uvicorn, Pydantic for data validation, aiosmtplib for email, and aiohttp for HTTP requests. Environment variables managed using python-dotenv. Docker integration for containerization. |
| 🧩 | Modularity | The codebase is highly modular with separate files for dependencies, models, and routes, facilitating reusability and easy maintenance. Logical separation of concerns across the application layers. |
| ⚡️ | Performance | High efficiency and performance due to asynchronous programming with FastAPI and Uvicorn. Docker ensures optimized resource usage by providing isolated environments. |
| 🛡️ | Security | Uses environment variables for sensitive configurations, API key validation for access control, and enforces file size and type constraints. Prioritizes secure email transmission and data protection. |
| 📦 | Dependencies | Key dependencies include aiohttp, pydantic, uvicorn, fastapi, aiosmtplib, python-dotenv, and aiofiles. Managed using requirements.txt for easy installation and updates. |
| 🚀 | Scalability | Designed for scalability with Docker and FastAPI. Can handle increased load efficiently due to asynchronous request handling and container orchestration capabilities provided by Docker Compose. |
---
## 🗂️ Repository Structure
```sh
└── v-gpt-email-api/
├── Dockerfile
├── LICENSE
├── README.md
├── app
│ ├── __init__.py
│ ├── dependencies.py
│ ├── main.py
│ ├── models.py
│ ├── public
│ └── routes
├── docker-compose.yml
├── images
│ └── header.png
└── requirements.txt
.
| File | Summary |
|---|---|
| requirements.txt | Requirements.txt specifies the necessary dependencies for the application, including FastAPI for web framework, Uvicorn for ASGI server, Pydantic for data validation, aiosmtplib for SMTP client, aiohttp for asynchronous HTTP requests, aiofiles for file operations, and python-dotenv for environment variable management. |
| docker-compose.yml | Configure the applications deployment environment, defining service parameters, environmental variables, and network settings. Enables containerized operation of the v-gpt-email-api, ensuring seamless integration and communication with email servers and APIs for the intended functionalities within the broader repository architecture. |
| Dockerfile | Facilitates the deployment of the v-gpt-email-api repository by defining a multi-stage Docker build, installing dependencies, setting environment variables, and configuring the FastAPI application to run with Uvicorn. This ensures an optimized and isolated environment for running the API service efficiently. |
app
| File | Summary |
|---|---|
| main.py | Main.py initializes the FastAPI application instance for the Email Management API, setting the application’s metadata and configuration. It integrates the email sending feature by including the appropriate router, enabling the API to handle email-sending requests within the repository’s architecture. |
| dependencies.py | Facilitates email dispatching with file attachments, integrates API key validation, and fetches remote files. Utilizes environment variables for SMTP configuration, manages email signatures, and enforces file size and type constraints to ensure compliant and secure email transmission as part of the broader email API system. |
| models.py | Define the structure for email-related data within the API, ensuring standardized validation and descriptive metadata for each email attribute. This facilitates consistent data handling and error checking across email functionalities in the repositorys broader email service architecture. |
app.routes
| File | Summary |
|---|---|
| send_email.py | Defines an API endpoint for sending emails, integrating request validation and error handling. Utilizes dependency injection for API key management and email sending functionality. Enhances the parent repositorys capability by providing a robust mechanism for email dispatch within the application. |
System Requirements:
- Python:
version 3.10
-
Download the
docker-compose.ymlfile:
Save the provideddocker-compose.ymlfile to your project directory. -
Edit Environment Variables:
Open thedocker-compose.ymlfile and set the environment variables according to your setup:environment: BASE_URL: https://api.servicesbyv.com # Set this to your actual base URL ROOT_PATH: /email API_KEY: Optional API key to connect to api WORKERS: 1 #uvicorn workers 1 should be enough for personal use UVICORN_CONCURRENCY: 32 #this controls the mac connections. Anything over the API_concurrancy value is put in query pool. Anything over this number is rejected. ACCOUNT_EMAIL: [email protected] ACCOUNT_PASSWORD: password1 ACCOUNT_IMAP_SERVER: imap.example.com ACCOUNT_IMAP_PORT: 993 ACCOUNT_SMTP_SERVER: smtp.example.com ACCOUNT_SMTP_PORT: 587 ACCOUNT_REPLY_TO: [email protected]
-
Run the Docker Compose:
Use the following command to start the service:docker-compose up
-
(Optional) Run in Detached Mode:
To run the containers in the background, use:docker-compose up -d
-
Access the OpenAPI Specifications:
To get the OpenAPI specifications and integrate with your AI tool, navigate to:BASE_URL/openapi.jsonReplace
BASE_URLwith the actual URL of your application (e.g.,https://api.servicesbyv.com/email/openapi.json).
►►►
This project is protected under the MIT Licence