nunomsde/maillinter repository overview

⁠MailLinter - Professional Email Testing Tool

A modern email testing tool with comprehensive HTML/CSS compatibility analysis, SpamAssassin integration, AI-powered analysis, and professional web interface.

⁠🚀 Quick Start

# Pull and run the latest release
docker run -d --name maillinter \
  -p 2525:2525 -p 8547:8547 \
  nunomsde/maillinter:latest

# Open web interface
open http://localhost:8547

⁠With Authentication & AI Analysis

docker run -d --name maillinter \
  -p 2525:2525 -p 8547:8547 \
  -e AUTH_ENABLED=true \
  -e AUTH_USERNAME=admin \
  -e AUTH_PASSWORD=yourpassword \
  -e AI_PROVIDER=openai \
  -e AI_API_KEY=sk-your-openai-key \
  nunomsde/maillinter:latest

⁠📋 What's Included

• ✅ SMTP Server - Capture emails on port 2525
• ✅ Modern Web Interface - Professional React UI on port 8547
• ✅ SpamAssassin Integration - Industry-standard spam analysis
• ✅ Compatibility Analysis - 15+ email client compatibility testing
• ✅ AI-Powered Analysis - Smart recommendations via OpenAI, Anthropic, or Ollama
• ✅ UI Authentication - Optional login protection for the web interface
• ✅ API Key Authentication - Secure external API access
• ✅ Developer Tools - Built-in email composer with API documentation
• ✅ Responsive Preview - Desktop/tablet/mobile email testing
• ✅ Attachment Support - View and download email attachments
• ✅ Syntax Highlighting - HTML source code with highlighting

⁠🐳 Supported Architectures

Multi-architecture support: linux/amd64, linux/arm64

• nunomsde/maillinter:latest - Latest stable release
• nunomsde/maillinter:v1.x.x - Specific version releases
• nunomsde/maillinter:develop - Latest development build

⁠🔧 Docker Compose Example

version: '3.8'
services:
  maillinter:
    image: nunomsde/maillinter:latest
    ports:
      - "2525:2525"  # SMTP
      - "8547:8547"  # Web UI
    environment:
      # Optional: Enable UI authentication
      - AUTH_ENABLED=true
      - AUTH_USERNAME=admin
      - AUTH_PASSWORD=yourpassword
      # Optional: Enable AI analysis (choose one provider)
      - AI_PROVIDER=openai
      - AI_API_KEY=sk-your-key
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8547/api/emails"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 5s

⁠⚙️ Environment Variables

⁠🔐 Authentication

UI Authentication: When enabled, users must log in to access the web interface. Sessions persist for 3 days.

API Key Authentication: External API access always requires an API key. Generate keys from Developer Tools → API Key tab in the web interface. Use with:

curl -H "Authorization: Bearer YOUR_API_KEY" http://localhost:8547/api/emails

⁠🔌 API Integration

MailLinter includes a comprehensive REST API and built-in developer tools:

• Email Composer - Send custom test emails with HTML/text content
• API Documentation - Complete API reference with examples
• Quick Test Scenarios - Pre-built email templates for common use cases
• Multi-language Examples - JavaScript, Python, PHP, and Node.js integration

Perfect for automated testing, development environments, and email template validation.