Getting Started with Mailpilot

Mailpilot is an AI-powered email processing daemon that automatically organizes, flags, and manages your inbox using LLM classification.

What You'll Need

Before you begin, ensure you have:

Node.js 22+ installed on your system
pnpm package manager (or npm)
Email account with IMAP access (Gmail, Outlook, etc.)
LLM API key (OpenAI, Anthropic, or access to Ollama)

Installation Options

Choose the method that works best for you:

From Source

Clone the repository and build from source. Best for development.

Docker

Run with Docker or Docker Compose. Easiest for production deployment.

Pre-built Binary

Download and run the pre-built executable (coming soon).

Quick Start (5 minutes)

The fastest way to get started:

# 1. Clone and install
git clone https://github.com/metal0/mailpilot.git
cd mailpilot
pnpm install

# 2. Configure
cp config.example.yaml config.yaml
# Edit config.yaml with your email and LLM settings

# 3. Build and run
pnpm build
pnpm start

Visit http://localhost:8080 to access the dashboard.

Next Steps

Configure Your Email Account

Set up IMAP access for Gmail, Outlook, or another provider.

Choose an LLM Provider

Configure OpenAI, Ollama, Anthropic, or another provider.

Write Classification Rules

Learn how to write effective classification prompts for your inbox.

Test and Deploy

Use the dashboard sandbox to test rules before production.

Key Features

Smart LLM Classification - Uses any OpenAI-compatible API with confidence scoring and multi-action support
Multi-Account Management - Process unlimited email accounts with per-account settings
Real-Time Dashboard - Modern web interface with live updates and activity logs
Privacy-First Design - Email content never stored or logged
Works With Any IMAP Server - Gmail, Outlook, FastMail, self-hosted