JmailClient - Jmail Data API

Constructeur

JmailClient(cache=True)

Crée une nouvelle instance du client.

Paramètres

bool

défaut:"True"

Active la mise en cache locale des fichiers basée sur les ETag dans ~/.cache/jmail/. Mettez cette valeur à False pour toujours télécharger les données les plus récentes.

Exemple

from jmail import JmailClient

# Par défaut : mise en cache activée
client = JmailClient()

# Aucune mise en cache
client = JmailClient(cache=False)

Méthodes

Méthode	Renvoie	Description
`manifest()`	`dict`	Manifeste de l’API avec métadonnées des jeux de données
`emails(slim)`	`DataFrame`	Archive d’e-mails
`documents(include_text)`	`DataFrame`	Métadonnées/texte des documents
`photos()`	`DataFrame`	Métadonnées des photos
`people()`	`DataFrame`	Personnes identifiées
`photo_faces()`	`DataFrame`	Boîtes englobantes de visages
`imessage_conversations()`	`DataFrame`	Conversations iMessage
`imessage_messages()`	`DataFrame`	Messages iMessage
`star_counts()`	`DataFrame`	Étoiles issues du crowd-sourcing
`release_batches()`	`DataFrame`	Informations sur les lots de publication
`url(dataset, fmt)`	`str`	URL brute du jeu de données

`manifest()`

Récupère le manifeste de l’API, contenant les métadonnées des jeux de données et leurs sommes de contrôle.

manifest = client.manifest()
print(manifest)

Renvoie : dict — JSON analysé à partir de data.jmail.world/v1/manifest.json

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

Retourne l’URL brute d’un fichier de jeu de données. Utile pour la passer directement à DuckDB, Polars ou à tout outil capable de lire des fichiers Parquet via HTTP.

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

requis

Nom du jeu de données. L’un parmi : emails, emails-slim, documents, photos, people, photo_faces, imessage_conversations, imessage_messages, star_counts, release_batches.

str

défaut:"parquet"

Format de fichier. parquet ou ndjson.gz.

Retourne : str — URL complète

​Constructeur

​Paramètres

​Exemple

​Méthodes

​manifest()

​url(dataset, fmt="parquet")