JmailClient - Jmail Data API

Constructor

JmailClient(cache=True)

Crear una nueva instancia de cliente.

Parámetros

bool

predeterminado:"True"

Activa el almacenamiento en caché local de archivos basado en ETag en ~/.cache/jmail/. Ponlo en False para descargar siempre datos nuevos.

Ejemplo

from jmail import JmailClient

# Por defecto: almacenamiento en caché habilitado
client = JmailClient()

# Sin almacenamiento en caché
client = JmailClient(cache=False)

Métodos

Método	Devuelve	Descripción
`manifest()`	`dict`	Manifiesto de la API con metadatos del conjunto de datos
`emails(slim)`	`DataFrame`	Archivo de correos electrónicos
`documents(include_text)`	`DataFrame`	Metadatos y texto de documentos
`photos()`	`DataFrame`	Metadatos de las fotos
`people()`	`DataFrame`	Personas identificadas
`photo_faces()`	`DataFrame`	Cajas delimitadoras de rostros
`imessage_conversations()`	`DataFrame`	Conversaciones de iMessage
`imessage_messages()`	`DataFrame`	Mensajes de iMessage
`star_counts()`	`DataFrame`	Estrellas generadas por la comunidad
`release_batches()`	`DataFrame`	Información sobre los lotes de publicación
`url(dataset, fmt)`	`str`	URL sin procesar del conjunto de datos

`manifest()`

Obtén el manifiesto de la API con los metadatos de los datasets y sus sumas de verificación.

manifest = client.manifest()
print(manifest)

Devuelve: dict — JSON parseado de data.jmail.world/v1/manifest.json

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

Obtén la URL directa del archivo del conjunto de datos. Útil para pasarla directamente a DuckDB, Polars o cualquier herramienta que lea Parquet sobre 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

requerido

Nombre del conjunto de datos. Uno de los siguientes: emails, emails-slim, documents, photos, people, photo_faces, imessage_conversations, imessage_messages, star_counts, release_batches.

str

predeterminado:"parquet"

Formato de archivo. Puede ser parquet o ndjson.gz.

Devuelve: str — URL completa

​Constructor

​Parámetros

​Ejemplo

​Métodos

​manifest()

​url(dataset, fmt="parquet")