Skip to main content

Turn local mailbox exports into job, COOP, and Tamheer application reports.

Project description

Inbox Report

Turn local mailbox exports into structured application reports.

Inbox Report is a local CLI for students and early-career applicants who need to review a large mailbox of job, COOP, internship, Tamheer, and training applications without giving a tool live inbox access.

It reads .mbox and .eml exports, detects likely application-related messages, groups them by organization, infers rough status, and writes CSV, HTML, and PDF reports.

No inbox login. No email password. No cloud upload. No external API. No LLM.

Just a local parser and deterministic classifier for application review.

Features

  • Reads Gmail/Google Takeout-style .mbox files, Takeout Mail/ folders, Apple Mail .mbox packages, and Outlook-friendly .eml folders.
  • Detects likely job, COOP/cooperative training, Tamheer, internship, trainee, and application emails.
  • Supports English and Arabic matching terms.
  • Handles Saudi phrases like التدريب التعاوني, برنامج التدريب التعاوني, التدريب على رأس العمل, and تمهير.
  • Groups emails by guessed organization.
  • Classifies application type as coop, tamheer, internship, graduate_program, job, training, career_portal, or unknown_application.
  • Infers rough status: submitted_or_received, under_review, action_required, interview, offer_or_accepted, start_or_onboarding, ineligible, closed_or_full, rejected, or possible_application.
  • Adds confidence and review_bucket; only high-confidence rows with clear type and status are auto_classified.
  • Extracts links, sender details, subjects, snippets, and dates.
  • Writes editable CSV files plus organized HTML/PDF reports.

Fast Path

git clone https://github.com/mara-org/inbox-report.git
cd inbox-report
make demo

That creates a fake mailbox and writes demo outputs under .demo/.

If you are using a real inbox, read the Export Guide first.

Useful commands:

make help
make check
make test
make demo
make report INPUT=/path/to/Mail.mbox
make audit INPUT=/path/to/Mail.mbox
make path-smoke
make agent-check

Install

Python 3.9+ is supported.

git clone https://github.com/mara-org/inbox-report.git
cd inbox-report
python3 -m pip install -r requirements.txt

Local package install:

python3 -m pip install -e ".[pdf]"
inbox-report --version

Install from PyPI:

python3 -m pip install "inbox-report[pdf]"
inbox-report --version

The core CSV/HTML flow uses Python's standard library. PDF output uses reportlab; Arabic shaping in the PDF uses arabic-reshaper and python-bidi.

Usage

  1. Export Gmail from Google Takeout and include Mail only, or export an .eml folder from a desktop mail client.
  2. Wait for the export email. Gmail Takeout can take minutes, hours, or longer for large mailboxes.
  3. Download and unzip the Takeout archive.
  4. Find the Mail folder or the .mbox file inside it.
  5. Run:

Gmail / MBOX:

inbox-report /path/to/Takeout/Mail
inbox-report /path/to/Mail.mbox

Same thing through Make:

make report INPUT=/path/to/Mail.mbox

Strict mode is the default. It is intentionally conservative and filters out social digests, store orders, newsletters, and weak keyword matches. If you expected results and got an empty report, use audit mode to inspect noisy candidates:

inbox-report /path/to/Mail.mbox --include-weak
make audit INPUT=/path/to/Mail.mbox

Audit mode is for review, not final proof. Treat needs_review rows as "look at this manually", not as confirmed applications.

EML folder:

inbox-report /path/to/exported-emails/

Direct script usage also works:

python3 inbox_application_reporter.py /path/to/Mail.mbox

Gmail Export Quick Steps

  1. Open Google Takeout.
  2. Click Deselect all.
  3. Enable Mail only.
  4. Click Next step.
  5. Choose .zip and Send download link via email.
  6. Click Create export.
  7. Wait for Google's email.
  8. Download, unzip, and find the .mbox file inside the Mail folder.

Large exports are normal. If it does not arrive immediately, wait; it does not mean the export failed.

Custom output paths:

inbox-report /path/to/Mail.mbox \
  --out details.csv \
  --summary-out companies.csv \
  --html-out report.html \
  --pdf-out report.pdf

Short aliases are also supported for scripts and agents:

inbox-report /path/to/Takeout/Mail --output details.csv --html report.html --pdf report.pdf

Skip PDF generation:

inbox-report /path/to/Mail.mbox --no-pdf

Version:

inbox-report --version

Technical Overview

Inbox Report is intentionally deterministic. It does not classify messages with a remote model or send mailbox text to a service.

The pipeline is:

  1. Parse local mailbox exports with Python's standard email and mailbox libraries.
  2. Decode MIME headers and message bodies, including plain text and HTML email bodies.
  3. Normalize whitespace and extract sender, domain, subject, date, snippets, and links.
  4. Match application signals across English and Arabic term sets.
  5. Apply negative filters for common false positives such as store orders, newsletters, social digests, policy emails, discounts, shipping, and invoices.
  6. Infer application type, status, confidence, and review bucket.
  7. Write machine-readable CSV outputs and human-readable HTML/PDF reports.

The classifier favors precision in strict mode. Direct application confirmations, ATS domains, recruiting senders, role context, and status phrases increase confidence. Weak keyword matches are excluded by default and only appear when --include-weak is used.

Need the export steps? Start here:

PyPI

The PyPI package name is inbox-report. Publishing is local-only; this repository does not ship an automated release workflow.

Build and validate the release artifacts:

python3 -m pip install -r requirements-dev.txt
make package

Upload from your own machine with a PyPI project API token:

export TWINE_USERNAME=__token__
export TWINE_PASSWORD=pypi-...
make publish

Do not commit PyPI tokens, paste them into chat, or store them in GitHub repository settings.

Outputs

  • applications.csv: every matched email with sender, date, subject, guessed organization, application type, status, confidence, review bucket, links, matched terms, and snippet.
  • applications_summary.csv: one row per guessed organization with counts, first/last seen dates, status counts, type counts, review counts, domains, and latest subject.
  • applications_report.html: browser-friendly report grouped by organization.
  • applications_report.pdf: PDF report when optional PDF dependencies are installed.

Security And Privacy Model

This tool reads a local export file. It does not send email, log in to Gmail, modify messages, upload data, or call an external API.

Mailbox exports can contain sensitive personal data. Treat .mbox, CSV, HTML, and PDF outputs as private unless you intentionally redact and share them.

Accuracy Guardrails

The classifier is rule-based and tested with synthetic fixtures for Gmail-style confirmations, LinkedIn, Workday, Greenhouse, Lever, SmartRecruiters, Saudi COOP, Tamheer, interviews, offers, rejections, onboarding, store orders, newsletters, social digests, and marketing emails.

Strict mode favors precision. Audit mode exists for recall and manual review. Do not present needs_review rows as confirmed applications.

Contributing

PRs are welcome. The best PRs make detection better without making the privacy story worse.

Good areas:

  • better status detection
  • more ATS domains
  • safer organization guessing
  • tests with synthetic fixtures
  • packaging

Please do not include real mailbox exports, personal emails, screenshots of inboxes, or private identifiers in issues or PRs.

Maintainers

Maintained by Mara. Created by @gqnxx.

Regards, The CTO.

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

inbox_report-1.0.1.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

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

inbox_report-1.0.1-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file inbox_report-1.0.1.tar.gz.

File metadata

  • Download URL: inbox_report-1.0.1.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for inbox_report-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4b919d3bb2d7e0e33aee6233f3d7907ea6ad26b9190ebfbb4db16e9d898a479d
MD5 5ab928f74ea9a41d4d7e13593b81039c
BLAKE2b-256 2722d52d27cfd86fa61f06349fd5047f83fb56134356bf667b5cb0dd9f5016de

See more details on using hashes here.

File details

Details for the file inbox_report-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: inbox_report-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for inbox_report-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1b2c628cd4ac8e3ce4c3a8685f91469fb0696aef94cb66c4da3b49f1e6168ebf
MD5 cc7b3f072b383582f87dae8244074345
BLAKE2b-256 75ec48eef3058b643503076b0e8df35767dcaec311ed805075577519a54c10f8

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