Introduction

InboxTap est un serveur local de capture d'emails et un SDK TypeScript pour les tests automatisés. Utilisez-le lorsqu'un test Playwright, Cypress, Vitest, Jest ou Bun doit récupérer un lien de vérification, un lien magique, un lien de réinitialisation, une invitation, un code à usage unique ou une autre valeur d'un vrai email généré par l'application testée.

InboxTap s'exécute sur localhost sans Docker, accepte le message SMTP de l'application et expose le résultat capturé au test via un SDK typé ou une API HTTP. Ce n'est ni un fournisseur d'email de production, ni une boîte hébergée, ni un service de délivrabilité, ni un stockage persistant, ni une interface manuelle de prévisualisation.

Points clés

• Les messages restent sur la machine locale et ne sont jamais relayés à l'extérieur.
• Les adresses générées par le client isolent les tests parallèles sans inscription côté serveur.
• Le paquet s'exécute avec npx ou bunx et prend en charge Node 20 et les versions suivantes.
• Le stockage, la taille, les résultats et les temps d'attente ont tous des limites explicites.

Pourquoi InboxTap

Les flux d’email se situent à une frontière inconfortable des tests de bout en bout. Simuler l’expéditeur de mail masque le message que votre utilisateur recevrait, tandis qu’un service de mail hébergé ajoute des comptes, de la latence réseau et de vraies boîtes de réception à un test qui devrait être déterministe.

InboxTap garde cette frontière en local. Il accepte des destinataires arbitraires, analyse le message délivré et expose le résultat au test même qui a déclenché l’email.

Comment ça marche

1. Démarrez InboxTap en local ou aux côtés de votre processus de test.
2. Pointez l’application testée vers localhost:1025.
3. Donnez à l’application une adresse unique créée par InboxTapClient.
4. Attendez la valeur attendue via le SDK ou interrogez l’API HTTP locale.

Les messages capturés incluent l’enveloppe SMTP, les en-têtes normalisés, le texte et le HTML décodés, les liens HTTP(S) découverts, les codes uniques de 4 à 8 chiffres et la source RFC 822 brute.

Sécurité et périmètre

Par défaut, InboxTap ne lie SMTP et HTTP qu’aux adresses de bouclage (127.0.0.1 et ::1) et ne relaie jamais un message vers l’extérieur. Il est destiné au développement et aux tests automatisés, pas à la livraison de mail en production.

Le serveur v1.4.1 stocke les messages en mémoire, conserve les 100 plus récents par défaut, rejette par défaut les messages de plus de 5 Mio et plafonne les requêtes HTTP avec attente prolongée à 60 secondes. Il ne fournit ni persistance, ni boîte de réception dans le navigateur, ni gestion des pièces jointes, ni webhooks, ni authentification SMTP, ni STARTTLS.