inboxer/README.md

35 lines
No EOL
1.1 KiB
Markdown

# inBOXER
Email classification and organization tool using IMAP and AI.
## Overview
inBOXER is a Go application that:
- Connects to your IMAP email account
- Uses DeepSeek AI to classify incoming emails
- Automatically moves emails to appropriate folders (Important, eCommerce, Other, Spam)
- Provides a web interface for configuration and monitoring
## Features
- **Email + OTP Authentication**: Secure login without passwords
- **AI-Powered Classification**: Uses DeepSeek LLM for intelligent email sorting
- **Mobile-First Web Interface**: Responsive design for all devices
- **Modular Architecture**: Clean separation of concerns (auth, IMAP, AI, database, worker)
- **Test Mode**: Preview AI decisions without moving emails
## Quick Start
1. Clone the repository
2. Configure `.env` with your API keys and credentials
3. Run `make build` to compile the binary
4. Run `make run` to start the application
5. Access the web interface at `http://localhost:8080`
## Architecture
See `PROJECT_PLAN.md` for detailed architecture and development phases.
## License
See `docs/LICENSE.md` for license information.