Installation

Installation

Requirements

• Python 3.9+
• Windows, Linux, or macOS
• pip3
• An internet connection (MailGrab pings oceanofanything.github.io at startup as a connectivity check — see FAQ & Troubleshooting if you're running it somewhere offline/sandboxed)

Get the code

git clone https://github.com/OCEANOFANYTHING/MailGrab
cd MailGrab

Install dependencies

Windows — run the installer:

install.bat

or directly:

python -u install.py

Linux / macOS — the installer needs root to install system-wide packages:

sudo python -u install.py

Manually, on any platform — the installer is really just a friendly wrapper around pip:

pip install -r requirements.txt

install/install.py installs a curated subset of packages (the direct dependencies), while the root requirements.txt is the full pinned dependency tree used for automated dependency-update tracking (Renovate) and security scanning (CodeQL). Either one gets you a working install; if you add a new import to MailGrab.py yourself, add the package to both.

Run it

python MailGrab.py

or on Windows, windows.bat does the same thing and pauses the console on exit.

Continue to Quick Start for your first crawl.