JmailClient - Jmail Data API

Konstruktor

JmailClient(cache=True)

Erzeugt eine neue Client-Instanz.

Parameter

bool

Standard:"True"

Lokales, ETag-basiertes Datei-Caching unter ~/.cache/jmail/ aktivieren. Auf False setzen, um Daten immer neu herunterzuladen.

Beispiel

from jmail import JmailClient

# Standard: Caching aktiviert
client = JmailClient()

# Kein Caching
client = JmailClient(cache=False)

Methoden

Methode	Rückgabewert	Beschreibung
`manifest()`	`dict`	API-Manifest mit Datensatz-Metadaten
`emails(slim)`	`DataFrame`	E-Mail-Archiv
`documents(include_text)`	`DataFrame`	Dokumentmetadaten und -text
`photos()`	`DataFrame`	Foto-Metadaten
`people()`	`DataFrame`	Identifizierte Personen
`photo_faces()`	`DataFrame`	Bounding-Boxen für Gesichter
`imessage_conversations()`	`DataFrame`	iMessage-Konversationen
`imessage_messages()`	`DataFrame`	iMessage-Nachrichten
`star_counts()`	`DataFrame`	Crowd-gestützte Sterne
`release_batches()`	`DataFrame`	Informationen zu Veröffentlichungsbatches
`url(dataset, fmt)`	`str`	Direkte Datensatz-URL

`manifest()`

Ruft das API-Manifest mit Dataset-Metadaten und Prüfsummen ab.

manifest = client.manifest()
print(manifest)

Gibt zurück: dict — geparstes JSON-Objekt von data.jmail.world/v1/manifest.json

`url(dataset, fmt="parquet")`

Hole die rohe URL für eine Datensatzdatei. Nützlich, um sie direkt an DuckDB, Polars oder ein anderes Tool zu übergeben, das Parquet über HTTP lesen kann.

url = client.url("emails-slim")
# "https://data.jmail.world/v1/emails-slim.parquet"

url = client.url("documents", fmt="ndjson.gz")
# "https://data.jmail.world/v1/documents.ndjson.gz"

str

erforderlich

Name des Datasets. Einer der folgenden Werte: emails, emails-slim, documents, photos, people, photo_faces, imessage_conversations, imessage_messages, star_counts, release_batches.

str

Standard:"parquet"

Dateiformat. Entweder parquet oder ndjson.gz.

Rückgabewert: str — vollständige URL

​Konstruktor

​Parameter

​Beispiel

​Methoden

​manifest()

​url(dataset, fmt="parquet")