Connecteur e-mail

English · Type : procédure + référence · Public : administrateur · Contexte : Reality Bridge · Statut : prête · S'applique depuis : 4.2.5

Les connecteurs (email, Telnet, SSH, Open Badges) · contrat : expérimental · vérifié par la CI (matrice de support de la 4.4.0, 2026-10-23) : Node 22 sous Ubuntu (Telnet et SSH pas sous Windows) · vérifications automatiques : jobs connectors, connector-archive-e2e ; plan de CI reality ; 3 fichiers de tests · passes humaines : connectors-real-security pas faite (#79) · limites connues : aucune listée sur cette page

Le connecteur e-mail transforme une lettre en signal : un joueur répond au jeu par e-mail, et les mots de sa réponse proposent le signal que le jeu leur associe. Il lit les messages depuis le webhook signé d’un fournisseur ou depuis une boîte qu’il relève en IMAP, et n’envoie aucune réponse. Il est expérimental, comme tous les connecteurs (Vue d’ensemble des connecteurs).

Ce que vous obtenez

Un processus quest-n-click-connector email qui lie un joueur par un code d’appairage envoyé en sujet d’un e-mail, puis propose letter.door (ou le signal que le jeu déclare) pour chaque message dont les mots correspondent à une réponse, une fois par message : un message livré deux fois fait un seul signal.

Contexte et versions

• Un connecteur à côté d’un Bridge en marche, depuis la 4.1.9 ; cette page s’applique à partir de la 4.2.5 (le nom quest-n-click-connector).
• Vérifié sur : le mode webhook, comme dans les étapes ci-dessous, a été lancé le 23 octobre 2026 contre un Bridge local du jeu signals (macOS, Node 22.14, moteur 4.4.0) : une lettre d’appairage 202 {"status":"paired"}, une réponse 202 {"status":"accepted"}, la même réponse de nouveau 200 {"status":"duplicate"}. Le mode IMAP n’a pas été rejoué pour cette page ; la CI joue les deux modes depuis l’archive de la release (npm run connector-archive-e2e), contre un petit serveur IMAP à elle, jamais un vrai fournisseur.

Prérequis

• Un Bridge en marche (Installer et lancer le Bridge), et un jeu dont reality.connectors.email déclare ses réponses (Signaux et manifeste) :

  connectors: { email: { answers: [{ words: ['open', 'door'], signal: 'letter.door' }], otherwise: 'letter.unclear' } }
  

• Pour le mode webhook : un fournisseur (ou un petit adaptateur devant lui) capable de poster le message brut, signé comme plus bas. Pour le mode IMAP : une boîte joignable en TLS, et son mot de passe dans un fichier.

Où lancer les commandes

grant là où est le dossier du Bridge ; le connecteur sur la machine qui reçoit le webhook ou atteint la boîte, dans un dossier qui contient sa configuration, son jeton et son secret (mode 600). npm run connector -- email … dans le dépôt du moteur, npx quest-n-click-connector email … avec le paquet quest-n-click-connectors.

Étapes

1. Donnez au connecteur son jeton, pour les signaux e-mail seulement, avec l’appairage :

   # dans le dépôt du moteur (le dossier du Bridge est .cache/bridge)
   npm run bridge -- grant --connector=gate-mail --source=email --signals=letter.door,letter.unclear --pair > email.token
   

2. Écrivez le secret partagé du webhook dans un fichier (ou, pour IMAP, le mot de passe de la boîte) :

   # dans le dossier du connecteur
   node -e 'process.stdout.write(require("node:crypto").randomBytes(32).toString("hex"))' > webhook.secret
   chmod 600 webhook.secret
   

3. Écrivez sa configuration, email.json. Le mode webhook :

   {
     "bridge": { "url": "http://127.0.0.1:8787/", "tokenFile": "email.token" },
     "gameId": "signals",
     "health": { "port": 9302 },
     "email": { "mode": "webhook", "domain": "game.example.org", "webhook": { "port": 8789, "secretFile": "webhook.secret" } }
   }
   

   Ou le mode IMAP :

   {
     "bridge": { "url": "http://127.0.0.1:8787/", "tokenFile": "email.token" },
     "gameId": "signals",
     "email": { "mode": "imap", "imap": { "host": "imap.example.org", "user": "gate@example.org", "passwordFile": "imap.password", "pollS": 60 } }
   }
   

4. Lancez-le :

   # dans le dépôt du moteur
   npm run connector -- email --config email.json
   

   Il journalise {"event":"email.started","connector":"email","mode":"webhook"}.

5. Essayez le webhook avec un envoi signé. La signature est sha256= suivi du HMAC-SHA256, sous le secret, de <horodatage>.<message brut> ; l’horodatage est en secondes Unix, à moins de cinq minutes de l’horloge du connecteur :

   # dans le dossier du connecteur, answer.eml contenant un message brut (en-têtes, une ligne vide, le texte)
   node -e '
   const { createHmac } = require("node:crypto");
   const { readFileSync } = require("node:fs");
   const body = readFileSync(process.argv[1]);
   const secret = readFileSync("webhook.secret", "utf8").trim();
   const t = Math.floor(Date.now() / 1000);
   const signature = "sha256=" + createHmac("sha256", secret).update(`${t}.`).update(body).digest("hex");
   fetch("http://127.0.0.1:8789/v1/inbound", { method: "POST", body,
     headers: { "X-Web-Scumm-Timestamp": String(t), "X-Web-Scumm-Signature": signature } })
     .then(async (r) => console.log(r.status, await r.text()));
   ' answer.eml
   

   Un message dont le sujet est PAIR ABCD2345 (le code que montre le jeu) lie son expéditeur : 202 {"status":"paired"}. Un message suivant du même expéditeur qui dit « open the door » : 202 {"status":"accepted"}. Le même message de nouveau : 200 {"status":"duplicate"}.

Résultat attendu, et comment le vérifier

• GET http://127.0.0.1:9302/health répond 200 {"connector":"email","ok":true,"detail":"webhook on port 8789",…} (ou "mailbox polled") ; GET /metrics compte les propositions, acceptations, doublons, refus et entrées rejetées.
• Le Bridge journalise "event":"pairing.confirmed", puis "event":"signal.accepted" avec le signal.

Erreurs fréquentes

Fichiers ou données modifiés

• Mode webhook : rien d’écrit ; le message est lu en mémoire puis abandonné.
• Mode IMAP : des drapeaux dans la boîte. Avec keepDays: 0 (par défaut), un message est supprimé dès que son signal est accepté (ou trouvé déjà accepté) ; avec keepDays: N, au bout de N jours. Un message refusé pour de bon est signalé (\Flagged) et gardé pour l’opérateur. Un message refusé pour une raison passagère (le Bridge absent ou occupé, un quota) reste non lu et est relu au relevé suivant.

Garantie · bridge-email-unseen-when-away · référencée · exécutée sur aff6caab7514 · portée vérifiée par son auteur (IA), pas relue Un message dont le signal n’a pas pu atteindre le Bridge (Bridge absent) reste non lu et est relu par un relevé suivant ; un message refusé pour de bon est signalé.

Reprise ou retour en arrière

Arrêtez le processus (SIGTERM). Révoquez son jeton sur le Bridge (revoke --token=<id de révocation>) s’il a fuité, et donnez-en un nouveau. Rien dans le jeu ne dépend du connecteur : un jeu où letter.door est facultatif continue sans lui.

Référence de la configuration

La section email :

Comment un message est lu

• Dans un thread de travail avec un tas de 64 Mo et 2 secondes ; 256 Ko au plus, 3 niveaux de multipart, 64 parties, 200 en-têtes ; le HTML devient du texte inerte ; un message avec pièce jointe est refusé ; un message sans Message-ID est refusé.
• Le joueur est l’étiquette du destinataire (gate+p-…@<domaine>, avec domain défini) ou l’expéditeur qui a envoyé un code d’appairage (sujet PAIR ABCD2345, LINK …, CODE … ou le code seul).
• La première réponse dont tous les mots figurent dans le sujet ou le texte (mots entiers, casse indifférente) propose son signal, sinon otherwise.
• La clé est sha256('email:' + Message-ID) : un message livré deux fois fait un seul signal. La charge est une empreinte du Message-ID et du numéro de la réponse, empreinte reprise en evidenceHash.
• Aucune réponse n’est envoyée.

Ce qu’il garde

• Mode webhook : rien ; le message est lu en mémoire puis abandonné.
• Mode IMAP : le message reste dans la boîte de l’opérateur, là où il est arrivé, jusqu’à ce que keepDays le supprime ; un message refusé reste signalé jusqu’à ce que l’opérateur le supprime.
• Un expéditeur qui a envoyé un code d’appairage est retenu sous la forme d’un SHA-256 salé de son adresse (le sel est aléatoire et vit aussi longtemps que le processus) associé au playerId, en mémoire, pendant linkDays ; un redémarrage l’oublie.
• L’adresse, le sujet et le texte ne sont jamais journalisés ni envoyés au Bridge.

Références

• Le code : connectors/src/email/connector.ts, imap.ts, mime.ts.
• Le modèle de menace : docs/dev/threat-models/email.md.
• Testé par tests/connectors-email.test.ts.

Modifier la source de cette page · Signaler une erreur