Skip to content

Plugins Command

Overview

The plugins command lists email-related plugins and tools required for EmailOS functionality. It shows installation status of email sync tools (isync/mbsync), mail transfer agents (msmtp), search engines (notmuch, mu), and other platform-specific email utilities.

Usage

bash
mailos plugins [flags]

Flags

  • --all: Show all plugins including optional ones
  • --required: Show only required plugins
  • --missing: Show only missing/uninstalled plugins
  • --check-paths: Check actual installation paths (default: true)
  • --install-guide: Show installation guides for missing plugins
  • --json: Output as JSON
  • --verbose: Show detailed output and debugging information

Examples

bash
# Show required plugins and status
mailos plugins

# Show all available plugins
mailos plugins --all

# Show only missing plugins
mailos plugins --missing

# Output as JSON
mailos plugins --json

# Show installation instructions
mailos plugins --install-guide

Platform-Specific Plugins

macOS

  • isync (mbsync): IMAP synchronization tool for email download
  • msmtp: SMTP client for sending emails
  • notmuch: Fast email search and indexing
  • mu (mailutils): Alternative fast email search engine (optional)
  • curl: HTTP client for web requests
  • CA Certificates: SSL/TLS certificate bundle

Linux

  • isync (mbsync): IMAP synchronization tool
  • msmtp: SMTP client
  • notmuch: Fast email search and indexing
  • mu4e: Alternative email search (optional)
  • curl: HTTP client
  • CA Certificates: SSL/TLS certificates

Windows

  • Git Bash: Unix-like command line environment
  • WSL: Windows Subsystem for Linux (recommended)
  • isync/msmtp/notmuch: Available via WSL
  • Outlook Integration: Native Windows email client integration (optional)

Installation

Most plugins can be installed using your system's package manager:

macOS (Homebrew)

bash
brew install isync msmtp notmuch mu ca-certificates

Linux (Ubuntu/Debian)

bash
sudo apt-get install isync msmtp notmuch mu4e curl ca-certificates

Windows

bash
# Install WSL first
wsl --install

# Then install tools in WSL
wsl sudo apt install isync msmtp notmuch

Quick Install

Use the EmailOS install script to install all dependencies:

bash
curl -fsSL https://email-os.com/install | bash

Or use the built-in installer:

bash
mailos plugins --missing --install-guide

Released under the MIT License.