> ## 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

> Constructeur et configuration de JmailClient

## Constructeur

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

Crée une nouvelle instance du client.

### Paramètres

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

Active la mise en cache locale des fichiers basée sur les ETag dans `~/.cache/jmail/`. Mettez cette valeur à `False` pour toujours télécharger les données les plus récentes.

### Exemple

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

# Par défaut : mise en cache activée
client = JmailClient()

# Aucune mise en cache
client = JmailClient(cache=False)
```

## Méthodes

| Méthode | Renvoie | Description |
| - | - | - |
| [`manifest()`](https://jmail.world/docs/fr/api-reference/jmail-client#manifest) | `dict` | Manifeste de l’API avec métadonnées des jeux de données |
| [`emails(slim)`](https://jmail.world/docs/fr/api-reference/emails) | `DataFrame` | Archive d’e-mails |
| [`documents(include_text)`](https://jmail.world/docs/fr/api-reference/documents) | `DataFrame` | Métadonnées/texte des documents |
| [`photos()`](https://jmail.world/docs/fr/api-reference/photos) | `DataFrame` | Métadonnées des photos |
| [`people()`](https://jmail.world/docs/fr/api-reference/people) | `DataFrame` | Personnes identifiées |
| [`photo_faces()`](https://jmail.world/docs/fr/api-reference/photo-faces) | `DataFrame` | Boîtes englobantes de visages |
| [`imessage_conversations()`](https://jmail.world/docs/fr/api-reference/imessages) | `DataFrame` | Conversations iMessage |
| [`imessage_messages()`](https://jmail.world/docs/fr/api-reference/imessages) | `DataFrame` | Messages iMessage |
| [`star_counts()`](https://jmail.world/docs/fr/api-reference/star-counts) | `DataFrame` | Étoiles issues du crowd-sourcing |
| [`release_batches()`](https://jmail.world/docs/fr/api-reference/release-batches) | `DataFrame` | Informations sur les lots de publication |
| [`url(dataset, fmt)`](https://jmail.world/docs/fr/api-reference/jmail-client#url) | `str` | URL brute du jeu de données |

## `manifest()`

Récupère le manifeste de l’API, contenant les métadonnées des jeux de données et leurs sommes de contrôle.

```python theme={null}
manifest = client.manifest()
print(manifest)
```

**Renvoie :** `dict` -- JSON analysé à partir de `data.jmail.world/v1/manifest.json`

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

Retourne l’URL brute d’un fichier de jeu de données. Utile pour la passer directement à DuckDB, Polars ou à tout outil capable de lire des fichiers 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*

Nom du jeu de données. L'un parmi : `emails`, `emails-slim`, `documents`, `photos`, `people`, `photo_faces`, `imessage_conversations`, `imessage_messages`, `star_counts`, `release_batches`.

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

Format de fichier. `parquet` ou `ndjson.gz`.

**Retourne :** `str` -- URL complète


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