ownmail 0.3.0

Own your mail. A file-based email backup and search tool.

ownmail

Own your mail. Back up your email to plain files. Search and read them offline. Own them forever.

$ ownmail download

ownmail - Download
==================================================

✓ Authenticated with Gmail API
Archive location: /Volumes/Secure/ownmail
Previously downloaded: 12,847 emails

Checking for new emails...

✓ No new emails to download. Archive is up to date!

Install

pip install ownmail
# or
pipx install ownmail

Quick Start

# 1. Set up credentials (one-time)
ownmail setup

# 2. Download your emails
ownmail download

# 3. Search
ownmail search "invoice from:amazon"

# 4. Browse your archive in the browser
ownmail serve

Philosophy

• 📁 Files as source of truth — Your emails are stored as standard .eml files. No proprietary database, no lock-in.
• 🔐 You own your data — Everything stays on your drive. Put it on an encrypted volume and you're done.
• ⚡ Fast & incremental — Only downloads new emails. Resume anytime with Ctrl-C.
• 🔍 Full-text search — SQLite FTS5-backed search. Fast, local, private.
• 🌐 Built-in viewer — Browse and read your archive in any browser. Dark mode, sanitized HTML, attachment downloads.

Why ownmail?

Tools like mbsync + notmuch can accomplish similar goals — mbsync syncs IMAP to a local Maildir, and notmuch indexes it for fast tag-based search. They're powerful and battle-tested. Here's how ownmail differs:

	mbsync + notmuch	ownmail
What it is	Two separate tools (sync + index)	Single tool: backup, search, browse
Setup	Configure mbsync and notmuch separately	pip install ownmail && ownmail setup
Credentials	Plaintext in ~/.mbsyncrc	System keychain (macOS/Windows/Linux)
Storage format	Maildir (flags in filenames)	.eml files organized by date
Search engine	Xapian (tag-based, very fast)	SQLite FTS5 (good enough for most archives)
Reading email	Emacs, Vim, mutt, or other frontends	Built-in web UI
Providers	IMAP only	IMAP + Gmail API (OAuth, batch downloads)
Integrity checking	—	Detects corrupted or missing files
Philosophy	Power-user toolkit, compose your workflow	Opinionated single tool — backup, search, done

Choose mbsync + notmuch if you already live in Emacs/mutt and want maximum flexibility.

Choose ownmail if you want a simple, self-contained email backup that stores plain files and lets you search and read them in a browser.

Commands

Command	Description
setup	Set up email source credentials (App Password or OAuth)
download	Download new emails (with content-hash dedup)
search "query"	Full-text search
serve	Browse and read your archive in the browser
stats	Show archive statistics
verify	Check file integrity (hashes, moved files, orphans, DB health)
sync-check	Compare local archive with server to find missing emails
update-labels	Update labels on existing emails
rebuild	Rebuild search index and populate metadata
reset-sync	Reset sync state to force full re-download
sources list	List configured email sources

Setup

ownmail supports two methods for connecting to your email:

Option A: IMAP with App Password (recommended)

The simplest way to get started. Works with Gmail, Outlook, Fastmail, and any IMAP server.

For Gmail:

1. Enable 2-Step Verification (if not already)
2. Go to App Passwords
3. Create an App Password (name it "ownmail")
4. Run setup:

ownmail setup
# Choose [1] IMAP with App Password
# Enter your Gmail address and the 16-character App Password

That's it. Credentials are stored in your system keychain.

"The setting you are looking for is not available for your account"? This means 2-Step Verification isn't enabled yet (step 1 above), or your Google Workspace admin has disabled App Passwords. For Workspace accounts where App Passwords are blocked, use Option B (OAuth) instead.

For other IMAP servers (Fastmail, company mail, etc.), the same flow works — you'll be prompted for the IMAP hostname.

Option B: Gmail API with OAuth (advanced)

Uses the Gmail API with read-only OAuth scope. Faster batch downloads and native Gmail labels, but requires creating a Google Cloud project.

ownmail setup --method oauth

Detailed steps

1. Go to Google Cloud Console
2. Create a new project (or select existing)
3. APIs & Services → Library → search "Gmail API" → Enable
4. APIs & Services → Credentials → Create Credentials → OAuth client ID
5. Application type: Desktop app → Create
6. Download the JSON file
7. Run: ownmail setup --method oauth
8. When prompted, enter the path to the downloaded JSON file (or paste its contents)

Comparison

	IMAP + App Password	Gmail API + OAuth
Setup time	30 seconds	~15 minutes
Requires	2FA enabled	Google Cloud project
Access scope	Full account	Read-only
Revocable	Yes (App Passwords page)	Yes (Google Account)
Speed	Sequential (one at a time)	Batch downloads
Gmail labels	Mapped from IMAP folders	Native labels
Works with	Gmail, Outlook, Fastmail, any IMAP	Gmail only
Credentials stored in	System keychain	System keychain

Config File

Create config.yaml in your working directory:

archive_root: /Volumes/Secure/ownmail

sources:
  # Option A: IMAP with App Password (recommended)
  - name: gmail_personal
    type: imap
    host: imap.gmail.com
    account: [e-mail]
    auth:
      secret_ref: keychain:imap-password/[e-mail]

  # Option B: Gmail API with OAuth
  # - name: gmail_personal
  #   type: gmail_api
  #   account: [e-mail]
  #   auth:
  #     secret_ref: keychain:oauth-token/[e-mail]
  #   include_labels: true

  # Other IMAP servers
  # - name: work_imap
  #   type: imap
  #   host: imap.company.com
  #   account: [e-mail]
  #   auth:
  #     secret_ref: keychain:imap-password/[e-mail]
  #   exclude_folders:
  #     - Trash
  #     - Spam

Search

ownmail search "invoice"
ownmail search "from:amazon"
ownmail search "subject:receipt"
ownmail search "attachment:pdf"

Security

What	Where
App Passwords & OAuth tokens	System keychain (macOS/Windows/Linux)
Emails & search index	Your chosen directory

Nothing sensitive on the filesystem. Put your archive on an encrypted volume.

Advanced

Storage Layout

/Volumes/Secure/ownmail/
├── ownmail.db              # SQLite (tracking + search index)
└── sources/
    └── gmail_personal/
        ├── 2024/
        │   ├── 01/
        │   │   ├── 20240115_143022_a1b2c3d4e5f6.eml
        │   │   └── ...
        │   └── 02/
        └── 2025/
            └── ...

• Emails: Standard .eml format, organized by account and date
• Database: Stores metadata (message IDs, filenames, hashes, subjects, senders) and a full-text search index — the .eml files are the source of truth

Integrity Verification

# Verify file hashes, detect moved files, check for orphans and DB health
ownmail verify

# Auto-fix: update moved file paths, remove stale entries, rebuild FTS
ownmail verify --fix

# Check if local archive matches server
ownmail sync-check

Resumable Downloads

Press Ctrl-C anytime to pause:

  [1,342/15,000]   45KB - indexing...
^C

⏸ Stopping after current email...
--------------------------------------------------
Download Paused!
  Downloaded: 1,342 emails
  Remaining: 13,658 emails

  Run 'download' again to resume.

HTML Sanitization

When using ownmail serve, email HTML is sanitized server-side using DOMPurify running in a Node.js sidecar process. This strips <script> tags, event handlers, dangerous CSS (@import, expression()), and other XSS vectors before the content reaches your browser.

Requires Node.js (v18+). Dependencies are installed automatically on first run.

Roadmap

• IMAP support (Gmail, Outlook, Fastmail, any IMAP server)
• Gmail API (OAuth, batch downloads, native labels)
• Web UI for browsing and search
• Local .eml import

License

MIT