Premiers pas

Configuration

Configurez les hôtes locaux, les ports, les domaines destinataires et les limites de ressources.

InboxTap propose des options de ligne de commande explicites et des options de serveur programmatiques. Il ne lit pas de fichier de configuration en v1.4.1.

Valeurs par défaut

RéglageValeur par défaut
Hôte SMTPlocalhost (écoute sur 127.0.0.1 et ::1)
Port SMTP1025
Hôte de l'API HTTPlocalhost (écoute sur 127.0.0.1 et ::1)
Port de l'API HTTP8025
Domaine destinatairelocal.test
Messages conservés100
Taille maximale de message5242880 octets (5 Mio)

Options CLI

--smtp-host <host>          SMTP host
--smtp-port <port>          SMTP port, 0–65535
--api-host <host>           HTTP API host
--api-port <port>           HTTP API port, 0–65535
--domain <domain>           Test recipient domain
--max-messages <count>      Messages retained in memory
--max-message-size <bytes>  Maximum accepted SMTP message size

Le mot optionnel start est accepté, donc inboxtap et inboxtap start sont équivalents.

Plusieurs instances

Choisissez des ports distincts et, éventuellement, un domaine destinataire distinct :

inboxtap --smtp-port 2025 --api-port 9025 --domain mail.local.test

Pointez l’application vers le port SMTP 2025 et créez le client avec l’URL de base d’API correspondante :

const inboxTap = new InboxTapClient({ baseUrl: "http://localhost:9025" });

Serveur programmatique

Les tests peuvent importer le serveur et demander des ports éphémères avec 0 :

import { InboxTapServer } from "inboxtap";

const server = await new InboxTapServer({
  apiPort: 0,
  smtpPort: 0,
  maxMessages: 50,
}).start();

console.log(server.apiUrl);
await server.stop();

Les ports utilisés sont disponibles sur server.apiPort et server.smtpPort une fois l’appel à start() terminé.