Documentation de l'API REST

GET/api/email/{domain}/{user}/

Obtenez une liste paginée des e-mails d'un utilisateur. Les réponses de liste contiennent uniquement des métadonnées (non body / html_body).

Paramètre	Emplacement	Description
domain	chemin	Domaine de messagerie, par ex. example.com
user	chemin	Nom d'utilisateur, par ex. testuser
page	requête, facultatif	Numéro de page (par défaut 1)
limit	requête, facultatif	Éléments par page (20 par défaut, 100 maximum)

curl -X GET "https://BASE_URL/api/email/example.com/testuser/?page=1&limit=20"

{
  "emails": [
    {
      "id": 123,
      "subject": "Welcome",
      "sender": "[email protected]",
      "date": "2026-09-30T10:30:00.000Z",
      "has_attachments": false,
      "size": 1234
    }
  ],
  "total": 5,
  "page": 1,
  "limit": 20,
  "has_more": false
}

GET/api/email/{domain}/{user}/{email_id}

Obtenez tous les détails d’un e-mail.

curl -X GET "https://BASE_URL/api/email/example.com/testuser/123"

DELETE/api/email/{domain}/{user}/{email_id}

Supprimez un e-mail spécifique.

curl -X DELETE "https://BASE_URL/api/email/example.com/testuser/123"

{ "status": "deleted" }

POST/api/add-domain/{domain}

Ajoutez un nouveau domaine ou mettez à jour le statut en ligne d'un domaine existant. Le domaine doit avoir un enregistrement MX pointant vers le nom d'hôte du système pour être accepté (statut added, is_online: true).

curl -X POST "https://BASE_URL/api/add-domain/newdomain.com"

// Ajouté avec succès
{ "status": "added", "domain": "newdomain.com", "is_online": true }

// Domaine existant : mettre à jour son statut
{ "status": "updated", "domain": "newdomain.com", "is_online": false }

GET/api/all-domains/ & /api/random-domains/

Tous les domaines en ligne (privés, jeton requis) :

curl -X GET "https://BASE_URL/api/all-domains/" \
  -H "X-Domain-Token: YOUR_TOKEN"

Domaines en ligne aléatoires (publics) :

curl -X GET "https://BASE_URL/api/random-domains/?limit=10"

{ "domains": ["domain1.com", "domain2.com"], "total": 2 }

GET/api/check-mx/{domain}

Vérifiez si un domaine possède un enregistrement MX valide pointant vers le système.

curl -X GET "https://BASE_URL/api/check-mx/example.com"

{ "result": "online" }   // ou "offline"

Gestion des erreurs

Code	Signification
200	Succès
400	Demande invalide (par exemple, domaine/e-mail mal formé)
401	Jeton manquant ou invalide pour un point de terminaison privé
404	E-mail introuvable
429	Limite de débit dépassée

{ "detail": "Domain not found" }

Remarques importantes

• Les adresses e-mail doivent utiliser le format [email protected]
• Seuls les domaines avec des enregistrements MX valides ont le statut « en ligne »
• Les e-mails et les domaines inactifs sont automatiquement supprimés après 3 jours
• Le service uniquement reçoit email — l'envoi et le relais SMTP ne sont pas pris en charge
• L'API applique des limites de débit par IP
• La période de conservation de 3 jours s'applique au service en direct ; les sauvegardes peuvent conserver les copies plus longtemps. La suppression définitive de toutes les copies n’est pas garantie à ce moment-là.
• Les boîtes de réception de domaines personnalisés restent publiques et peuvent être bloquées par des services tiers. L'acceptation et la livraison ne sont pas garanties.