GitHub - s1t5/mail-archiver: Mail-Archiver is a web application for archiving, searching, and exporting emails from multiple accounts. Featuring folder sync, attachment support, mailbox migration and a dashboard. (original) (raw)

📧 Mail-Archiver - Email Archiving System

A comprehensive solution for archiving, searching, and exporting emails

🌐 Website: mail-archiver.org

✨ Key Features

📌 Core Features

• Automated archiving of incoming and outgoing emails from multiple accounts
• Storage of email content and attachments with scheduled synchronization
• Mobile and desktop optimized, multilingual responsive UI with dark mode
• OpenID Connect (OIDC) for integration of external authentication services (OIDC Implementation Guide)

🔍 Search & Access

• Advanced search across all archived emails with filtering options
• Preview emails with attachment list
• Export entire mail accounts as mbox files or zipped EML archives
• Export selected individual emails or email batches

👥 User Management

• Multi-user support with account-specific permissions
• Dashboard with statistics, storage monitoring, and sender analysis
• Comprehensive access logging with detailed activity tracking of user activities (Access, Export, Deletion, Restore and many more) - see Access Logging Guide for details

🧩 Email Provider Support

• IMAP: Traditional IMAP accounts with full synchronization capabilities
• M365: Microsoft 365 mail accounts via Microsoft Graph API (Setup Guide)
• IMPORT: Import-only accounts for migrating existing email archives

📥 Import & Restore Functions

• MBox Import and EML Import (ZIP files with folder structure support)
• Restore selected emails or entire mailboxes to destination mailboxes

🗑️ Retention Policies

• Configure automatic deletion of archived emails from mailserver after specified days (Retention Policies Documentation)
• Set retention period per email account (e.g., 30, 90, or 365 days)
• Local Archive Retention: Configure separate retention period for local archive

📚 Documentation

For detailed documentation on installation, configuration, and usage, please refer to the Documentation Index. Please note that the documentation is still fresh and is continuously being expanded.

🖼️ Screenshots

Dashboard

Archive

Email Details

🚀 Quick Start

Prerequisites

• Docker
• Docker Compose

🛠️ Installation

1. Install the prerequisites on your system
2. Create a docker-compose.yml file

services: mailarchive-app: image: s1t5/mailarchiver:latest restart: always environment: # Database Connection - ConnectionStrings__DefaultConnection=Host=postgres;Database=MailArchiver;Username=mailuser;Password=masterkey;

  # Authentication Settings
  - Authentication__Username=admin
  - Authentication__Password=secure123!

  # TimeZone Settings
  - TimeZone__DisplayTimeZoneId=Etc/UCT
ports:
  - "5000:5000"
networks:
  - postgres
volumes:
  - ./data-protection-keys:/app/DataProtection-Keys
depends_on:
  postgres:
    condition: service_healthy

postgres: image: postgres:17-alpine restart: always environment: POSTGRES_DB: MailArchiver POSTGRES_USER: mailuser POSTGRES_PASSWORD: masterkey volumes: - ./postgres-data:/var/lib/postgresql/data networks: - postgres healthcheck: test: ["CMD-SHELL", "pg_isready -U mailuser -d MailArchiver"] interval: 10s timeout: 5s retries: 5 start_period: 10s

networks: postgres:

1. Edit the database configuration in the docker-compose.yml and set a secure password in the POSTGRES_PASSWORD variable and the ConnectionString.
2. Definie a Authentication__Username and Authentication__Password which is used for the admin user.
3. Adjust the TimeZone__DisplayTimeZoneId environment variable to match your preferred timezone (default is "Etc/UCT"). You can use any IANA timezone identifier (e.g., "Europe/Berlin", "Asia/Tokyo").
4. Configure a reverse proxy of your choice with https to secure access to the application.

⚠️ AttentionThe application itself does not provide encrypted access via https! It must be set up via a reverse proxy!

1. Initial start of the containers:
2. Restart containers:
3. Access the application in your prefered browser.
4. Login with your defined credentials and add your first email account:

• Navigate to "Email Accounts" section
• Click "New Account"
• Enter your server details and credentials
• Save and start archiving!
• If you want, create other users and assign accounts.

🔐 Security Notes

• Use strong passwords and change default credentials
• Consider implementing HTTPS with a reverse proxy in production
• Regular backups of the PostgreSQL database recommended (see Backup & Restore Guide for detailed instructions)

⚙️ Advanced Setup

For a complete list of all configuration options, please refer to the Setup Guide.

📋 Technical Details

Architecture

• ASP.NET Core 10 MVC application
• PostgreSQL database for email storage
• MailKit library for IMAP communication
• Microsoft Graph API for M365 email access
• Background service for email synchronization
• Bootstrap 5 and Chart.js for frontend

🤝 Contributing

We welcome contributions from the community! Please read our Contributing Guide for detailed information about how to contribute to Mail Archiver.

For code changes by third parties, please coordinate with us via email at mail@s1t5.dev before making any changes.

You can also:

• Open an Issue for bug reports or feature requests
• Submit a Pull Request for improvements
• Help improve documentation

💖 Support the Project

If you find this project useful and would like to support its continued development, you can buy me a coffee! Your support helps me dedicate more time and resources to improving the application and adding new features. While financial support is not required, it is greatly appreciated and helps ensure the project's ongoing maintenance and enhancement.

🌟 Project Sponsors

With the generous support of our sponsors, Mail Archiver continues to evolve. Thank you for making it possible!

Disclaimer: The services listed above are third-party offerings and are neither affiliated with, endorsed by, nor tested by the Mail Archiver project.

💝 Individual Sponsors

A special thanks to all individual sponsors who support this project through GitHub Sponsors, Ko-fi, and Buy Me a Coffee. Your contributions make a real difference!

📄 License: GNU GENERAL PUBLIC LICENSE Version 3 (see LICENSE file)