JmailClient - Jmail Data API

Construtor

JmailClient(cache=True)

Crie uma nova instância do cliente.

Parâmetros

bool

padrão:"True"

Ativa o cache local de arquivos baseado em ETag em ~/.cache/jmail/. Defina como False para sempre baixar dados atualizados.

Exemplo

from jmail import JmailClient

# Padrão: cache ativado
client = JmailClient()

# No caching
client = JmailClient(cache=False)

Métodos

Método	Retorno	Descrição
`manifest()`	`dict`	Manifesto da API com metadados dos conjuntos de dados
`emails(slim)`	`DataFrame`	Arquivo de e-mails
`documents(include_text)`	`DataFrame`	Metadados/texto de documentos
`photos()`	`DataFrame`	Metadados de fotos
`people()`	`DataFrame`	Pessoas identificadas
`photo_faces()`	`DataFrame`	Caixas delimitadoras de rostos
`imessage_conversations()`	`DataFrame`	Conversas de iMessage
`imessage_messages()`	`DataFrame`	Mensagens de iMessage
`star_counts()`	`DataFrame`	Estrelas colaborativas (crowd-sourced)
`release_batches()`	`DataFrame`	Informações sobre lotes de publicação
`url(dataset, fmt)`	`str`	URL bruta do conjunto de dados

`manifest()`

Obtenha o manifesto da API com metadados dos conjuntos de dados e checksums.

manifest = client.manifest()
print(manifest)

Retorna: dict — JSON interpretado de data.jmail.world/v1/manifest.json

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

Obtenha a URL direta de um arquivo de conjunto de dados. Útil para passar diretamente ao DuckDB, Polars ou qualquer ferramenta que leia 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

obrigatório

Nome do dataset. Um dos seguintes: emails, emails-slim, documents, photos, people, photo_faces, imessage_conversations, imessage_messages, star_counts, release_batches.

str

padrão:"parquet"

Formato do arquivo. Pode ser parquet ou ndjson.gz.

Retorna: str — URL completa

​Construtor

​Parâmetros

​Exemplo

​Métodos

​manifest()

​url(dataset, fmt="parquet")