Mail-Rulez Documentation

Welcome to the Mail-Rulez documentation. Mail-Rulez is an intelligent IMAP email management system that automates inbox processing through sophisticated rules-based filtering and list management.

Quick Navigation

📚 Core Documentation

• Getting Started - Installation and initial setup
• Complete Workflow Guide - From setup to full automation
• Retention Policies - Automated email lifecycle management

⚙️ Configuration & Features

• Advanced Configuration - Multi-account management and optimization
• Monitoring & Maintenance - System monitoring and upkeep
• Troubleshooting Guide - Problem solving

🔧 Technical Reference

• API Reference - REST API documentation
• Deployment Guide - Production deployment
• Contributing - Development setup and guidelines

What is Mail-Rulez?

Mail-Rulez transforms email management from a time-consuming chore into an automated, intelligent process. Whether you're managing personal inboxes or business email accounts, Mail-Rulez provides:

• Automated Processing: Rules-based email filtering and organization
• Smart Lists: Whitelist, blacklist, and vendor list management
• Multi-Account Support: Manage multiple IMAP accounts from one interface
• Retention Policies: Automated email lifecycle management
• Privacy First: Self-hosted solution keeps your data under your control

Getting Help

• Issues: Report bugs or request features on GitHub
• Discussions: Join community discussions on GitHub Discussions
• Commercial Support: For business users, contact [email protected]

License

Mail-Rulez is dual-licensed:

• AGPL v3: For open source and self-hosted use
• Commercial License: For hosted services and commercial deployments

See our licensing page for details.