Devenia IMAP Intake

Anslut en IMAP-inkorg till ditt WordPress-tillägg

Läs meddelanden och bilagor från en befintlig IMAP-postlåda genom ett PHP-gränssnitt. Ditt tillägg avgör när det ska läsa och vad som ska hända med resultatet.

Version 1.0.1 · GPL-2.0-or-later

Art déco-illustration av en e-postmottagare med kuvert och en bilaga.

En postlåda, en tydlig överlämning

Ditt tillägg anger server, port, mapp och inloggningsuppgifter. Devenia IMAP Intake öppnar mappen i skrivskyddat läge över en verifierad TLS-anslutning och returnerar meddelandets huvudfält, avsändaradresser och avkodade bilagor som byte. Det ursprungliga meddelandet ligger kvar i mappen och dess lässtatus bevaras.

Ditt tillägg bestämmer när anslutningen ska ske och ansvarar för åtkomstkontroll, nya försök, deduplicering och lagring. Det anger också den maximala storleken för hela meddelandet vid varje hämtning.

Läs meddelandet. Ditt tillägg tar vid.

Meddelandet ligger kvar i postlådan. Mottagaren läser det och avkodar bilagorna; ditt tillägg tillämpar sina egna regler och avgör vad som händer härnäst.

En IMAP-postlåda levererar meddelanden via Devenia IMAP Intake till ett WordPress-tillägg.

Mottagaren kopplar postlådan till din kod; den avgör inte hur meddelandet ska behandlas.

Exempel: behandla en gemensam inkorg

Tänk dig ett WordPress-tillägg som behandlar meddelanden till [email protected]. Utvecklaren ansluter tillägget till den befintliga IMAP-postlådan och anger en maximal meddelandestorlek. Mottagaren returnerar meddelanden och bilagor; det anropande tillägget kontrollerar vad som redan har behandlats och avgör hur varje del ska lagras eller hanteras.

Exemplet är illustrativt. Mottagaren är ett läsgränssnitt för utvecklare; den är inte webbmejl och skickar inte e-post via SMTP.

Använd meddelande-ID i rätt sammanhang

UID identifierar meddelanden endast inom ett visst konto, en viss mapp och ett visst UIDVALIDITY-värde. Jämför aktuellt UIDVALIDITY med det sparade värdet innan du återanvänder en markör.

UIDVALIDITY

Identifierar den aktuella UID-serien för den valda mappen.

UID

Identifierar ett meddelande inom det aktuella kontot, mappen och UID-serien.

Krav och tillgänglighet

Du behöver WordPress 6.9 eller senare, PHP 8.1 eller senare med OpenSSL och mbstring, betrodda CA-certifikat samt en IMAP-server med ett giltigt TLS-certifikat. Anslutningen stöder implicit TLS eller STARTTLS.

Ladda ned ZIP-filen ovan och testa integrationen på en stagingkopia innan du använder den med en postlåda i drift.

Öppna Tillägg → Lägg till nytt tillägg → Ladda upp tillägg i WordPress, välj ZIP-filen, installera och aktivera Devenia IMAP Intake. Anropa gränssnittet från ditt eget tillägg när de aktiva tilläggen har lästs in. Förvara postlådans inloggningsuppgifter i programmets skyddade konfiguration.

Öppna en mapp och läs ett meddelande

Exemplet använder en reserverad domän. Hämta $password från skyddad konfiguration och $saved_uid_validity från din egen applikation. Fastställ mappens UIDVALIDITY vid första användningen innan du sparar en markör. fetch() tillämpar bytegränsen på hela meddelandet före avkodning.

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', 'Kontrollera den sparade markören innan du fortsätter.' );
    }

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

Gränssnittet tillhandahåller Mailbox::open(), uid_validity(), uids(), fetch() och close(). Ett hämtat meddelande innehåller huvudfält, avsändaradresser och bilagor med deras avkodade byte.

Hantera fel i en produktionslösning, välj UID med din egen markör och kontrollera avsändare enligt dina regler. Registrera slutförandet först när efterföljande behandling har lyckats. Öppna en ny session efter en misslyckad IMAP-läsning.

Om anslutningen misslyckas, kontrollera servernamn, port, TLS-läge, inloggningsuppgifter och betrodd certifikatkedja. Om ett meddelande överskrider din bytegräns, bestäm hur applikationen ska hantera det innan du försöker igen.

Läs meddelanden med ditt WordPress-tillägg

Ladda ned tillägget, kontrollera kraven och testa anslutningen med din applikation.

Art déco-illustration av en e-postmottagare med kuvert och en bilaga.