Pular para o conteúdo principal

​
Construtor

JmailClient(cache=True)
Crie uma nova instância do cliente.

​
Parâmetros

​
cache
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étodoRetornoDescrição
manifest()dictManifesto da API com metadados dos conjuntos de dados
emails(slim)DataFrameArquivo de e-mails
documents(include_text)DataFrameMetadados/texto de documentos
photos()DataFrameMetadados de fotos
people()DataFramePessoas identificadas
photo_faces()DataFrameCaixas delimitadoras de rostos
imessage_conversations()DataFrameConversas de iMessage
imessage_messages()DataFrameMensagens de iMessage
star_counts()DataFrameEstrelas colaborativas (crowd-sourced)
release_batches()DataFrameInformações sobre lotes de publicação
url(dataset, fmt)strURL 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"
​
dataset
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.
​
fmt
str
padrão:"parquet"
Formato do arquivo. Pode ser parquet ou ndjson.gz.
Retorna: str — URL completa