Skip to main content

Open-source OSINT email intelligence tool

Project description

MailAccess Logo

MailAccess

License: MIT Python 3.11+ Docker PyPI version PyPI Downloads

Self-hostable OSINT platform for investigating email addresses. Fan out across breach databases, social networks, DNS records, and the open web — get back a unified exposure score and structured findings you can export or pipe into Maltego.

Built for security researchers, OSINT analysts, and penetration testers operating under authorization. Read DISCLAIMER.md before use.

Install

Quickest — CLI only

pip install mailaccess
# or (recommended)
pipx install mailaccess

Full stack (Web UI + API + CLI)

git clone https://github.com/YOUR_USERNAME/mailaccess
cd mailaccess
docker compose up -d
pip install mailaccess
mailaccess config set-url http://localhost:8000

Quick Start

mailaccess investigate you@example.com
mailaccess investigate you@example.com -o report.pdf
mailaccess investigate you@example.com --format json
mailaccess keys list
mailaccess keys set HIBP_API_KEY your-key-here
mailaccess modules

What It Does

  • Identity graph — cross-platform correlation of accounts, usernames, and signals from each investigation
  • Phone number recovery — pipeline to surface and validate numbers tied to the target
  • Telegram / WhatsApp hints — lightweight messaging-app footprint checks alongside other modules
  • YAML-driven platform system — social-style checks defined in backend/platforms/; community extensible without new Python for each site
  • Concurrent module execution — all modules run in parallel, results stream as they arrive
  • WebSocket streaming — partial results arrive in real time without polling
  • REST API + web UI + CLI — use whatever interface fits your workflow
  • Plugin module system — drop a .py file in backend/modules/ and it auto-registers; no wiring required
  • 6 export formats: JSON, CSV, PDF, Markdown, STIX 2.1, Maltego XML
  • Maltego local transform server — run investigations directly from the Maltego desktop app
  • Webhook notifications — Slack, Discord, or any HTTP endpoint
  • Exposure score (0–100) with risk label: low / medium / high / critical
  • SQLite by default; PostgreSQL optional via Docker Compose profile

Modules

Module Coverage Key Required Opt-in
gravatar Profile hash lookup No No
hibp Breach check Yes No
emailrep Reputation + blacklist No No
hudson_rock Infostealer logs (free) No No
google_dork 5 automated dorks Yes (SerpAPI) No
domain_intel WHOIS + DNS + Shodan No (Shodan optional) No
social 13 platforms via YAML No No
account_discovery Holehe 120+ platforms No Yes
user_scanner 205+ platform vectors No Yes
whatsmyname 700+ platforms No Yes
breachdirectory 2nd breach source Yes No
username_pivot WMN via recovered usernames No Yes
permutation_discovery 60 email variants No Yes
phone_intel Phone validation + WA/TG hints No No
messaging_hints Telegram/WhatsApp username check No No
ghunt Gmail deep intel No (setup required) Yes

800+ platforms checked when all opt-in modules enabled. YAML platform system — add new platforms via PR, no Python required.

Identity Graph

Every investigation generates a cross-platform identity graph linking accounts by shared usernames, photos, display names, and breach data. View at:

/investigation/:id/graph

Export as Neo4j Cypher via GET /api/report/{id}/graph

Adding a Platform

No Python required. Drop a YAML file in backend/platforms/:

cp backend/platforms/TEMPLATE.yaml backend/platforms/mysite.yaml

Edit fields, submit PR.

See CONTRIBUTING.md for full guide.

Export Formats

Format ?format= value Use case
JSON json Programmatic use, archiving
CSV csv Spreadsheet analysis
PDF pdf Human-readable reports
Markdown markdown Wikis, issue trackers
STIX 2.1 stix Threat intelligence platforms
Maltego XML maltego Maltego graph import

Integrations

Integration How
Maltego Local transform server at POST /maltego/email_investigate (no API key required)
Slack Set SLACK_WEBHOOK_URL in .env
Discord Set DISCORD_WEBHOOK_URL in .env
Generic webhook INTEGRATION_WEBHOOK_URL + optional INTEGRATION_WEBHOOK_SECRET (HMAC)

Self-Hosting

cp .env.example .env      # all API keys are optional
docker compose up         # backend :8000  ·  frontend :3000

Open http://localhost:3000 in your browser. Full setup guide: docs/self-hosting.md.

CLI Reference

Command Description
mailaccess investigate <email> Run a full investigation against an email address
mailaccess history List past investigations
mailaccess keys list Show all configured API keys
mailaccess keys set <KEY> <value> Set an API key
mailaccess keys unset <KEY> Remove an API key
mailaccess config set-url <url> Point the CLI at a MailAccess instance
mailaccess modules List all available modules
mailaccess commands List all CLI commands

The --output / -o flag on investigate saves the report to a file. The extension determines the format: .json, .csv, .pdf, .md, .stix.json, .maltego.csv.

API Keys

Key Module Where to get it Required?
HIBP_API_KEY hibp https://haveibeenpwned.com/API/Key Yes (module skips without it)
SERPAPI_KEY google_dork https://serpapi.com Yes (module skips without it)
SHODAN_API_KEY domain_intel https://account.shodan.io No
EMAILREP_API_KEY emailrep https://emailrep.io No
HUNTER_IO_API_KEY hunter_io https://hunter.io No
SLACK_WEBHOOK_URL Webhooks https://api.slack.com/messaging/webhooks No
DISCORD_WEBHOOK_URL Webhooks Discord server settings No

Links

Self-hosting guide Docker Compose, .env reference, PostgreSQL, proxy/Tor, Maltego setup
Module reference All modules, findings schema, adding new modules
API reference REST endpoints, WebSocket events, authentication
Export formats Supported formats, MIME types, filename conventions
Integrations Maltego, Slack, Discord, generic webhooks
Contributing Adding modules, adding exporters, code style, PR checklist
PyPI pip install mailaccess
GitHub Source code, issues, releases

Changelog

0.3.0

  • Identity graph with D3 visualization
  • Phone number recovery + WhatsApp/Telegram hints
  • YAML-driven platform system (community extensible)
  • user-scanner integration (205+ vectors)
  • Username pivot via WhatsMyName
  • BreachDirectory as second breach source
  • Permutation discovery for related emails

0.2.0

  • ASCII banner on CLI launch
  • API key management (mailaccess keys list/set/unset)
  • --output / -o flag for direct file export
  • mailaccess modules and mailaccess commands
  • pipx install support

0.1.0

  • Initial release
  • 800+ platform coverage (WMN + Holehe + hardcoded)
  • 6 export formats (JSON CSV Markdown PDF STIX Maltego)
  • Maltego local transform server
  • Slack + Discord + webhook integrations
  • Docker Compose self-hosting
  • Full REST API + WebSocket streaming

License

MIT. All data queried by MailAccess comes from public sources. See DISCLAIMER.md for authorized use cases and legal responsibility.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mailaccess-0.3.3.tar.gz (255.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mailaccess-0.3.3-py3-none-any.whl (111.2 kB view details)

Uploaded Python 3

File details

Details for the file mailaccess-0.3.3.tar.gz.

File metadata

  • Download URL: mailaccess-0.3.3.tar.gz
  • Upload date:
  • Size: 255.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.6

File hashes

Hashes for mailaccess-0.3.3.tar.gz
Algorithm Hash digest
SHA256 4ba9fb0db97b4856e1fd2abcfc1681280712d87d1de19239e0b4847a06e7a0e9
MD5 06a7f1238cb63a3f94ec907e9e13b4af
BLAKE2b-256 1ccf5504f268fffec2f2bdd6ebaad2596deb0159816cf8f0ed213664fb806a55

See more details on using hashes here.

File details

Details for the file mailaccess-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: mailaccess-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 111.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.6

File hashes

Hashes for mailaccess-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 70f379c9d41b11339d52cac99ae108da032afc580a502fce346b545b2be025c5
MD5 f64e6ac13e242033a807d4c4358125e5
BLAKE2b-256 9b5e2dcfefd58f190e2d28746ce88e78a8a8a3faf3435af2c26f559902188e80

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page