Devenia IMAP Intake

Yhdistä IMAP-postilaatikko WordPress-lisäosaasi

Lue viestit ja liitteet olemassa olevasta IMAP-postilaatikosta PHP-rajapinnan kautta. Lisäosasi päättää, milloin viestit luetaan ja mitä tulokselle tehdään.

Versio 1.0.1 · GPL-2.0-or-later

Art deco -tyylinen kuvitus sähköpostin vastaanottimesta, kirjekuorista ja liitteestä.

Yksi postilaatikko, selkeä työnjako

Lisäosasi antaa palvelimen, portin, kansion ja kirjautumistiedot. Devenia IMAP Intake avaa kansion vain lukemista varten varmennetulla TLS-yhteydellä ja palauttaa viestien otsaketiedot, lähettäjien osoitteet sekä liitteiden puretut tavut. Alkuperäinen viesti jää kansioon ja sen lukutila säilyy.

Lisäosasi päättää yhteyden ajankohdan ja vastaa käyttöoikeuksista, uusintayrityksistä, kaksoiskappaleiden tunnistamisesta ja tallennuksesta. Se määrittää myös koko viestin enimmäiskoon jokaista hakua varten.

Lue viesti. Lisäosasi jatkaa siitä.

Viesti jää postilaatikkoon. Vastaanotin lukee sen ja purkaa liitteet; lisäosasi soveltaa omia sääntöjään ja päättää jatkokäsittelystä.

IMAP-postilaatikko välittää viestejä WordPress-lisäosalle Devenia IMAP Intaken kautta.

Vastaanotin yhdistää postilaatikon koodiisi, mutta ei päätä, miten viesti käsitellään.

Esimerkki: jaetun postilaatikon käsittely

Kuvittele WordPress-lisäosa, joka käsittelee osoitteeseen [email protected] lähetettyjä viestejä. Kehittäjä yhdistää sen olemassa olevaan IMAP-postilaatikkoon ja määrittää viestin enimmäiskoon. Vastaanotin palauttaa viestit ja liitteet; kutsuva lisäosa tarkistaa, mitä on jo käsitelty, ja päättää kunkin osan tallennuksesta tai käsittelystä.

Esimerkki on havainnollistava. Vastaanotin on kehittäjille tarkoitettu lukurajapinta; se ei ole verkkosähköposti eikä lähetä postia SMTP:n kautta.

Käytä viestitunnisteita oikeassa yhteydessä

UID-tunnisteet yksilöivät viestit vain tietyn tilin, kansion ja UIDVALIDITY-arvon sisällä. Vertaa nykyistä UIDVALIDITY-arvoa tallennettuun arvoon ennen kuin käytät osoitinta uudelleen.

UIDVALIDITY

Yksilöi valitun kansion nykyisen UID-sarjan.

UID

Yksilöi viestin kyseisen tilin, kansion ja UID-sarjan sisällä.

Vaatimukset ja saatavuus

Tarvitset WordPressin version 6.9 tai uudemman, PHP:n version 8.1 tai uudemman sekä OpenSSL- ja mbstring-laajennukset, luotetut varmentajavarmenteet ja IMAP-palvelimen, jolla on voimassa oleva TLS-varmenne. Yhteys tukee implisiittistä TLS:ää tai STARTTLS:ää.

Lataa yllä oleva ZIP ja testaa integraatio testikopiossa ennen käyttöä tuotannossa olevan postilaatikon kanssa.

Avaa WordPressissä Lisäosat → Lisää uusi lisäosa → Lataa lisäosa, valitse ZIP-tiedosto, asenna ja ota Devenia IMAP Intake käyttöön. Kutsu rajapintaa omasta lisäosastasi aktiivisten lisäosien latauduttua. Säilytä postilaatikon kirjautumistiedot sovelluksesi suojatuissa asetuksissa.

Avaa kansio ja lue viesti

Esimerkissä käytetään varattua verkkotunnusta. Hae $password suojatuista asetuksista ja $saved_uid_validity omasta sovelluksestasi. Selvitä ensimmäisellä käyttökerralla kansion UIDVALIDITY ennen osoittimen tallentamista. fetch() soveltaa tavurajaa koko viestiin ennen dekoodausta.

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', 'Tarkista tallennettu osoitin ennen jatkamista.' );
    }

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

Rajapinta tarjoaa metodit Mailbox::open(), uid_validity(), uids(), fetch() ja close(). Haettu viesti sisältää otsaketiedot, lähettäjien osoitteet ja liitteiden puretut tavut.

Käsittele tuotannossa virheet, valitse UID oman osoittimesi perusteella ja tarkista lähettäjät omien sääntöjesi mukaan. Merkitse käsittely valmiiksi vasta, kun jatkokäsittely on onnistunut. Avaa uusi istunto epäonnistuneen IMAP-lukutoiminnon jälkeen.

Jos yhteys epäonnistuu, tarkista palvelimen nimi, portti, TLS-tila, kirjautumistiedot ja luotettu varmenneketju. Jos viesti ylittää tavurajan, päätä ennen uutta yritystä, miten sovelluksesi käsittelee sen.

Lue viestejä omalla WordPress-lisäosallasi

Lataa lisäosa, tarkista vaatimukset ja testaa yhteys sovelluksessasi.

Art deco -tyylinen kuvitus sähköpostin vastaanottimesta, kirjekuorista ja liitteestä.