Devenia IMAP Intake

Odbieraj wiadomości IMAP we własnej wtyczce WordPress

Odczytuj wiadomości i załączniki z istniejącej skrzynki IMAP przez interfejs PHP. Twoja wtyczka decyduje, kiedy je pobrać i co zrobić z wynikiem.

Wersja 1.0.1 · GPL-2.0-or-later

Odbiornik poczty w stylu art déco sortuje przychodzące koperty i załączony dokument.

Jedna skrzynka, jasne przekazanie danych

Twoja wtyczka podaje serwer, port, folder i dane logowania. Devenia IMAP Intake otwiera folder w trybie tylko do odczytu przez połączenie TLS z weryfikacją certyfikatu i zwraca nagłówki, adresy nadawców oraz zdekodowane bajty załączników. Oryginalna wiadomość pozostaje w folderze, a jej znacznik odczytu nie zmienia się.

Twoja wtyczka decyduje, kiedy się połączyć, i odpowiada za kontrolę dostępu, ponawianie prób, wykrywanie duplikatów oraz przechowywanie danych. Ustala także maksymalny rozmiar całej wiadomości dla każdego pobrania.

Odczytaj wiadomość. Dalsze działanie należy do Twojej wtyczki.

Wiadomość pozostaje w skrzynce. Odbiornik ją odczytuje i dekoduje załączniki, a Twoja wtyczka stosuje własne reguły i decyduje, co zrobić dalej.

Istniejąca skrzynka IMAP przekazuje wiadomości i załączniki przez odbiornik do wtyczki WordPress.

Odbiornik łączy skrzynkę z Twoim kodem, ale nie decyduje, jak przetwarzać wiadomości.

Przykład: obsługa wspólnej skrzynki

Wyobraź sobie wtyczkę WordPress, która przetwarza wiadomości wysyłane na adres [email protected]. Programista łączy ją z istniejącą skrzynką IMAP i ustala maksymalny rozmiar wiadomości. Odbiornik zwraca wiadomości i załączniki, a wywołująca wtyczka sprawdza, co już obsłużyła, i decyduje, jak zapisać lub przetworzyć każdy element.

To przykład poglądowy. Odbiornik jest interfejsem odczytu dla programistów; nie jest pocztą internetową i nie wysyła wiadomości przez SMTP.

Zachowaj kontekst identyfikatorów wiadomości

Identyfikatory UID wskazują wiadomości tylko w kontekście konkretnego konta, folderu i wartości UIDVALIDITY. Przed ponownym użyciem zapisanego punktu odczytu porównaj aktualną wartość UIDVALIDITY z zapisaną.

UIDVALIDITY

Określa aktualną serię identyfikatorów UID wybranego folderu.

UID

Identyfikuje wiadomość w obrębie danego konta, folderu i serii UID.

Wymagania i dostępność

Potrzebujesz WordPressa 6.9 lub nowszego, PHP 8.1 lub nowszego z OpenSSL i mbstring, zaufanych certyfikatów CA oraz serwera IMAP z ważnym certyfikatem TLS. Połączenie obsługuje bezpośredni TLS lub STARTTLS.

Pobierz powyższy plik ZIP, a następnie przetestuj integrację na kopii testowej przed użyciem produkcyjnej skrzynki.

W WordPressie otwórz Wtyczki → Dodaj wtyczkę → Wyślij wtyczkę na serwer , wybierz plik ZIP, zainstaluj go i włącz Devenia IMAP Intake. Wywołuj interfejs z własnej wtyczki po załadowaniu aktywnych wtyczek. Przechowuj dane logowania do skrzynki w chronionej konfiguracji aplikacji.

Otwórz folder i odczytaj wiadomość

Ten przykład używa zarezerwowanej domeny. Wartość $password pobierz z chronionej konfiguracji, a $saved_uid_validity z własnej aplikacji. Przy pierwszym użyciu ustal UIDVALIDITY folderu, zanim zapiszesz punkt odczytu. fetch() stosuje limit bajtów do całej wiadomości przed jej dekodowaniem.

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', 'Check the saved cursor before continuing.' );
    }

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

Interfejs udostępnia Mailbox::open(), uid_validity(), uids(), fetch() oraz close(). Pobrana wiadomość zawiera nagłówki, adresy nadawców oraz załączniki w postaci zdekodowanych bajtów.

W środowisku produkcyjnym obsługuj błędy, wybieraj UID według własnego zapisanego punktu odczytu, sprawdzaj nadawców zgodnie ze swoją polityką i zapisuj zakończenie dopiero po pomyślnym dalszym przetwarzaniu. Po nieudanym odczycie IMAP otwórz nową sesję.

Jeśli połączenie się nie powiedzie, sprawdź nazwę serwera, port, tryb TLS, dane logowania i łańcuch zaufanych certyfikatów. Jeśli wiadomość przekracza limit bajtów, przed ponowną próbą ustal, jak aplikacja ma ją obsłużyć.

Odczytuj wiadomości we własnej wtyczce WordPress

Pobierz wtyczkę, sprawdź wymagania i przetestuj połączenie ze swoją aplikacją.

Odbiornik poczty w stylu art déco sortuje przychodzące koperty i załączony dokument.