esit/downloadmail

DownloadMail v2 ist eine Erweiterung für das Open Source CMS Contao, die den Download einer geschützten Datei nach dem Ausfüllen eines Formulars ermöglicht. Das Formular kann im Formulargenerator frei gestalltet werden. Die eingegebenen Daten stehen im Backend zur Verfügung. Diese Version benötigt C

3.2.7 2024-04-17 07:12 UTC

Requires

• php: ~8.0
• contao/core-bundle: ~4.9

Requires (Dev)

• contao/test-case: ~4.9||~5.1
• phpunit/phpunit: ^9.5

CC-BY-SA-4.0

• Patrick Froch

README

DownloadMail v2 ist eine Erweiterung für das Open Source CMS Contao, die den Download einer geschützten Datei nach dem Ausfüllen eines Formulars ermöglicht. Das Formular kann im Formulargenerator frei gestalltet werden. Die eingegebenen Daten stehen im Backend zur Verfügung. Diese Version benötigt Contao 4, für Contao 3 bitte die erste Version verwenden.

Requirements

• PHP: ~8.0
• Contao: ~4.9

Copyright

2018 by e@sy Solutions IT [e-mail]

Support

Wenden Sie sich für Fragen oder Anregungen bitte einfach an:

[e-mail]

Licence

CC-BY-SA-4.0

https://creativecommons.org/licenses/by-sa/4.0/deed.de

Installation

Im Contao Manager nach eS-IT/downloadmail suchen und installieren.

Einrichtung

Formulare

In der neuen Version wird kein vorgefertigtes Formular mehr ausgegeben. Es können nun beliebige Formulare aus dem Formulargenerator verwendet werden. Bei den gewünschten Formularen muss in der Einstellungen der Formulare der Haken Formular für DownloadMail gesetzt sein. Hier können dann auch die Einstellungen für die Downloads getätigt werden.

Die Weiterleitungsseite des Formulars verweist auf die Seite, die angezeigt wird, wenn das Formular abgesendet wird.

Die Downloadseite ist die Seite, auf die der Downloadlink in der E-Mail verweist. Auf dieser Seite muss das Modul vom Typ easy_Downloadmail eingebunden werden.

Formularfeld

Das Formular muss ein Textfeld enthalten, in dem der Haken E-Mail-Adresse für DownloadMail gesetzt ist, enthalten. Als Eingabeprüfung kann hier E-Mail-Adresse verwendet werden, dann sind alle Adressen erlaubt. Wird als Eingabeprüfung stattdessen E-Mail-Blacklist verwendet, wird auch geprüft, ob es sich um eine gültige E-Mail-Adresse handelt, zusätzlich wird sie aber auch gegen die Blacklist geprüft (s. Blacklist, weiter unten).

Es sollte in jedem Formularfeld nur ein Formularfeld mit dem Haken "E-Mail-Adresse für DownloadMail" geben, da nur die erste E-Mailadresse berücksichtigt wird!

Modul

Das Modul vom Typ easy_Downloadmail muss auf der Downloadseite eingebunden werden. Es kümmert sich um die Prüfung und das Bereitstellen des Downloads.

Einstellungen

Es gibt mehrere Stellen, an denen die Einstellungen gesetzt werden können. Die Einstellungen werden in den Einstellungen von Contao global für alle Formulare auf allen Seiten gesetzt. Diese können in der Rootpage der entsprechenden Seite überschrieben, bzw. ergänzt werden. Diese Einstellungen gelten nur für die Formulare auf Unterseiten der entsprechenden Rootpage. Dann gibt es noch die Möglichkeit die Einstellungen direkt im Formular zu setzen. Diese gelten dann nur für das eine Formular.

Name der Einstellung	Erklärng
Gültigkeitsdauer	Dauer, in der die Datei nach der Anfrage runter geladen werden kann. Vorgabewert: 12 Stunden
Zeit bis zum Start des Downloads	Zeit die nach dem Aufruf der Downloadseite gewartet wird, bis der Download automatisch startet. Vorgabewert: 5 Sekunden
Absender	Absendeadresse für die Mail mit dem Downloadlink.
Betreff	Betreff der Mail mit dem Downloadlink.
Empfänger der Bildkopie	Hier können Empfänger eingetragen werden, die die Mail mit dem Downloadlink auch erhalten sollen, z.B. der Admin, oder Redakteur.
Mailtext	Text der Mail mit dem Downloadlink. Die Formularfelder können mit den InsertTags {{download::FELDNAME}} ausgegeben werden. Der Link für den Download kann mit {{download::link}} ausgegeben werden.
Downloadseite	Seite auf die der Downloadlink zeigt.
TinyMCE verwenden	Wird der TinyMce aktiviert, wird er in den Einstellungen eingeblendet, und es werden HTML-Mails statt Textmails erzeugt.
Quelldatei	Die Datei, die über den Link aus der E-Mail runter geladen werden kann.

• TinyMCE verwenden kann nur in den Contao-Settings eingestellt werden.
• Die Quelldatei kann nur direkt im Formular festgelegt werden.
• Der Suffix für die Downloadseite kann nur direkt in den Contao-Settings festgelegt werden.

Der Suffix für die Downloadseite kann nur global für alle Downloadseiten gesetzt werden. Er kann auch leer sein, falls kein Suffix verwendet werden soll.

Blacklist

Hier können E-Mail-Adressen oder reguläre Ausdrücke für E-Mail-Adressen angegeben werden, die für Downloads nicht verwendet werden können (z.B. Einmaladressen wie byom.de). Wird eine solche E-Mail-Adresse im Formular eingegeben, wird im Formular eine entsprechende Fehlermeldung ausgegeben.

Damit dies funktioniert, muss im betreffenden Formularfeld (s. Formularfeld weiter oben) als Eingabeprüfung E-Mail-Blacklist verwendet werden.

Downloads

Unter dem Menüpunkt Downloads können im Backend die Anfragen und die getätigten Downloads eingesehen werden. Klick man in der Liste auf die Lupe, werden Metadaten, die Zeiten und anonymisierten IPs zu den einzelnen Downloads angezeigt. Dort ist auch ein Button Anforderungszeit zurücksetzen. Dieser setzt die Anforderungszeit auf die aktuelle Zeit, sodass über den gleichen Link auch nach Ablauf der Gültigkeitsdauer wieder die entsprechende Datei heruntergeladen werden kann.