schachbulle / contao-mailkonten-bundle
Verwaltet E-Mail-Konten und ihre Zuordnung zu Funktionen und Personen.
Package info
github.com/Samson1964/contao-mailkonten-bundle
Type:contao-bundle
pkg:composer/schachbulle/contao-mailkonten-bundle
Requires
- php: ^7.4 || ^8.0
- contao/core-bundle: ^4.13 || ^5.0
- menatwork/contao-multicolumnwizard-bundle: ^3.4
- symfony/http-client: ^5.4 || ^6.0 || ^7.0
Requires (Dev)
- contao/manager-plugin: ^2.0
Suggests
- ext-imap: Wird für den Kontocheck (Anzahl der E-Mails und Speicherbelegung) benötigt. Seit PHP 8.4 nur noch über PECL verfügbar.
Provides
None
Conflicts
- contao/core: *
- contao/manager-plugin: <2.0 || >=3.0
Replaces
None
README
Verwaltet die E-Mail-Konten einer Domain samt ihrer Weiterleitungen, Aliasse und Mailinglisten und hält fest, wer für welches Konto zuständig ist. Für Konten mit Zugangsdaten prüft die Erweiterung zusätzlich regelmäßig den Füllstand des Postfachs.
Läuft unter Contao 4.13 und Contao 5 mit PHP 7.4 bis 8.4.
Installation
Über den Contao Manager das Paket schachbulle/contao-mailkonten-bundle suchen
und installieren, oder auf der Konsole:
composer require schachbulle/contao-mailkonten-bundle
Anschließend die Datenbank aktualisieren (Contao Manager oder
vendor/bin/contao-console contao:migrate).
Für den Checkup wird zusätzlich die PHP-Erweiterung imap gebraucht. Sie ist
bis PHP 8.3 im Standardumfang enthalten; ab PHP 8.4 muss sie über PECL
nachinstalliert werden. Fehlt sie, bleibt der übrige Funktionsumfang nutzbar —
der Checkup meldet dann einmalig im Systemprotokoll, dass er übersprungen wurde.
Backend-Modul
Das Modul Mailkonten findet sich im Backend unter Inhalte. Je Konto lassen sich vier Bereiche einschalten, die dann eigene Felder aufklappen:
| Bereich | Inhalt |
|---|---|
| POP3/IMAP | Inhaber, Passwort, Postfachgröße, Auslastung, Spam-Behandlung sowie die Server und Ports für SMTP, POP3 und IMAP |
| Weiterleitung | Zieladressen mit Inhaber, Einrichtungsdatum und Grund |
| Alias | Alias-Adressen mit Einrichtungsdatum und Grund |
| Mailingliste | Adresse der Listenverwaltung, deren Passwort und die eingetragenen Adressen |
Dazu kommen eine Bearbeitungsgeschichte, die mehrzeilige Info als freies Notizfeld und die beiden Schalter Aktiv und Gelöscht. Ist Gelöscht gesetzt, erscheint der Datensatz in der Liste durchgestrichen und rot.
Server abrufen
In der Unterpalette POP3/IMAP trägt der Knopf Server abrufen Servernamen
und Ports für SMTP, POP3 und IMAP ein. Gefragt wird, wie es auch Thunderbird
tut, nach der Autokonfiguration des Mailanbieters: zuerst bei
autoconfig.<domain>, dann unter /.well-known/autoconfig/ der Domain, zuletzt
in der öffentlichen ISP-Datenbank von Thunderbird — dort auch mit der Domain
des Mailservers (MX), weil eigene Domains bei großen Hostern selbst nicht
verzeichnet sind. Je Dienst wird die SSL-Variante bevorzugt; gibt es nur
STARTTLS, erscheint ein Hinweis, denn der Checkup spricht nur SSL.
Übertragen wird nur die Domain, nie der Teil vor dem @-Zeichen. Die Werte landen im Formular und werden erst mit „Speichern“ übernommen. Findet keine Quelle etwas, bleiben die Felder unverändert.
Kopiervorlage
Im Bereich Kopiervorlage steht ein fertiger Text mit Benutzername, Passwort, Servern und Ports (nur bei eingeschaltetem POP3/IMAP), Weiterleitungen, Alias-Adressen und Auto-Responder. Ein Knopf legt ihn in die Zwischenablage. Der Text zeigt den zuletzt gespeicherten Stand.
Export der Liste
Der Knopf Export über der Liste schreibt alle angezeigten Konten in eine Textdatei. Suche und Filter der laufenden Ansicht werden übernommen, die Seitenaufteilung dagegen nicht — die Datei enthält also immer alle Treffer.
Baum eines Kontos
Das Baum-Symbol in der Zeile eines Kontos schreibt dieses eine Konto samt aller Weiterleitungen in eine Textdatei. Führt eine Weiterleitung auf ein weiteres Konto, das selbst weiterleitet, wird auch dieses aufgelöst — so ist zu sehen, wo eine Nachricht am Ende wirklich ankommt:
Konto: geschaeftsstelle@example.org
===================================
├─ vorstand@example.org
│ ├─ praesident@example.org
├─ pressestelle@example.org
Aufgelöst wird bis zur fünften Ebene. Berücksichtigt werden nur aktive Konten mit eingeschalteter Weiterleitung; Konten, die sich gegenseitig weiterleiten, brechen den Zweig ab, statt ihn endlos zu wiederholen.
Checkup
Ist bei einem Konto Checkup eingeschaltet und sind Zugangsdaten hinterlegt, meldet sich ein Cronjob täglich per IMAP am Postfach an, zählt die Nachrichten und liest die Speicherbelegung aus. Danach geht eine Übersicht aller geprüften Konten an den Administrator; Konten über 90 Prozent Belegung stehen darin rot.
Die tägliche Anmeldung hält das Konto zugleich beim Anbieter aktiv. Domainfactory zum Beispiel löscht Postfächer, an denen sich 30 Tage lang niemand per POP3, IMAP, Webmail oder SMTP angemeldet hat (DF-FAQ). Die frühere monatliche Ping-Mail ist deshalb seit 2.3.0 entfallen.
Voraussetzung ist die PHP-Erweiterung imap auf dem Server. Fehlt sie, wird
der Checkup übersprungen (Meldung im Systemprotokoll) — und die Konten werden
dann auch nicht aktiv gehalten.
Wann ein Konto zuletzt an der Reihe war, steht im Feld checkup_date. Contao
stößt den Cronjob stündlich an; der Mindestabstand sorgt dafür, dass daraus
nicht vierundzwanzig Übersichten am Tag werden.
Ein nicht erreichbares Postfach bricht den Lauf nicht ab — der Grund landet im Systemprotokoll, und die übrigen Konten werden weiter geprüft.
Einstellungen
Unter System -> Einstellungen im Bereich Mailkonten-Verwaltung:
| Einstellung | Bedeutung |
|---|---|
| Cronjob | Schaltet die stündliche Prüfung ein. Ohne diesen Haken passiert nichts. |
| E-Mail-Adresse Admin | Empfänger der Übersicht. Ohne Eintrag wird keine Übersicht verschickt. |
| Absendername | Absendername der Übersicht, ersatzweise „Mailkonten“ |
| Betreff | Betreff der Übersicht, ersatzweise „Mailkonten-Checkup“ |
Damit der Cronjob überhaupt läuft, muss Contaos eigener Cronjob eingerichtet
sein — entweder über den Aufruf von contao:cron durch den Hoster oder über den
Aufruf beim Seitenaufruf im Frontend.
Das Feld Backup je Konto ist vorgesehen, aber noch nicht umgesetzt; es wird derzeit von keiner Funktion ausgewertet.
Hinweise zum Betrieb
- Die Passwörter der Konten stehen im Klartext in der Datenbank. Anders ließen sich Postfach und SMTP-Server nicht ansprechen. Der Zugriff auf das Backend-Modul sollte deshalb auf wenige Personen beschränkt bleiben.
- Die Oberfläche gibt es nur auf Deutsch. In einem englischen Backend bleiben die Beschriftungen leer.
Tests
vendor/bin/phpunit
Die Erweiterung wird ohne vendor/-Verzeichnis ausgeliefert. Läuft PHPUnit von
außerhalb, registriert tests/bootstrap.php die Namensräume selbst; Tests, die
Contao-Klassen brauchen, werden dann übersprungen.
Entwickler
Frank Hoppe