> ## Documentation Index
> Fetch the complete documentation index at: https://jmail.world/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Python Client

> Single-file Python client with ETag caching

<img src="https://mintcdn.com/jmail/F-FAi3RZzojcIyie/images/jmail-app.png?fit=max&auto=format&n=F-FAi3RZzojcIyie&q=85&s=3d45d0246f3c69c7024d9a467fcfad28" alt="Jmail" style={{ width: '56px', marginBottom: '16px' }} width="207" height="207" data-path="images/jmail-app.png" />

The Jmail Python client is a single file with zero install requirements. It uses [PEP 723](https://peps.python.org/pep-0723/) inline dependencies, so [`uv run`](https://docs.astral.sh/uv/) handles everything automatically.

## Setup

No installation needed. Just run with `uv`:

```bash theme={null}
uv run clients/python/jmail.py emails --head 5
```

Or use as a library in your own scripts:

```python theme={null}
from jmail import JmailClient

client = JmailClient()
df = client.emails()
```

## Library Usage

### Basic Usage

```python theme={null}
from jmail import JmailClient

client = JmailClient()

# All emails with full body text
df = client.emails()

# Network-only (no body text, much smaller download)
df = client.emails(slim=True)

# Documents with full extracted text (downloads sharded files)
docs = client.documents(include_text=True)

# Photos, people, and facial recognition data
photos = client.photos()
people = client.people()
faces = client.photo_faces()

# iMessage conversations and messages
convos = client.imessage_conversations()
messages = client.imessage_messages()

# Crowd-sourced star counts
stars = client.star_counts()

# Release batch metadata
batches = client.release_batches()
```

### Get Raw URLs

For use with DuckDB, Polars, or other tools:

```python theme={null}
url = client.url("emails-slim")
# → "https://data.jmail.world/v1/emails-slim.parquet"

url = client.url("emails-slim", fmt="ndjson.gz")
# → "https://data.jmail.world/v1/emails-slim.ndjson.gz"
```

### Disable Caching

```python theme={null}
# Always download fresh (no local cache)
client = JmailClient(cache=False)
```

## CLI Reference

```
Usage: uv run jmail.py <command> [options]

Commands:
  manifest          Print manifest JSON
  emails            Download emails (--slim for network-only, --head N)
  documents         Download documents (--include-text for full text, --head N)
  photos            Download photos metadata (--head N)
  people            Download people (--head N)
  photo_faces       Download photo face data (--head N)
  imessage_conversations  Download iMessage conversations (--head N)
  imessage_messages       Download iMessage messages (--head N)
  star_counts       Download star counts (--head N)
  release_batches   Download release batches (--head N)
  urls              Print all dataset URLs
  duckdb-examples   Print example DuckDB SQL queries

Options:
  --head N          Show first N rows
  --slim            (emails) Omit body text columns
  --include-text    (documents) Include full extracted text
  --no-cache        Skip local caching, always download fresh
```

### Examples

```bash theme={null}
# First 10 emails, network-only view
uv run jmail.py emails --slim --head 10

# All documents with full text
uv run jmail.py documents --include-text

# Print dataset URLs for use elsewhere
uv run jmail.py urls

# Get manifest with dataset checksums
uv run jmail.py manifest

# Fresh download (skip cache)
uv run jmail.py emails --no-cache --head 5
```

## Dependencies

The client has three dependencies, managed automatically by `uv`:

* `pandas` -- DataFrame handling
* `pyarrow` -- Parquet file reading
* `requests` -- HTTP downloads

These are declared inline via PEP 723:

```python theme={null}
# /// script
# requires-python = ">=3.9"
# dependencies = ["pandas", "pyarrow", "requests"]
# ///
```