Vai al contenuto principale

​
Costruttore

JmailClient(cache=True)
Crea una nuova istanza del client.

​
Parametri

​
cache
bool
predefinito:"True"
Abilita la memorizzazione nella cache locale dei file tramite ETag in ~/.cache/jmail/. Imposta a False per scaricare sempre dati nuovi.

​
Esempio

from jmail import JmailClient

# Predefinito: cache abilitata
client = JmailClient()

# Nessuna cache
client = JmailClient(cache=False)

​
Metodi

MethodReturnsDescription
manifest()dictManifest dell’API con metadati del dataset
emails(slim)DataFrameArchivio di email
documents(include_text)DataFrameMetadati e testo dei documenti
photos()DataFrameMetadati delle foto
people()DataFramePersone identificate
photo_faces()DataFrameRiquadri di delimitazione dei volti
imessage_conversations()DataFrameConversazioni iMessage
imessage_messages()DataFrameMessaggi iMessage
star_counts()DataFrameConteggi delle stelle crowd-sourced
release_batches()DataFrameInformazioni sui lotti di rilascio
url(dataset, fmt)strURL grezzo del dataset

​
manifest()

Recupera il manifest dell’API con i metadati dei dataset e i relativi checksum. 
manifest = client.manifest()
print(manifest)
Restituisce: dict — JSON analizzato proveniente da data.jmail.world/v1/manifest.json

​
url(dataset, fmt="parquet")

Recupera l’URL diretto del file del dataset. Utile da passare direttamente a DuckDB, Polars o a qualsiasi strumento che legga file Parquet tramite 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"
​
dataset
str
obbligatorio
Nome del dataset. Uno dei seguenti: emails, emails-slim, documents, photos, people, photo_faces, imessage_conversations, imessage_messages, star_counts, release_batches.
​
fmt
str
predefinito:"parquet"
Formato del file. Può essere parquet oppure ndjson.gz.
Restituisce: str — URL completo