X-Git-Url: https://git.p6c8.net/form-email.git/blobdiff_plain/beba1c3cc4bb271923f1f6d0f14d8a76885cd489..63ac0f78a9fdcbfb7d6a35b5e797b2305dcf7575:/readme.htm?ds=sidebyside diff --git a/readme.htm b/readme.htm index da63c71..a51734f 100644 --- a/readme.htm +++ b/readme.htm @@ -65,6 +65,14 @@ p padding-left: 0.5cm; padding-right: 0.5cm; } +pre +{ + padding-left: 0.5cm; + padding-right: 0.5cm; + font-family: 'Courier New', Courier, monospace; + font-size: 10pt; + color: #0000B0; +} table { font-size: 10pt; @@ -130,6 +138,8 @@ Auf diese Weise müssen Sie zum Beispiel nicht überall auf Ihrer Homepa

Sie können außerdem noch ein Feld namens subject anlegen. Hier kann ein Betreff für die Mail eingegeben werden. Wenn Sie auf dieses Feld verzichten, erhalten die E-Mails automatisch den in $default_subject definierten Betreff (s.u.).
Weiterhin ist noch ein Feld namens recipient möglich. Dieses Feld enthält einen Alias-Empfänger. Wie das funktioniert, können Sie bei der Beschreibung der Einstellung $aliases lesen.

+

Zusätzlich können Sie die vorgegebenen Formularfelder mit individuellen ergänzen.

+

Wenn Sie Captchas (zufällige Zeichenfolgen, die der Benutzer vor dem Absenden des Formulars eingeben muss, um Spambots auszuschließen) benutzen wollen (siehe unten), müssen Sie im Formular die Datei captcha.php als Bild einbinden (<img>-Tag). Bedenken Sie, dass Sie diese Datei auch in den Templates einbinden müssen!

Das Formular muss dann noch mit POST die Daten an die Datei mailer.php (oder wie Sie die Datei genannt haben) senden.

@@ -142,7 +152,7 @@ Weiterhin ist noch ein Feld namens recipient möglich. Dieses Feld en

Geben Sie zwischen den einfachen Anführungszeichen die Adresse an, an die die Mail gehen soll. Wenn die Mail an mehrere Empfänger gehen soll, so trennen Sie die einzelnen E-Mail-Adressen ganz einfach durch Semikolons.

-

Das war es im Grunde genommen. Aber Form E-Mail lässt sich noch weiter konfigurieren. Mehr dazu finden Sie in den nächsten beiden Abschnitten.

+

Sie haben nun Form E-Mail für die Standard-Nutzung konfiguriert. Form E-Mail lässt sich jedoch noch feiner konfigurieren. Mehr dazu finden Sie in den nächsten Abschnitten.

Nach oben

@@ -163,8 +173,8 @@ Weiterhin ist noch ein Feld namens recipient möglich. Dieses Feld en $aliases Hier können Sie eine Alias-Namen für Empfänger angeben. Soll einem Alias mehrere Empfänger zugeordnet werden, gilt dasselbe wie für $mailto.
Die Aliase werden mit Hilfe eines assoziativen PHP-Arrays definiert. Da es wohl einige gibt, die von so etwas keine Ahnung haben und ich es nicht gut erklären kann, hier ein Beispiel:

-array('info' => 'info@IhreDomain.xyz', 'support' => 'support@IhreDomain.xyz',
-      'alle' => 'info@IhreDomain.xyz; support@IhreDomain.xyz')
+array('info' => 'info@example.com', 'support' => 'support@example.com',
+      'alle' => 'info@example.com; support@example.com')
@@ -264,11 +274,36 @@ Beispiel: array('HTTP_USER_AGENT','REMOTE_ADDR') $referer_ok -Geben Sie hier die Hosts an, von denen Form E-Mail aus aufgerufen werden darf (zum Beispiel www.IhreDomain.xyz). Trennen Sie mehrere Hosts durch Semikolons.
+Geben Sie hier die Hosts an, von denen Form E-Mail aus aufgerufen werden darf (zum Beispiel www.example.com). Trennen Sie mehrere Hosts durch Semikolons.
Achtung: Mit einer Referer-Prüfung kann man zwar unbedarfte Anwender abschrecken, aber wirklich zuverlässig ist diese Methode nicht, da sich der Referer fälschen lässt oder auch komplett fehlen kann. +

Mails speichern

+ + + + + + + + + + + + + + + + + + + + + + +
EinstellungBeschreibung
$store_mailsWenn > 0, speichert Form E-Mail die Mails nach dem Versenden noch auf dem Server als Datei ab.
$store_mails_dirGeben Sie hier das Verzeichnis an, in dem Form E-Mail die Mails speichern soll (Standard ist stored_mails). Die Dateinamen bestehen aus dem Präfix, dem Absender, dem Betreff, der Uhrzeit und einem eindeutigen Wert.
$store_mails_prefixGeben Sie hier einen Präfix an, der den Dateinamen der gespeicherten Mails vorangestellt werden soll (Standard ist feml_).
$store_mails_maxGeben Sie hier die Zahl der Mails an, die maximal aufbewahrt werden sollen. Wenn Sie hier 0 angeben, werden keine Mails gelöscht. Die Mail-Dateien werden anhand des mit $store_mails_prefix definierten Präfixes erkannt.
+

Captchas

@@ -382,10 +417,26 @@ Beispiel: array('HTTP_USER_AGENT','REMOTE_ADDR') + + + + + + + + + + + + + + + + @@ -394,6 +445,10 @@ Beispiel: array('HTTP_USER_AGENT','REMOTE_ADDR') + + + + @@ -443,6 +498,89 @@ Beispiel: array('HTTP_USER_AGENT','REMOTE_ADDR')

Seit Version 3.5 ist es möglich, in Form E-Mail zusätzlich zu den vorgegebenen Formularfeldern für Name, E-Mail-Adresse, Betreff und Text eigene Formularfelder zu definieren, die dann von Form E-Mail verarbeitet und in die Mail eingefügt werden.
Wie Form E-Mail diese Formularfelder behandelt, wird über verschiedene Optionen gesteuert, so ist es möglich die Länge des Inhalts zu prüfen, den Inhalt gegen einen regulären Ausdruck und gegen eine frei definierbare PHP-Funktion zu prüfen und am Ende den Inhalt noch durch eine PHP-Funktion aufzubereiten.

+

Die Konfiguration der individuellen Formularfelder geschieht über das PHP-Array $user_fields in config.php. Sie benötigen zunächst den Namen des Formularfeldes, also das, was Sie im HTML-Formular als Namen angeben. Nehmen wir an, Sie haben folgenden HTML-Code für ein Formularfeld:

+ +

<input type="text" name="beruf" />

+ +

Der Name des Feldes lautet also beruf. Dies benötigen wir für die weitere Definition.

+ +

Sie können nun verschiedene Prüfwerte definieren, mit denen Form E-Mail den Inhalt des Formularfeldes überprüft und ggf. eine Fehlermeldung ausgibt. Diese werden in der folgenden Tabelle erläutert (die Tabelle geht der Einfachheit halber weiterhin vom Formularfeld beruf aus - Sie müssen dies natürlich anpassen!):

+ +
Der vom Benutzer eingegebene Text ist nicht lang genug
$err_name_longDer vom Benutzer eingegebene Name ist nicht zu lang
$err_subject_longDer vom Benutzer eingegebene Betreff ist zu lang
$err_text_longDer vom Benutzer eingegebene Text ist zu lang
$err_send_error Die Mail konnte nicht versendet werden
$err_store_errorDie Mail konnte nicht gespeichert werden
$err_only_post Form E-Mail darf nur mit POST aufgerufen werden
Der im HTTP-Referer angegebene Host darf keine Mails über das Script senden
$err_indiv_errmsg_missEine Fehlermeldung für die individuellen Formularfelder wurde nicht definiert (die Variable {INDIVIDUAL} gibt das Formularfeld an, {ERRMSG} die fehlende Fehlermeldung).
$err_captcha_incorrect Der vom Benutzer eingegebene Captcha-Code ist nicht korrekt
+ + + + + + + + + + + + + + + + + + + + + + + + +
EinstellungBeschreibung
$user_fields['beruf']['min']Geben Sie hier an, wie lang der vom Benutzer eingebene Wert mindestens sein muss
$user_fields['beruf']['max']Geben Sie hier an, wie lang der vom Benutzer eingebene Wert höchstens sein darf
$user_fields['beruf']['required']Geben Sie hier den Wert 1 an, wenn das Formularfeld ausgefüllt sein muss. Wenn Sie hier eine 0 oder die Option weglassen, ist das Feld optional.
$user_fields['beruf']['regex']Geben Sie hier einen Perl-kompatiblen regulären Ausdruck zur Prüfung des Wertes ein. Der Ausdruck wird direkt an preg_match() weitergegeben.
$user_fields['beruf']['check']Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert geprüft werden soll.
+ +

Weiterhin müssen Sie noch diverse Fehlermeldungen definieren (als Unter-Array). Das Definieren dieser Fehlermeldungen ist Pflicht (Sie müssen jedoch nur die Fehlermeldungen zu den Dingen definieren, die auch wirklich geprüft werden).

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
EinstellungBeschreibung
$user_fields['beruf']['errors']['too_short']Der vom Benutzer eingegebene Wert ist nicht lang genug
$user_fields['beruf']['errors']['too_long']Der vom Benutzer eingegebene Wert ist zu lang
$user_fields['beruf']['errors']['not_set']Das Formularfeld ist ein Pflichtfeld und es wurde nicht ausgefüllt.
$user_fields['beruf']['errors']['match_fail']Die Überprüfung des Wertes durch den regulären Ausdruck ist fehlgeschlagen.
$user_fields['beruf']['errors']['check_fail']Die Überprüfung des Wertes durch die PHP-Funktion ist fehlgeschlagen.
+ +

Zusätzlich sind noch die folgenden Einstellungen möglich:

+ + + + + + + + + + + + + + +
EinstellungBeschreibung
$user_fields['beruf']['prepare']Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, die den Wert des Formularfeldes nach den Prüfungen noch verändern (bspw. kann man hier Funktionen angeben, die alle Buchstaben in Großbuchstaben umwandelt).
$user_fields['beruf']['tpl_var']Geben Sie hier die Template-Variable an, die in den Templates durch den Wert des Formularfeldes ersetzt werden soll. Wenn Sie hier nichts angeben, wird ein Standardwert verwendet (im Fall des Formularfeldes beruf wäre das dann USER_beruf).
+ +

Sie müssen die individuellen Formularfelder nun noch in Ihrem Mail-Formular und in den Templates ergänzen.

+

Nach oben

Templates anpassen

@@ -484,6 +622,8 @@ Der eingegebene Mail-Text Die formatierte Zeitangabe +Weiterhin können Sie hier die definierten Variablen der individuellen Formularfelder (das, was Sie in tpl_var angegeben) verwenden.
+
Zusätzlich können Sie hier durch Variablen, die mit ENV_ beginnen, Server-Umgebungsvariablen im Text einfügen (siehe auch Konfigurationsvariable $allowed_envs. @@ -505,6 +645,8 @@ Der eingegebene Mail-Text
  • TIME
    Die formatierte Zeitangabe
  • + +Weiterhin können Sie hier die definierten Variablen der individuellen Formularfelder (das, was Sie in tpl_var angegeben) verwenden. @@ -524,6 +666,8 @@ Der Betreff der Mail Der eingegebene Mail-Text +Weiterhin können Sie hier die definierten Variablen der individuellen Formularfelder (das, was Sie in tpl_var angegeben) verwenden.
    +
    Zusätzlich ist es möglich, einen Bereich, der nur angezeigt werden soll, wenn Captchas aktiviert sind, anzuzeigen, indem Sie diesen in folgenden Block einschließen (der {ELSE}-Teil ist optional):

    {IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF} @@ -539,7 +683,7 @@ Zusätzlich ist es möglich, einen Bereich, der nur angezeigt werden sol
    -

    © 2002-2011 Patrick Canterino

    +

    © 2002-2012 Patrick Canterino