Devenia IMAP Intake
Ein IMAP-Postfach in Ihr WordPress-Plugin einbinden
Lesen Sie Nachrichten und Anhänge aus einem bestehenden IMAP-Postfach über eine PHP-Schnittstelle. Ihr Plugin entscheidet, wann es liest und was mit dem Ergebnis geschieht.
Version 1.0.1 · GPL-2.0-or-later
Ein Postfach, eine klare Übergabe
Ihr Plugin übergibt Server, Port, Ordner und Zugangsdaten. Devenia IMAP Intake öffnet den Ordner über eine geprüfte TLS-Verbindung im schreibgeschützten Modus und liefert Nachrichtenkopfzeilen, Absenderadressen und dekodierte Anhänge als Bytes zurück. Die ursprüngliche Nachricht bleibt im Ordner; ihr Gelesen-Status bleibt erhalten.
Ihr Plugin bestimmt den Zeitpunkt der Verbindung und ist für Zugriffskontrolle, Wiederholungsversuche, Deduplizierung und Speicherung zuständig. Es legt außerdem die maximale Größe der vollständigen Nachricht für jeden Abruf fest.
Nachricht lesen. Ihr Plugin übernimmt.
Die Nachricht bleibt im Postfach. Der Empfänger liest sie und dekodiert ihre Anhänge; Ihr Plugin wendet seine eigenen Regeln an und entscheidet über die weitere Verarbeitung.
Der Empfänger verbindet das Postfach mit Ihrem Code; er entscheidet nicht, wie die Nachricht verarbeitet wird.
Beispiel: ein gemeinsames Postfach verarbeiten
Ein WordPress-Plugin könnte Nachrichten an [email protected] verarbeiten. Die Entwicklerin oder der Entwickler verbindet es mit dem bestehenden IMAP-Postfach und legt eine maximale Nachrichtengröße fest. Der Empfänger liefert Nachrichten und Anhänge; das aufrufende Plugin prüft, was bereits verarbeitet wurde, und entscheidet über Speicherung und weitere Verarbeitung.
Das Beispiel dient der Veranschaulichung. Der Empfänger ist eine Leseschnittstelle für Entwicklerinnen und Entwickler; er ist kein Webmail und versendet keine E-Mails über SMTP.
Nachrichten-IDs im richtigen Zusammenhang verwenden
UIDs identifizieren Nachrichten nur innerhalb eines bestimmten Kontos, Ordners und UIDVALIDITY-Werts. Vergleichen Sie den aktuellen UIDVALIDITY-Wert mit dem gespeicherten Wert, bevor Sie einen Cursor erneut verwenden.
UIDVALIDITY
Kennzeichnet die aktuelle UID-Serie des ausgewählten Ordners.
UID
Kennzeichnet eine Nachricht innerhalb dieses Kontos, Ordners und dieser UID-Serie.
Voraussetzungen und Verfügbarkeit
Sie benötigen WordPress 6.9 oder neuer, PHP 8.1 oder neuer mit OpenSSL und mbstring, vertrauenswürdige CA-Zertifikate und einen IMAP-Server mit gültigem TLS-Zertifikat. Die Verbindung unterstützt implizites TLS oder STARTTLS.
Laden Sie die ZIP-Datei oben herunter und testen Sie die Integration auf einer Staging-Kopie, bevor Sie sie mit einem produktiven Postfach verwenden.
Öffnen Sie in WordPress Plugins → Plugin hinzufügen → Plugin hochladen, wählen Sie die ZIP-Datei aus, installieren und aktivieren Sie Devenia IMAP Intake. Rufen Sie die Schnittstelle aus Ihrem eigenen Plugin auf, nachdem die aktiven Plugins geladen wurden. Bewahren Sie die Zugangsdaten des Postfachs in der geschützten Konfiguration Ihrer Anwendung auf.
Ordner öffnen und Nachricht lesen
Dieses Beispiel verwendet eine reservierte Domain. Übergeben Sie $password aus einer geschützten Konfiguration und $saved_uid_validity aus Ihrer Anwendung. Ermitteln Sie beim ersten Zugriff den UIDVALIDITY-Wert des Ordners, bevor Sie einen Cursor speichern. fetch() wendet die Bytegrenze vor dem Dekodieren auf die gesamte Nachricht an.
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', 'Prüfen Sie den gespeicherten Cursor, bevor Sie fortfahren.' );
}
if ( $uids ) {
$message = $mailbox->fetch( $uids[0], wp_max_upload_size() );
if ( is_wp_error( $message ) ) {
return $message;
}
}
} finally {
$mailbox->close();
}
Die Schnittstelle stellt Mailbox::open(), uid_validity(), uids(), fetch() und close() bereit. Eine abgerufene Nachricht enthält Kopfzeilen, Absenderadressen und Anhänge mit ihren dekodierten Bytes.
Behandeln Sie in einer produktiven Anwendung Fehler, wählen Sie die UID anhand Ihres eigenen Cursors und prüfen Sie Absender nach Ihren Regeln. Markieren Sie die Verarbeitung erst als abgeschlossen, wenn die nachfolgenden Schritte erfolgreich waren. Öffnen Sie nach einem fehlgeschlagenen IMAP-Lesevorgang eine neue Sitzung.
Wenn die Verbindung fehlschlägt, prüfen Sie Servername, Port, TLS-Modus, Zugangsdaten und vertrauenswürdige Zertifikatskette. Überschreitet eine Nachricht Ihre Bytegrenze, legen Sie vor einem erneuten Versuch fest, wie Ihre Anwendung damit umgehen soll.
Nachrichten mit Ihrem WordPress-Plugin lesen
Laden Sie das Plugin herunter, prüfen Sie die Voraussetzungen und testen Sie die Verbindung mit Ihrer Anwendung.
