phil/bounce-parser

phil/bounce-parser lit un message reçu dans une boîte de rebonds et dit ce qu'il est : une notification d'état de remise (RFC 3464, et RFC 6533 pour les adresses internationales), un rapport de plainte pour abus (RFC 5965), un rebond écrit en texte par un serveur qui n'envoie pas de notification, ou une réponse automatique (RFC 3834). Il en tire chaque destinataire, le code d'état étendu (RFC 3463), le genre de rebond — dur, temporaire, plainte, réponse automatique, succès —, l'action pour l'application, et le message dont il parle, par son Message-ID, son Feedback-ID, un champ propre à l'application ou l'étiquette d'un chemin de retour VERP. Des règles que l'application déclare, dans leur ordre, décident de ce qu'aucune norme ne décrit.

Il s'adresse à toute application PHP qui envoie du courriel par son propre serveur SMTP et lit les rebonds dans une boîte de courriel : une infolettre, les notifications d'un site, une liste de diffusion. Il transforme la boîte de rebonds en compteurs de rebonds durs et temporaires, en désabonnements sur plainte, et en une courte file de messages à faire lire par une personne.

C'est une bibliothèque PHP simple dont les prérequis sont ext-ctype, ext-iconv, ext-mbstring et ext-sodium. Son lecteur MIME ne lève jamais d'exception, quoi que contienne le message, et borne son travail : octets lus, profondeur, parties, champs d'en-tête et texte. Un rapport de plainte ne désabonne que lorsqu'un authentificateur s'en porte garant.

La conception : Mime\MimeParser lit le message en Mime\Part ; BounceParser reconnaît le rapport et retourne un BounceReport — ReportFormat, BounceKind, BounceAction, les Recipient avec leur StatusCode, le FeedbackReport, l'OriginalMessage —, puis essaie les Rule\Rules ; Verp écrit et lit les chemins de retour ; Contract\ReportAuthenticator se porte garant des rapports de plainte.

État

Documentation

Démarrage rapide

composer require phil/bounce-parser

use Phil\BounceParser\Auth\AuthenticationResults;
use Phil\BounceParser\BounceAction;
use Phil\BounceParser\BounceKind;
use Phil\BounceParser\BounceParser;
use Phil\BounceParser\Rule\Field;
use Phil\BounceParser\Rule\Rule;
use Phil\BounceParser\Rule\Rules;
use Phil\BounceParser\Verp;

$verp = new Verp('bounces', 'mail.example.net');
// Each message is sent with its own return path: $verp->encode($messageId).

$parser = new BounceParser(
    rules: new Rules(Rule::containing('quota', Field::Body, 'over quota', BounceKind::Soft)),
    verp: $verp,
    authenticator: new AuthenticationResults(['mail.example.net'], ['fbl.example.com']),
);

$report = $parser->parse($rawMessage);

$report->kind;            // BounceKind::Hard
$report->action;          // BounceAction::CountHard
$report->addresses();     // ['ada@example.org']
$report->verpTag;         // the identifier the message was sent with
$report->recipients[0]->status?->toString(); // '5.1.1'

Prérequis

PHP 8.5 ou plus récent, ext-ctype, ext-iconv, ext-mbstring et ext-sodium.

Contribuer

Les contributions sont les bienvenues sur le monodépôt PHIL : lisez le guide de contribution et le code de conduite. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. Voir LICENSE.