> ## Documentation Index
> Fetch the complete documentation index at: https://jmail.world/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# JmailClient

> Construtor e configuração do JmailClient

## Construtor

```python theme={null}
JmailClient(cache=True)
```

Crie uma nova instância do cliente.

### Parâmetros

**cache** `bool` (default: True)

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

### Exemplo

```python theme={null}
from jmail import JmailClient

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

# No caching
client = JmailClient(cache=False)
```

## Métodos

| Método | Retorno | Descrição |
| - | - | - |
| [`manifest()`](https://jmail.world/docs/pt-BR/api-reference/jmail-client#manifest) | `dict` | Manifesto da API com metadados dos conjuntos de dados |
| [`emails(slim)`](https://jmail.world/docs/pt-BR/api-reference/emails) | `DataFrame` | Arquivo de e-mails |
| [`documents(include_text)`](https://jmail.world/docs/pt-BR/api-reference/documents) | `DataFrame` | Metadados/texto de documentos |
| [`photos()`](https://jmail.world/docs/pt-BR/api-reference/photos) | `DataFrame` | Metadados de fotos |
| [`people()`](https://jmail.world/docs/pt-BR/api-reference/people) | `DataFrame` | Pessoas identificadas |
| [`photo_faces()`](https://jmail.world/docs/pt-BR/api-reference/photo-faces) | `DataFrame` | Caixas delimitadoras de rostos |
| [`imessage_conversations()`](https://jmail.world/docs/pt-BR/api-reference/imessages) | `DataFrame` | Conversas de iMessage |
| [`imessage_messages()`](https://jmail.world/docs/pt-BR/api-reference/imessages) | `DataFrame` | Mensagens de iMessage |
| [`star_counts()`](https://jmail.world/docs/pt-BR/api-reference/star-counts) | `DataFrame` | Estrelas colaborativas (crowd-sourced) |
| [`release_batches()`](https://jmail.world/docs/pt-BR/api-reference/release-batches) | `DataFrame` | Informações sobre lotes de publicação |
| [`url(dataset, fmt)`](https://jmail.world/docs/pt-BR/api-reference/jmail-client#url) | `str` | URL bruta do conjunto de dados |

## `manifest()`

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

```python theme={null}
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.

```python theme={null}
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` *required*

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

**fmt** `str` (default: parquet)

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

**Retorna:** `str` -- URL completa


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.