Addresses

Endpoints pour gérer les adresses email temporaires

Liste des adresses

Récupère la liste de vos adresses temporaires.

GET /api/v1/addresses

Scope requis : emails:read

Paramètres de requête

Paramètre	Type	Description
limit	number	Nombre de résultats (défaut: 20, max: 100)
offset	number	Décalage pour la pagination
status	string	Filtrer par statut : active, expired

Exemple

curl -X GET "https://api.junkmail.dev/api/v1/addresses?limit=10" \
  -H "Authorization: Bearer jm_live_xxxx"

Réponse

{
  "success": true,
  "data": {
    "addresses": [
      {
        "id": "addr_123abc",
        "email": "test@junkmail.dev",
        "alias": "test",
        "createdAt": "2024-01-15T10:00:00Z",
        "expiresAt": "2024-01-22T10:00:00Z",
        "emailCount": 5
      }
    ],
    "total": 1,
    "hasMore": false
  }
}

---

Créer une adresse

Crée une nouvelle adresse email temporaire.

POST /api/v1/addresses

Scope requis : emails:write

Corps de la requête

Champ	Type	Requis	Description
alias	string	Non	Alias personnalisé (3-30 caractères)
expiresIn	number	Non	Durée de vie en heures (défaut: selon plan)
domain	string	Non	Domaine personnalisé (si configuré)

Exemple

curl -X POST https://api.junkmail.dev/api/v1/addresses \
  -H "Authorization: Bearer jm_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "alias": "newsletter",
    "expiresIn": 168
  }'

Réponse

{
  "success": true,
  "data": {
    "id": "addr_456def",
    "email": "newsletter@junkmail.dev",
    "alias": "newsletter",
    "createdAt": "2024-01-15T10:00:00Z",
    "expiresAt": "2024-01-22T10:00:00Z"
  }
}

---

Récupérer une adresse

Récupère les détails d'une adresse spécifique.

GET /api/v1/addresses/:id

Scope requis : emails:read

Exemple

curl -X GET https://api.junkmail.dev/api/v1/addresses/addr_123abc \
  -H "Authorization: Bearer jm_live_xxxx"

Réponse

{
  "success": true,
  "data": {
    "id": "addr_123abc",
    "email": "test@junkmail.dev",
    "alias": "test",
    "createdAt": "2024-01-15T10:00:00Z",
    "expiresAt": "2024-01-22T10:00:00Z",
    "emailCount": 5,
    "lastEmailAt": "2024-01-16T14:30:00Z"
  }
}

---

Supprimer une adresse

Supprime une adresse et tous les emails associés.

DELETE /api/v1/addresses/:id

Scope requis : emails:write

Exemple

curl -X DELETE https://api.junkmail.dev/api/v1/addresses/addr_123abc \
  -H "Authorization: Bearer jm_live_xxxx"

Réponse

{
  "success": true,
  "data": {
    "deleted": true,
    "id": "addr_123abc"
  }
}