erplibre/doc/EMAIL.fr.md
Mathieu Benoit 16aecc2d33 [ADD] mail: read and send email from the TODO CLI
An IMAP/SMTP client in the menu, with its tests against real servers. Most
of the work went into refusals: an application password is named only when
the server actually refuses, an accented password is reported as never
having left the machine, and a refusal is recognised by what the server
SAYS rather than by matching its wording. A malformed date no longer takes
the whole folder down, and a received email is never read as markup.

--- FR ---

Un client IMAP/SMTP dans le menu, avec ses tests contre de vrais serveurs.
L'essentiel du travail porte sur les refus : le mot de passe d'application
n'est nommé que lorsque le serveur refuse vraiment, un mot de passe accentué
est signalé comme n'ayant jamais quitté la machine, et un refus se reconnaît
à ce que le serveur DIT plutôt qu'à ses mots. Une date illisible n'emporte
plus le dossier entier, et un courriel reçu n'est jamais lu comme du balisage.

Assisted-by: Claude Opus 5
2026-08-16 03:56:34 -04:00

18 KiB

Client courriel

Un client courriel intégré au CLI TODO : plusieurs comptes, IMAP + SMTP, et un cache local — pour lire et répondre à son courriel sans quitter ./script/todo/todo.py.

Chaque chemin Courriel > ... ci-dessous est un raccourci pour TODO > [3] Assistant > [2] Courriel - Lire et envoyer du courriel > ... — le chemin complet est écrit une fois, dans « Ajouter un compte ».

Prérequis

Quatre paquets Python, déjà listés dans requirement/erplibre_require-ments.txt (l'environnement .venv.erplibre, pas un venv Odoo) :

  • cryptography — scelle le cache local en mode encrypted et ephemeral.
  • keyring — le trousseau système, l'un des deux endroits où peut vivre un mot de passe.
  • pykeepass — le coffre KDBX, l'autre endroit, celui que le client essaie en premier.
  • textual — l'interface terminal elle-même. Sans lui, « Ouvrir le client courriel (TUI) » affiche un message et ne fait rien ; le reste du menu (comptes, synchronisation, cache) fonctionne quand même.

Installez-les avec :

.venv.erplibre/bin/pip install -r requirement/erplibre_require-ments.txt

Mots de passe d'application pour Gmail, Outlook et iCloud

La phase 1 ne parle qu'IMAP/SMTP en authentification simple — pas encore OAuth (ça, c'est la phase 2). Gmail, Outlook et iCloud ont tous les trois fermé cette porte au vrai mot de passe du compte : chacun de ces trois préréglages exige donc un mot de passe d'application à la place :

Fournisseur Où le générer
Gmail Activez la validation en deux étapes, puis myaccount.google.com > Sécurité > Mots de passe des applications
Outlook / Microsoft 365 account.microsoft.com > Sécurité > Options de sécurité avancées > Mots de passe d'application
iCloud account.apple.com > Connexion et sécurité > Mots de passe spécifiques aux applications

Utilisez ce mot de passe généré quand la configuration du compte en demande un — jamais le mot de passe normal du compte. Le préréglage « Serveur standard » (IMAP/SMTP générique) n'en a pas besoin.

Ajouter un compte

Chemin de menu : TODO > [3] Assistant > [2] Courriel - Lire et envoyer du courriel > [2] Comptes > [2] Ajouter un compte.

Les questions, dans l'ordre :

  1. Nom court du compte — devient à la fois le nom de dossier sous ~/.erplibre/mail/ et la référence dans le coffre : il ne peut donc pas contenir / ni commencer par un point.
  2. Adresse courriel.
  3. Nom affiché (facultatif) — apparaît dans l'en-tête De : comme Nom affiché <email>.
  4. Fournisseur — un numéro dans la liste affichée : Gmail, Outlook, iCloud, ou « Serveur standard » (IMAP/SMTP générique).
  5. Si vous choisissez « Serveur standard », le serveur IMAP puis le serveur SMTP sont demandés ensuite ; les autres préréglages les remplissent déjà pour vous.
  6. Si le préréglage exige un mot de passe d'application, sa note s'affiche ici en rappel.
  7. Mot de passe — saisi masqué (getpass), puis rangé dans le coffre — jamais écrit dans accounts.json.

Où va le mot de passe : à l'étape du mot de passe, le client passe par le gestionnaire KDBX partagé du CLI — le même que pour la clé OpenAI et les identifiants Odoo. Il lit kdbx.path / kdbx.password dans la configuration TODO (script/todo/todo.json, surchargeable dans private/todo/todo_override.json / private/todo/todo_override_private.json). Si kdbx.path n'est pas encore réglé, une fenêtre de sélection de fichier s'ouvre pour choisir un .kdbx existant — il faut un affichage graphique, et l'annuler (ou lancer le CLI sans affichage) fait échouer la création du compte avec « le fichier kdbx n'a pas pu être ouvert » (voir Dépannage). Réglez kdbx.path (et kdbx.password, pour éviter l'invite) avant d'ajouter votre premier compte, en pointant vers un coffre .kdbx que vous avez déjà (créez-en un avec KeePassXC ou équivalent). Le trousseau système ne sert que pour un compte dont la secret_ref le désigne déjà — le menu écrit toujours les nouveaux comptes dans le coffre KDBX.

accounts.json (dans ~/.erplibre/mail/accounts.json) ne contient jamais qu'une secret_ref du genre kdbx:ERPLibre/Mail/perso — une référence, jamais le secret. Il est sans danger à lire, à éditer à la main, ou à mettre dans une sauvegarde privée.

Les trois modes de cache

Chaque compte garde un cache local — une petite base SQLite plus un fichier par message téléchargé — pour que la boîte de réception reste lisible hors ligne. Trois modes contrôlent ce que ce cache laisse sur le disque :

Mode Ce qui reste sur le disque Clé de chiffrement
clear (par défaut) ~/.erplibre/mail/<compte>/cache.db et les fichiers .eml, lisibles en clair aucune
encrypted même emplacement, mais l'expéditeur, les destinataires, le sujet, l'extrait, le Message-ID et le corps des messages sont scellés en AES-256-GCM générée une fois, rangée dans le coffre à côté du mot de passe (.../cache-key)
ephemeral sous /dev/shm/erplibre-mail-<pid>/<compte>/ (ou le dossier temporaire système si /dev/shm n'est pas inscriptible), scellé comme encrypted tirée en RAM à chaque lancement, jamais écrite nulle part, et tout le dossier est effacé à la fermeture de la session

Même en mode clear, les champs techniques dont le SQL a besoin pour trier et filtrer — UID, dossier, date, drapeaux, taille — restent toujours en clair ; seuls les champs qui identifient des personnes (et le corps du message) sont scellés, et seulement en encrypted/ephemeral.

Réglez le défaut général dans Courriel > [4] Cache > [1] Mode de cache par défaut ; c'est la préférence mail_cache_mode (défaut clear). Surchargez-le par compte dans Courriel > [4] Cache > [2] Mode de cache d'un compte — ceci écrit le champ cache_mode du compte dans accounts.json ; le laisser à null là-bas veut dire « hérite du défaut général ».

Courriel > [4] Cache > [3] Taille du cache et purge liste le mode effectif et l'espace disque de chaque compte, et peut effacer entièrement le cache d'un compte (après confirmation) — la prochaine synchronisation le reconstruit à partir de zéro.

Le TUI

Courriel > [1] Ouvrir le client courriel (TUI) ouvre un écran en trois volets : l'arbre comptes/dossiers à gauche, la liste des messages au centre, et un aperçu à droite, avec une ligne de statut en bas.

Touche Action
↑ ↓ Tab se déplacer dans un volet / changer de volet (comportement par défaut de Textual)
h ouvre la fenêtre d'aide : tous les raccourcis et quelques repères, fermée par Échap
z plein écran sur l'aperçu (masque l'arbre et la liste)
Échap quitter le plein écran
v change de disposition : colonnes, partagée, empilée
+ / - agrandir / rétrécir le volet qui a le focus
0 revenir aux tailles de volets par défaut
r synchronise le compte du dossier actuellement sélectionné (tous ses dossiers)
Shift+R synchronise tous les comptes
/ ouvre le champ de recherche (filtre seulement la liste déjà affichée — localement, sur sujet/de/à/extrait ; ne cherche pas sur le serveur)
s / u marquer le message sélectionné lu / non lu
c écrire un nouveau message
a / Shift+A répondre / répondre à tous
f transférer
w enregistrer la première pièce jointe du message dans ~/Téléchargements (créé s'il n'existe pas)
n ajouter un compte sans quitter le client
l affiche la fin de ~/.erplibre/mail.log et les erreurs de synchronisation de la session
q quitter

Ce tableau est écrit à la main et peut prendre du retard sur le code ; la fenêtre h, elle, ne le peut pas : elle construit sa liste depuis les liaisons de l'application à chaque ouverture. En cas de désaccord entre les deux, c'est elle qui a raison.

Les barres entre les volets se glissent aussi à la souris, et les tailles sont retenues par disposition.

Les indices de touches du pied d'écran, comme la fenêtre d'aide, suivent la langue choisie dans le CLI, tout comme l'arbre des comptes, la liste et le texte d'aperçu.

Écrire un message

c ouvre le formulaire : À, Cc, Objet, un champ Pièces jointes (chemins de fichiers séparés par un point-virgule — une virgule est légale dans un nom de fichier, donc seul ; sépare les entrées ; il n'y a pas de sélecteur de fichier, tapez les chemins), et un corps multi-lignes. e envoie le corps vers $EDITOR (ou nano si non défini) et le relit ; si l'éditeur manque ou sort en erreur, le texte de départ est conservé tel quel. Ctrl+S (ou le bouton Envoyer) remet le message ; Échap abandonne le brouillon — il n'y a pas d'enregistrement en brouillon.

a (répondre) et Shift+A (répondre à tous) préremplissent À/Cc/ Objet/In-Reply-To/References et citent le message d'origine dans le corps. f (transférer) préremplit l'objet en Fwd: et rattache le message d'origine automatiquement, en pièce jointe message/rfc822 ; le corps, lui, part vide — écrivez votre propre mot au-dessus du message joint.

Répondre, répondre à tous et transférer ont tous besoin du corps du message d'origine — depuis le cache, ou récupéré en direct si le compte est en ligne ; sans l'un ou l'autre, vous obtenez « Aucun message sélectionné. » / « Aucun message à transférer. ».

Envoyer exige que le compte soit en ligne (écrire hors ligne échoue avec « Compte hors ligne : envoi impossible. » — il n'y a pas de file d'attente hors ligne). Une fois envoyé, une copie est classée dans le dossier Envoyés du compte par IMAP ; si ce classement échoue, la ligne de statut le dit, mais le message est déjà parti — il n'est pas renvoyé.

Synchronisation

Une passe de synchronisation est incrémentale : seuls les UID supérieurs au dernier connu sont demandés, le corps des messages n'est jamais téléchargé pendant une passe (seulement les en-têtes), et les corps sont récupérés à la demande à l'ouverture d'un message. Les drapeaux (lu/non lu, etc.) des messages déjà connus sont revérifiés à chaque passe, donc un message lu ailleurs apparaît correctement lu ici aussi.

La synchronisation a lieu :

  • Au lancement — ouvrir le TUI déclenche une synchronisation de tous les comptes en arrière-plan.
  • À la demande — r (compte courant) / Shift+R (tous les comptes) dans le TUI, ou Courriel > [3] Synchroniser maintenant depuis le menu CLI (affiche un résumé par compte dans le terminal).
  • Automatiquement, toutes les mail_refresh_sec secondes (défaut 300 = 5 minutes ; 0 la désactive) — mais seulement tant que le TUI est ouvert. Fermez-le et la minuterie part avec lui ; rien ne se synchronise en arrière-plan ensuite.

Si le serveur annonce un UIDVALIDITY changé pour un dossier (ses UID ne veulent plus dire ce qu'ils disaient — typiquement après une migration côté serveur), le cache de ce dossier est purgé et resynchronisé à partir de zéro automatiquement ; il n'y a actuellement aucun avis à l'écran au-delà du dossier qui se vide puis se remplit à nouveau brièvement.

Où sont les fichiers

Chemin Contenu
~/.erplibre/mail/accounts.json la liste des comptes — serveurs, préréglages, mode de cache, et une référence secret_ref ; jamais un mot de passe (mode 0600)
~/.erplibre/mail/<compte>/cache.db le cache SQLite de ce compte (mode 0600, dossier parent 0700)
~/.erplibre/mail/<compte>/<dossier>/<uid>.eml (ou .eml.enc s'il est scellé) un fichier par corps de message téléchargé
/dev/shm/erplibre-mail-<pid>/<compte>/ le cache d'un compte ephemeral pendant que le processus vit ; effacé à sa sortie (un balayage au démarrage nettoie aussi ce qu'un processus tué aurait laissé)

Dépannage

Les messages d'erreur qui viennent du paquet courriel lui-même (secrets.py, store.py, crypto.py, accounts.py, smtp_send.py, imap_transport.py, imap_sync.py) passent maintenant par la couche de traduction du CLI, comme les invites de menu et les libellés du TUI : lancer le CLI en anglais les affiche en anglais. Le libellé ci-dessous est cité en français, la langue de référence de ce document ; attendez-vous au libellé anglais correspondant avec EL_LANG=en.

« Connexion échouée : ... » en ajoutant ou en testant un compte. Courriel > [2] Comptes > [5] Tester la connexion d'un compte affiche l'erreur exacte du serveur puis redemande le mot de passe — jusqu'à 3 tentatives. Le mot de passe dans le coffre n'est écrasé qu'après une connexion réussie, donc une faute de frappe ne détruit jamais un mot de passe qui fonctionnait. Si le compte est Gmail, Outlook ou iCloud, vérifiez d'abord que vous avez utilisé un mot de passe d'application (voir « Prérequis » plus haut), pas le mot de passe normal du compte. Ouvrir le TUI lui-même ne relance pas cette demande automatiquement : un compte au mot de passe refusé porte un ⚠ ; s'il avait déjà synchronisé avec succès, ses dossiers déjà en cache restent visibles et lisibles, ils cessent seulement de se rafraîchir — seul un compte tout neuf (rien de synchronisé encore) n'affiche aucun dossier du tout. Dans tous les cas, passez par « Tester la connexion d'un compte » pour corriger.

« le fichier kdbx n'a pas pu être ouvert » en ajoutant un compte. Le coffre KDBX partagé n'est pas encore configuré, sa fenêtre de sélection de fichier a été annulée, ou le CLI tourne sans affichage pour la montrer. Réglez kdbx.path (et kdbx.password) comme décrit dans « Ajouter un compte » plus haut, puis réessayez.

« le trousseau du système écrirait le mot de passe en clair (backend ...) ». Le backend actif de keyring n'est pas de ceux qu'on sait vraiment chiffrer — ça arrive en SSH, dans un conteneur, ou sur une machine sans session graphique, où keyring retombe silencieusement sur un fichier en clair. Le client refuse plutôt que de faire semblant que c'est sûr. Utilisez le coffre KDBX à la place (voir plus haut), ou lancez-le là où un vrai trousseau est déverrouillé.

« Installez textual pour le client courriel (pip). » textual n'est pas installé. Courriel > [1] Ouvrir le client courriel (TUI) affiche seulement ce message et revient au menu ; tout le reste (comptes, synchronisation, cache) fonctionne quand même sans lui.

Le cache d'un dossier signale qu'il a changé (UIDVALIDITY). Rien à faire — le client purge et resynchronise ce dossier tout seul à la prochaine synchronisation. La liste des messages se vide puis se remplit brièvement.

« cache illisible, purgez-le et resynchronisez : ... ». Le cache.db du compte est corrompu. Courriel > [4] Cache > [3] Taille du cache et purge peut lui-même échouer à ouvrir ce même fichier cassé ; le cas échéant, effacez à la main le dossier de cache du compte et resynchronisez :

rm -rf ~/.erplibre/mail/<account>/

Tester contre un vrai serveur

Presque tous les tests courriel passent par un double en mémoire. Un double ne produit que ce que son auteur avait imaginé — c'est par là que trois bugs de protocole sont arrivés jusqu'aux utilisateurs. D'où un bac à sable : un vrai serveur IMAP (Twisted) et un vrai serveur SMTP (aiosmtpd), qu'un test démarre sur un port éphémère de la boucle locale, à qui il parle en vrai TCP, et qu'il tue en terminant — qu'il réussisse ou qu'il échoue.

Le but n'est pas la conformité. Un serveur poli ne prouve pas grand-chose ; celui-ci sait se conduire mal exprès. Un test déclare les octets exacts d'un message — en-tête en 8 bits bruts, charset unknown-8bit — et peut couper la connexion ou refuser une commande en pleine synchronisation. Ajouter une nouvelle méchanceté est une petite sous-classe dans test/mail_sandbox.py, pas un nouveau serveur.

Ces tests ne tournent pas dans la boucle rapide. Sans twisted ni aiosmtpd, tout le fichier se saute visiblement. Pour les lancer volontairement :

.venv.erplibre/bin/python -m unittest discover -s test \
    -p test_mail_live_server.py -v

Ce qu'il ne couvre pas, et ne fera pas semblant de couvrir :

  • SPECIAL-USE — Twisted n'annonce que IMAP4REV1 NAMESPACE IDLE. Le bug du message classé sous un nom de dossier deviné plutôt que sous celui annoncé par le serveur reste donc hors de portée. Implémenter l'extension dans le bac à sable ne testerait que notre propre supposition à son sujet — précisément l'erreur que ce bac à sable existe pour éviter.
  • Aucune particularité de fournisseur — les dossiers-étiquettes de Gmail, OAuth chez Microsoft, les mots de passe d'application d'Apple : rien de tout cela n'est exercé. Le bac à sable est un serveur RFC 3501 ordinaire, pas la doublure d'un fournisseur précis.
  • Pas de TLS — le bac à sable parle en clair sur 127.0.0.1. Les chemins starttls et ssl ne sont pas exercés ici.
  • Rien ne quitte la machine — aucun hôte externe, aucun trousseau système, aucun ~/.erplibre, aucun identifiant réel, et jamais un port fixe.

Limites de la phase 1

  • Pas d'OAuth — Gmail, Outlook et iCloud demandent un mot de passe d'application (voir plus haut) ; OAuth arrive en phase 2.
  • Pas de statistiques — aucun compteur lu/non lu global ni tableau de bord d'activité, au-delà du compte de non-lus par dossier affiché dans l'arbre.
  • Pas de recherche côté serveur — / ne filtre que ce qui est déjà synchronisé dans le cache local.
  • Pas de file d'attente hors ligne — l'envoi exige que le compte soit en ligne ; rien ne se met en attente pour partir au retour du réseau.

Voir le spec de conception pour ce qu'apportent les phases suivantes.