Skip to content

RomainROCH/MailSorter

Repository files navigation

MailSorter - Archived

This project demonstrated the limitations of the Thunderbird market for LLM-powered tools. Giants like Gmail + Gemini and Outlook + Copilot have solved the problem more effectively for 95% of users.

MailSorter remains quality code if someone wants to fork it. However, I'm focusing on projects with greater user impact.

Version License Status

Version: 1.0.0 | Changelog | User Guide

🚀 AI-powered email sorting for Thunderbird & Betterbird

Overview

MailSorter is an intelligent email sorting extension that uses Large Language Models (LLMs) to automatically classify and organize your emails. Built with a Privacy-First approach using a hybrid WebExtension + Native Messaging architecture.

Key Features:

  • 🤖 Multiple LLM Providers - Ollama (local), OpenAI, Anthropic, Google Gemini
  • 🔒 Privacy-First - PII scrubbing, headers-only mode, local processing option
  • 📊 92-98% Accuracy - Observed on public dataset benchmarks
  • Real-Time & Batch - Sort new emails instantly or process archives in bulk
  • 🌍 Multi-Language - French and English interface

Quick Start

# 1. Clone the repository
git clone https://github.com/RomainROCH/MailSorter.git
cd MailSorter

# 2. Install Python dependencies
cd backend && pip install -r requirements.txt && cd ..

# 3. Register native messaging (Windows)
installers\register.bat

# 4. Install extension in Thunderbird
# Menu → Add-ons → Install from File → select mailsorter-1.0.0.xpi

See the User Guide for detailed installation instructions.

Documentation

Document Description
📖 User Guide Installation, configuration, and usage
🔧 Troubleshooting Common issues and solutions
📋 Compatibility Matrix Supported versions and platforms
🏗️ Architecture Technical design and data flow
🔒 RGPD Compliance Privacy and security details
📝 Plan V5 Full specification

Requirements

Component Requirement
Email Client Thunderbird 115+ or Betterbird
Python 3.10 or higher
LLM Ollama (local) or cloud API key

See Compatibility Matrix for detailed requirements.

Usage

  1. Configure - Run the onboarding wizard or go to Settings
  2. Map folders - Connect categories to your email folders
  3. Sort automatically - New emails are classified in real-time
  4. Manual sort - Right-click → "Sort with MailSorter" or Ctrl+Shift+M

Providers

Provider Type Privacy Cost
Ollama Local ⭐⭐⭐⭐⭐ Free
OpenAI Cloud ⭐⭐⭐ Paid
Anthropic Cloud ⭐⭐⭐ Paid
Gemini Cloud ⭐⭐⭐ Paid

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

Security

For security vulnerabilities, please see SECURITY.md.

License

MIT License - see LICENSE


Made with ❤️ for email sanity

About

A mail sorter

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors