Devenia IMAP Intake

Reliez une boîte IMAP à votre extension WordPress

Lisez les messages et les pièces jointes d’une boîte IMAP existante grâce à une interface PHP. Votre extension décide quand lire et que faire du résultat.

Version 1.0.1 · GPL-2.0-or-later

Illustration Art déco d’un récepteur de courriels avec des enveloppes et une pièce jointe.

Une boîte, une transmission claire

Votre extension fournit le serveur, le port, le dossier et les identifiants. Devenia IMAP Intake ouvre le dossier en lecture seule sur une connexion TLS vérifiée et renvoie les en-têtes, les adresses des expéditeurs et les octets décodés des pièces jointes. Le message d’origine reste dans le dossier et son état de lecture est conservé.

Votre extension décide quand se connecter et prend en charge le contrôle d’accès, les nouvelles tentatives, la déduplication et le stockage. Elle fixe également la taille maximale du message complet pour chaque récupération.

Lisez le message. Votre extension prend le relais.

Le message reste dans la boîte. Le récepteur le lit et décode ses pièces jointes ; votre extension applique ses propres règles et décide de la suite.

Une boîte IMAP transmet des messages à une extension WordPress par Devenia IMAP Intake.

Le récepteur relie la boîte à votre code ; il ne décide pas du traitement du message.

Exemple : traiter une boîte partagée

Imaginez une extension WordPress qui traite les messages envoyés à [email protected]. La personne qui développe l’extension la relie à la boîte IMAP existante et définit une taille maximale de message. Le récepteur renvoie les messages et les pièces jointes ; l’extension appelante vérifie ce qui a déjà été traité et décide comment stocker ou traiter chaque élément.

Cet exemple est illustratif. Le récepteur est une interface de lecture destinée aux développeurs ; il ne s’agit pas d’un webmail et il n’envoie pas de courriel par SMTP.

Utilisez les identifiants dans leur contexte

Les UID identifient les messages uniquement dans le contexte d’un compte, d’un dossier et d’une valeur UIDVALIDITY donnés. Comparez la valeur UIDVALIDITY actuelle à celle que vous avez enregistrée avant de réutiliser un curseur.

UIDVALIDITY

Identifie la série d’UID actuelle du dossier sélectionné.

UID

Identifie un message dans ce compte, ce dossier et cette série d’UID.

Configuration requise et disponibilité

Il vous faut WordPress 6.9 ou une version ultérieure, PHP 8.1 ou une version ultérieure avec OpenSSL et mbstring, des certificats d’autorité de confiance et un serveur IMAP doté d’un certificat TLS valide. La connexion prend en charge TLS implicite ou STARTTLS.

Téléchargez le fichier ZIP ci-dessus, puis testez l’intégration sur une copie de préproduction avant de l’utiliser avec une boîte en service.

Dans WordPress, ouvrez Extensions → Ajouter une extension → Téléverser une extension, choisissez le ZIP, installez et activez Devenia IMAP Intake. Appelez l’interface depuis votre propre extension après le chargement des extensions actives. Conservez les identifiants de la boîte dans la configuration protégée de votre application.

Ouvrir un dossier et lire un message

Cet exemple utilise un domaine réservé. Fournissez $password depuis une configuration protégée et $saved_uid_validity depuis votre application. À la première utilisation, déterminez l’UIDVALIDITY du dossier avant d’enregistrer un curseur. fetch() applique la limite en octets au message entier avant son décodage.

use Devenia\ImapIntake\Mailbox;

$mailbox = Mailbox::open( array(
    'host'       => 'imap.example.com',
    'port'       => 993,
    'username'   => '[email protected]',
    'password'   => $password,
    'folder'     => 'INBOX',
    'encryption' => 'ssl',
    'timeout'    => 15,
) );

if ( is_wp_error( $mailbox ) ) {
    return $mailbox;
}

try {
    $validity = $mailbox->uid_validity();
    $uids = $mailbox->uids();
    if ( is_wp_error( $uids ) ) {
        return $uids;
    }

    if ( $validity !== $saved_uid_validity ) {
        return new WP_Error( 'mailbox_changed', 'Vérifiez le curseur enregistré avant de continuer.' );
    }

    if ( $uids ) {
        $message = $mailbox->fetch( $uids[0], wp_max_upload_size() );
        if ( is_wp_error( $message ) ) {
            return $message;
        }
    }
} finally {
    $mailbox->close();
}

L’interface fournit Mailbox::open(), uid_validity(), uids(), fetch() et close(). Un message récupéré comprend les en-têtes, les adresses des expéditeurs et les pièces jointes avec leurs octets décodés.

Dans un traitement en production, gérez les erreurs, choisissez l’UID à l’aide de votre propre curseur et vérifiez les expéditeurs selon vos règles. Ne marquez le traitement comme terminé qu’après la réussite des étapes suivantes. Ouvrez une nouvelle session après une lecture IMAP ayant échoué.

Si la connexion échoue, vérifiez le nom du serveur, le port, le mode TLS, les identifiants et la chaîne de certificats de confiance. Si un message dépasse votre limite en octets, décidez comment votre application doit le traiter avant une nouvelle tentative.

Lisez les messages avec votre extension WordPress

Téléchargez l’extension, vérifiez la configuration requise et testez la connexion avec votre application.

Illustration Art déco d’un récepteur de courriels avec des enveloppes et une pièce jointe.