Email Classification API

Setup

1. Install Python 3.8 or newer
   https://www.python.org/downloads/
2. Clone the repository:
   bash

   1git clone https://github.com/yourusername/email-classification.git 2cd email-classification
3. Install dependencies:
   bash

   1pip install -r requirements.txt 2python -m spacy download en_core_web_md

Usage

1. Start the API server:
   python app.py
2. Open Postman and send a POST request to:
   http://localhost:8000/classify
   With this JSON body:
   json

   1{ 2 "email_body": "Hello, my name is John Doe, and my email is johndoe@example.com." 3}
3. Expected response:
   json

   1{ 2 "masked_email": "Hello, my name is [name], and my email is [email_address].", 3 "category": "General Inquiry" 4}
4. You can also access the interactive documentation at:
   http://localhost:8000/docs

Features

• Detects and masks sensitive information: names, phone numbers, emails, credit cards
• Classifies emails into predefined categories (e.g., General Inquiry, Complaint, etc.)
• Interactive API documentation via FastAPI

Project Structure

app.py           # Main application
api.py           # API endpoints and routes
models.py        # Email classification logic
utils.py         # PII masking and utilities
requirements.txt # Python dependencies
README.md        # Project instructions

Production

email-classification-system

email-classification-system

email-classification-system

email-classification-system