Devenia IMAP Intake

Forbind en IMAP-indbakke med dit WordPress-plugin

Læs beskeder og vedhæftede filer fra en eksisterende IMAP-postkasse gennem en PHP-grænseflade. Dit plugin bestemmer, hvornår det læser, og hvad der skal ske med resultatet.

Version 1.0.1 · GPL-2.0-or-later

Art deco-illustration af en e-mailmodtager med kuverter og en vedhæftet fil.

Én postkasse, én tydelig overdragelse

Dit plugin angiver server, port, mappe og loginoplysninger. Devenia IMAP Intake åbner mappen i skrivebeskyttet tilstand over en verificeret TLS-forbindelse og returnerer beskedens headerfelter, afsenderadresser og afkodede vedhæftede filer som bytes. Den oprindelige besked bliver i mappen, og dens læsestatus bevares.

Dit plugin bestemmer, hvornår forbindelsen oprettes, og er ansvarligt for adgangskontrol, nye forsøg, deduplikering og lagring. Det fastsætter også den maksimale størrelse for hele beskeden ved hver hentning.

Læs beskeden. Dit plugin tager over.

Beskeden bliver i postkassen. Modtageren læser den og afkoder de vedhæftede filer; dit plugin anvender sine egne regler og bestemmer, hvad der sker bagefter.

En IMAP-postkasse leverer beskeder via Devenia IMAP Intake til et WordPress-plugin.

Modtageren forbinder postkassen med din kode; den bestemmer ikke, hvordan beskeden behandles.

Eksempel: behandl en fælles indbakke

Forestil dig et WordPress-plugin, der behandler beskeder sendt til [email protected]. Udvikleren forbinder det til den eksisterende IMAP-postkasse og fastsætter en maksimal beskedstørrelse. Modtageren returnerer beskeder og vedhæftede filer; det kaldende plugin kontrollerer, hvad der allerede er behandlet, og bestemmer, hvordan hver del lagres eller behandles.

Eksemplet er illustrativt. Modtageren er en læsegrænseflade for udviklere; den er ikke webmail og sender ikke e-mail via SMTP.

Brug besked-id’er i den rette sammenhæng

UID’er identificerer kun beskeder inden for en bestemt konto, mappe og UIDVALIDITY-værdi. Sammenlign den aktuelle UIDVALIDITY med din gemte værdi, før du genbruger en markør.

UIDVALIDITY

Identificerer den aktuelle UID-serie for den valgte mappe.

UID

Identificerer en besked inden for den pågældende konto, mappe og UID-serie.

Krav og tilgængelighed

Du skal bruge WordPress 6.9 eller nyere, PHP 8.1 eller nyere med OpenSSL og mbstring, betroede CA-certifikater og en IMAP-server med et gyldigt TLS-certifikat. Forbindelsen understøtter implicit TLS eller STARTTLS.

Download ZIP-filen ovenfor, og test integrationen på en stagingkopi, før du bruger den med en postkasse i drift.

Åbn Plugins → Tilføj nyt plugin → Upload plugin i WordPress, vælg ZIP-filen, installér og aktivér Devenia IMAP Intake. Kald grænsefladen fra dit eget plugin, når de aktive plugins er indlæst. Opbevar postkassens loginoplysninger i din applikations beskyttede konfiguration.

Åbn en mappe og læs en besked

Eksemplet bruger et reserveret domæne. Hent $password fra beskyttet konfiguration og $saved_uid_validity fra din egen applikation. Fastlæg mappens UIDVALIDITY ved første brug, før du gemmer en markør. fetch() anvender bytegrænsen på hele beskeden før afkodning.

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', 'Kontrollér den gemte markør, før 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ænsefladen stiller Mailbox::open(), uid_validity(), uids(), fetch() og close() til rådighed. En hentet besked indeholder headerfelter, afsenderadresser og vedhæftede filer med deres afkodede bytes.

Håndtér fejl i et produktionsforløb, vælg UID med din egen markør, og kontrollér afsendere efter dine regler. Registrér først behandlingen som afsluttet, når de efterfølgende trin er lykkedes. Åbn en ny session efter en mislykket IMAP-læsning.

Hvis forbindelsen fejler, skal du kontrollere servernavn, port, TLS-tilstand, loginoplysninger og den betroede certifikatkæde. Hvis en besked overskrider din bytegrænse, skal du beslutte, hvordan applikationen håndterer den, før du prøver igen.

Læs beskeder med dit eget WordPress-plugin

Download pluginet, kontrollér kravene, og test forbindelsen med din applikation.

Art deco-illustration af en e-mailmodtager med kuverter og en vedhæftet fil.