Zum Hauptinhalt springen

​
Konstruktor

JmailClient(cache=True)
Erzeugt eine neue Client-Instanz.

​
Parameter

​
cache
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

MethodeRückgabewertBeschreibung
manifest()dictAPI-Manifest mit Datensatz-Metadaten
emails(slim)DataFrameE-Mail-Archiv
documents(include_text)DataFrameDokumentmetadaten und -text
photos()DataFrameFoto-Metadaten
people()DataFrameIdentifizierte Personen
photo_faces()DataFrameBounding-Boxen für Gesichter
imessage_conversations()DataFrameiMessage-Konversationen
imessage_messages()DataFrameiMessage-Nachrichten
star_counts()DataFrameCrowd-gestützte Sterne
release_batches()DataFrameInformationen zu Veröffentlichungsbatches
url(dataset, fmt)strDirekte 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"
​
dataset
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.
​
fmt
str
Standard:"parquet"
Dateiformat. Entweder parquet oder ndjson.gz.
Rückgabewert: str — vollständige URL