Das Open-Letters Newslettersystem - Übersicht

1. Lizenz

Das Open-Letters Newslettersystem wird nach den Vorgaben der GNU Lesser General Public License (Version 3 oder neuer) veröffentlicht. Die originalen Lizenzbestimmungen können unter http://www.gnu.org/licenses/lgpl.html (in englischer Sprache) nachgelesen werden; eine inoffizielle deutsche Übersetzung befindet sich unter http://www.gnu.de/documents/lgpl.de.html.

Darüber hinaus bitten die Autoren den Nutzer, das System in angemessenem Rahmen zu nutzen und insbesondere die Rechte der Empfänger des Newsletters zu wahren!

2. Autoren / Kontakt

Das Open-Letters Newslettersystem wird entwickelt von Stefan Rank-Kunitz nach einer Vorlage von Sebastian de Vries (QuBIT KG).

Kontakt: info@open-letters.de
Web: https://www.open-letters.de

3. Technische Voraussetzungen

Das Open-Letters Newslettersystem ist eine webbasierte Software und wird auf einem Webserver / Webspace installiert.

Das System benötigt aktuell:

  • PHP 5-Webspace ab 5.2.0 (alle Basisfunktionen auch in PHP 7 verfügbar),
    Modul "PDO" zur Datenbank-Anbindung notwendig (ist ab PHP 5.1 Basis-Bestandteil von PHP),
    Modul "IMAP" (optional) zur Ablage von Newsletter-Emails im Ordner "Gesendet" erforderlich
  • eine MySQL-Datenbank (kann mit anderen Programmen geteilt werden)

Darüber hinaus muss der Browser des Administrators zum Versand des Newsletters JavaScript aktiviert haben.

4. Funktionsübersicht

a) An-/Abmeldung durch den Empfänger

Der Kunde kann sich über eine öffentlich erreichbare Oberfläche ("Frontend") zum Newsletter-Empfang an- und abmelden. In jedem Newsletter ist darüber hinaus ein Link enthalten, mit dem der Empfänger den Newsletter direkt abbestellen kann.

Der Prozess der Registrierung erfolgt über ein "Double-OptIn", d.h. nach der Anmeldung im Frontend (öffentliches Anmeldeformular) oder im Backend (Admin-Oberfläche) wird an die neu eingetragene E-Mail-Adresse eine E-Mail mit einem Bestätigungslink versendet. Erst nachdem der Empfänger diesen Link geklickt hat, ist seine E-Mail-Adresse für den Empfang von Newslettern freigeschaltet.

Die Abmeldung erfolgt über einen Link, der in jedem verschickten Newsletter enthalten ist, oder über den Link am Fuß der Registrierungsseite. Das Abmelden "deaktiviert" die E-Mail-Adresse des Empfängers nur und löscht sie nicht aus dem Newslettersystem heraus. Auf diese Weise wird ein versehentlicher Neu-Import der abgemeldeten E-Mail-Adresse verhindert. Die vollständige Löschung ist dem Administrator über die Admin-Oberfläche möglich.

b) Newsletter empfangen

Alle Newsletter werden gleichzeitig in HTML- und Text-Form versendet. Das E-Mail-Programm des Empfängers entscheidet, welcher der Inhalte angezeigt wird. Zum Versand der E-Mails wird die Open-Source-Bibliothek "PhpMailer" von https://github.com/PHPMailer/PHPMailer verwendet.

Da die Darstellung des Newsletters dem Programm überlassen ist, das der Empfänger des Newsletters zum Lesen seiner E-Mails benutzt, kann es aufgrund der verschiedenen Systeme (Webmailer, Desktop-Programme, E-Mail-Clients auf mobilen Geräten, ...) teilweise erhebliche Abweichungen in der Darstellung geben.

Über einen Link im Newsletter oder einen Link in der zuvor benannten öffentlichen Anmelde-Oberfläche kann der bereits versendete Newsletter zusätzlich online im Webbrowser betrachtet werden.

c) Zugang zur Admin-Oberfläche

Der Zugang zur Admin-Oberfläche ist durch Aufruf der zuvor benannten öffentlichen Oberfläche und Anhängen von "/admin/" an die Internetadresse erreichbar. Haben Sie das Newslettersystem beispielsweise unter http://newsletter.example.com
installiert, so erreichen Sie die Admin-Oberfläche unter http://newsletter.example.com/admin.

ACHTUNG: Die Admin-Oberfläche ist derzeit UNGESICHERT und muss während der Installation durch einen Htaccess-Schutz gesichert werden (siehe Anleitung und Hilfsprogramm dazu in der Installation). Eine Benutzerverwaltung und ein Rechte-Management sind derzeit noch nicht enthalten.

d) An-/Abmeldung von Empfängern durch den Administrator

Innerhalb der Admin-Oberfläche hat der Administrator die Möglichkeiten:

  • die Liste der Empfänger einzusehen
  • die Liste nach bestimmten Namen oder E-Mailadressen zu filtern
  • Empfänger hinzuzufügen
  • Empfänger zu deaktvieren oder endgültig zu löschen

Die Anzahl der Newsletter-Empfänger ist im Open-Letters Newslettersystem nur durch die technische Infrastruktur beschränkt (z.B. Anzahl der Einträge in der Datenbank, Dauer des Newsletter-Versandprozesses, ...), spezielle "Grenzwerte" sind nicht in die Software eingebaut worden.

e) Verwaltung der Newsletter

Der Administrator kann in der Admin-Oberfläche eine Liste aller vorhandenen Newsletter einsehen. Dabei ist bei jedem Newsletter erkennbar, ob er bereits versendet wurde. Der Newsletter kann angesehen, bearbeitet, gelöscht oder abschließend versendet werden.

Darüber hinaus kann ein neuer Newsletter angelegt werden. Dazu muss man eines der vorhandenen Templates auswählen. Diese Templates sind Layout-Vorlagen aus HTML und CSS, welche das äußere Erscheinungsbild (Grundlayout) des Newsletters nahezu vollständig bestimmen. Das Füllen eines Newsletters mit Inhalten geschieht durch das Erzeugen neuer "Einträge" des Newsletters und das Bearbeiten dieser Einträge.

Die Bearbeitung eines Newsletter-Eintrags geschieht mit Hilfe des Editors "TinyMCE" (https://www.tinymce.com/), der die bequeme Formulierung und Formatierung des Textes ohne Kenntnisse in HTML und CSS ermöglicht. Durch Einsatz des "Ajax Filemanagers" können in einen Newsletter-Eintrag auf einfache Weise Bilder hochgeladen und eingebunden werden.

Seit Version 1.0.9 ist es möglich, Newsletter personalisiert zu versenden. Dabei werden eingefügte Platzhalter unmittelbar vor dem Versand des Newsletters durch Angaben aus der Anmeldung der betreffenden Empfänger ersetzt. Die Platzhalter können im HTML- und Text-Template eines Newsletters und auch in den Text-Einträgen stehen, die beim Schreiben des Newsletters verfasst wurden. Die Vorschau des Newsletters in der Admin-Oberfläche zeigt den Newsletter mit einer Personalisierung für "Max Mustermann" an. Die möglichen Platzhalter sind:

  • #####receiver_name##### der Vor- und Nachname des Empfängers
  • #####receiver_anrede##### die bei der Anmeldung ausgewählte Anrede des Empfängers
  • #####receiver_email##### die bei der Anmeldung angegebene E-Mail-Adresse des Empfängers

f) Newsletter-Versand

Der Versand eines Newsletters muss immer so geschehen, dass die versendeten Newsletter beim Empfänger (dessen Mailprogramm / Mailserver) nicht oder nur gering unter Spam-Verdacht fallen. Eine wichtige Bedingung dafür ist der Versand der Newsletter über einen SMTP-Server. Die Zugangsdaten zu dem SMTP-Server müssen während der Installation einmalig in der zentralen Config-Datei eingestellt werden.

Eine weitere Bedingung für eine geringe Spam-Einstufung ist der Versand der Newsletter-E-Mails in kleinen Gruppen zu wenigen Einzel-Mails. Häufig verwenden Newslettersysteme dafür einen "Cron-Job", also einen System-Wartungs-Aufruf des Webservers, zu dessen Einrichtung man häufig administrativen Zugriff auf den Webserver und entsprechende Kenntnisse benötigt. Mit Hilfe dieses Cron-Dienstes werden die E-Mails über einen längeren Zeitraum einzeln oder in kleinen Gruppen versendet.
Das Open-Letters Newslettersystem verlagert die Steuerung des Versands in eine Ajax-Oberfläche im Browser des Administrators aus. Diese Oberfläche zeigt für den Administrator/Versender einen Fortschrittsbalken an und stößt auf dem Webserver in Abständen von wenigen Sekunden den Versand weiterer Newsletter-Mails an. Damit ist das oben beschriebene "Cron-System" hier nicht notwendig.
Hinweis: Aus diesem Grund führt das Schließen der Website durch den Administrator vor Ende des Versandprozesses zum Abbruch des Versands. Es ist notwendig, das Browserfenster so lang offen zu lassen, bis der Fortschrittsbalken die 100%-Marke erreicht hat.

Zum Versand der Newsletter-Emails wird ein SMTP-Email-Account verwendet. Seit Version Open-Letters 1.2 ist es zusätzlich möglich, die gesendeten Emails in einem IMAP-Account abzulegen. Auf diese Weise kann das Newsletter-System erfolgreich versendete Emails im Ordner "Gesendet" (Name ist konfigurierbar) und fehlerhaft gesendete Emails im Ordner "Entwürfe" (Name ist konfigurierbar) abgelegt werden.

5. Installation, Einrichtung und Aktualisierung

Eine detaillierte Installationsanleitung finden Sie hier. Darin sind vom Download bis zum Abschluss der Einrichtung alle Schritte genau beschrieben. Falls Sie bereits eine ältere Version des Open-Letters Newslettersystems installiert haben und diese Installation jetzt aktualisieren möchten, so lesen Sie bitte die UPDATES.html im Verzeichnis documentation eines Open-Letters Downloads.

6. Weitere Dokumentation

Eine umfangreiche Liste an Fragen und Antworten haben wir hier zusammengetragen. Bitte lesen Sie die Liste einmal ganz durch. Sie werden darin viele wertvolle Tipps zu Themen wie der Spam-Einstufung der Newsletter-E-Mails, zur Konfiguration der Newsletter-Software, aber auch Gestaltungshinweise bekommen.

Wenn Sie weitere Fragen haben, nehmen Sie bitte gern Kontakt mit uns auf!

Entwicklung

Das gesamte Newslettersystem ist in objektorientiertem PHP 5 programmiert. Alle Klassen und Methoden sind PhpDoc-dokumentiert. Sie können also einfach den PhpDocumentor über das System laufen lassen, um eine detaillierte Dokumentation der API zu erhalten.

Optische Anpassung

Zu Erstellung von Templates für das Front- und Backend der Website ist im Verzeichnis "website_templates" eine Datei README.txt enthalten.

Zu Erstellung von Newsletter-Templates ist im Verzeichnis "newsletter_templates" eine Datei README.txt enthalten.

Darüber hinaus liefert dieses Newslettersystem für Front-, Backend und Newsletter mehrere Templates mit, die als Veranschaulichung und Basis für eigene Templates gut geeignet sind.