Doku ergaenzt

[form-email.git] / readme.htm

diff --git a/readme.htm b/readme.htm
index 1411d63a776e720e468628678c7c4ce98ee0c64c..a2055828703ca4a279c0dcba3e7eb87d08a753df 100644 (file)
--- a/readme.htm
+++ b/readme.htm
@@ -65,6 +65,14 @@ p
  padding-left: 0.5cm;\r
  padding-right: 0.5cm;\r
 }\r
  padding-left: 0.5cm;\r
  padding-right: 0.5cm;\r
 }\r

+pre\r
+{\r
+ padding-left: 0.5cm;\r
+ padding-right: 0.5cm;\r
+ font-family: 'Courier New', Courier, monospace;\r
+ font-size: 10pt;\r
+ color: #0000B0;\r
+}\r

 table\r
 {\r
  font-size: 10pt;\r
 table\r
 {\r
  font-size: 10pt;\r


@@ -204,10 +212,6 @@ Beachten Sie bitte, dass bei neueren PHP-Versionen, trotz deutscher Spracheinste
 <b style="color:#FF0000">Achtung:</b> Benutzen Sie hier nach M&ouml;glichkeit absolute URLs! Ich habe zwar etwas eingebaut, was hier relative URLs in absolute umwandelt, um dem HTTP-Standard gerecht zu werden, aber ich garantiere nicht, dass diese Umwandlung immer einwandfrei funktioniert. Seien Sie bei relativen URLs also sehr vorsichtig und verwenden Sie im Fehlerfall absolute.</td>\r
 </tr>\r
 <tr>\r
 <b style="color:#FF0000">Achtung:</b> Benutzen Sie hier nach M&ouml;glichkeit absolute URLs! Ich habe zwar etwas eingebaut, was hier relative URLs in absolute umwandelt, um dem HTTP-Standard gerecht zu werden, aber ich garantiere nicht, dass diese Umwandlung immer einwandfrei funktioniert. Seien Sie bei relativen URLs also sehr vorsichtig und verwenden Sie im Fehlerfall absolute.</td>\r
 </tr>\r
 <tr>\r

-<td><code>$no_tld</code></td>\r
-<td>Setzen Sie diese Option auf 1, wenn der Absender auch E-Mail-Adressen ohne Top-Level-Domain angeben darf.</td>\r
-</tr>\r
-<tr>\r

 <td><code>$allowed_envs</code></td>\r
 <td>Geben Sie hier die Server-Umgebungsvariablen, die im Mailtext angezeigt werden d&uuml;rfen, als normales PHP-Array an (siehe auch die Erl&auml;uterungen zur Template-Datei <i>mail.txt</i>).<br />\r
 Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>\r
 <td><code>$allowed_envs</code></td>\r
 <td>Geben Sie hier die Server-Umgebungsvariablen, die im Mailtext angezeigt werden d&uuml;rfen, als normales PHP-Array an (siehe auch die Erl&auml;uterungen zur Template-Datei <i>mail.txt</i>).<br />\r
 Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>\r


@@ -273,6 +277,31 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 </tr>\r
 </table>\r
 \r
 </tr>\r
 </table>\r
 \r

+<p><b>Mails speichern</b></p>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails</code></td>\r
+<td>Wenn &gt; 0, speichert <i>Form E-Mail</i> die Mails nach dem Versenden noch auf dem Server als Datei ab.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails_dir</code></td>\r
+<td>Geben Sie hier das Verzeichnis an, in dem <i>Form E-Mail</i> die Mails speichern soll (Standard ist <i>stored_mails</i>). Die Dateinamen bestehen aus dem Pr&auml;fix, dem Absender, dem Betreff, der Uhrzeit und einem eindeutigen Wert.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails_prefix</code></td>\r
+<td>Geben Sie hier einen Pr&auml;fix an, der den Dateinamen der gespeicherten Mails vorangestellt werden soll (Standard ist <i>feml_</i>).</td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails_max</code></td>\r
+<td>Geben Sie hier die Zahl der Mails an, die maximal aufbewahrt werden sollen. Wenn Sie hier 0 angeben, werden keine Mails gel&ouml;scht. Die Mail-Dateien werden anhand des mit <code>$store_mails_prefix</code> definierten Pr&auml;fixes erkannt.</td>\r
+</tr>\r
+</table>\r
+\r

 <p><b>Captchas</b></p>\r
 \r
 <table border="1">\r
 <p><b>Captchas</b></p>\r
 \r
 <table border="1">\r


@@ -386,6 +415,18 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 <td>Der vom Benutzer eingegebene Text ist nicht lang genug</td>\r
 </tr>\r
 <tr>\r
 <td>Der vom Benutzer eingegebene Text ist nicht lang genug</td>\r
 </tr>\r
 <tr>\r

+<td><code>$err_name_long</code></td>\r
+<td>Der vom Benutzer eingegebene Name ist nicht zu lang</td>\r
+</tr>\r
+<tr>\r
+<td><code>$err_subject_long</code></td>\r
+<td>Der vom Benutzer eingegebene Betreff ist zu lang</td>\r
+</tr>\r
+<tr>\r
+<td><code>$err_text_long</code></td>\r
+<td>Der vom Benutzer eingegebene Text ist zu lang</td>\r
+</tr>\r
+<tr>\r

 <td><code>$err_send_error</code></td>\r
 <td>Die Mail konnte nicht versendet werden</td>\r
 </tr>\r
 <td><code>$err_send_error</code></td>\r
 <td>Die Mail konnte nicht versendet werden</td>\r
 </tr>\r


@@ -398,6 +439,10 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 <td>Der im HTTP-Referer angegebene Host darf keine Mails &uuml;ber das Script senden</td>\r
 </tr>\r
 <tr>\r
 <td>Der im HTTP-Referer angegebene Host darf keine Mails &uuml;ber das Script senden</td>\r
 </tr>\r
 <tr>\r

+<td><code>$err_indiv_errmsg_miss</code></td>\r
+<td>Eine Fehlermeldung f&uuml;r die individuellen Formularfelder wurde nicht definiert (die Variable <code>{INDIVIDUAL}</code> gibt das Formularfeld an, <code>{ERRMSG}</code> die fehlende Fehlermeldung).</td>\r
+</tr>\r
+<tr>\r

 <td><code>$err_captcha_incorrect</code></td>\r
 <td>Der vom Benutzer eingegebene Captcha-Code ist nicht korrekt</td>\r
 </tr>\r
 <td><code>$err_captcha_incorrect</code></td>\r
 <td>Der vom Benutzer eingegebene Captcha-Code ist nicht korrekt</td>\r
 </tr>\r


@@ -447,6 +492,85 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 <p>Seit Version&nbsp;3.5 ist es m&ouml;glich, in <i>Form E-Mail</i> zus&auml;tzlich zu den vorgegebenen Formularfeldern f&uuml;r Name, E-Mail-Adresse, Betreff und Text eigene Formularfelder zu definieren, die dann von <i>Form E-Mail</i> verarbeitet und in die Mail eingef&uuml;gt werden.<br />\r
 Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird &uuml;ber verschiedene Optionen gesteuert, so ist es m&ouml;glich die L&auml;nge des Inhalts zu pr&uuml;fen, den Inhalt gegen einen regul&auml;ren Ausdruck und gegen eine frei definierbare PHP-Funktion zu pr&uuml;fen und am Ende den Inhalt noch durch eine PHP-Funktion aufzubereiten.</p>\r
 \r
 <p>Seit Version&nbsp;3.5 ist es m&ouml;glich, in <i>Form E-Mail</i> zus&auml;tzlich zu den vorgegebenen Formularfeldern f&uuml;r Name, E-Mail-Adresse, Betreff und Text eigene Formularfelder zu definieren, die dann von <i>Form E-Mail</i> verarbeitet und in die Mail eingef&uuml;gt werden.<br />\r
 Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird &uuml;ber verschiedene Optionen gesteuert, so ist es m&ouml;glich die L&auml;nge des Inhalts zu pr&uuml;fen, den Inhalt gegen einen regul&auml;ren Ausdruck und gegen eine frei definierbare PHP-Funktion zu pr&uuml;fen und am Ende den Inhalt noch durch eine PHP-Funktion aufzubereiten.</p>\r
 \r

+<p>Die Konfiguration der individuellen Formularfelder geschieht &uuml;ber das PHP-Array <code>$user_fields</code> in <i>config.php</i>. Sie ben&ouml;tigen zun&auml;chst den Namen des Formularfeldes, also das, was Sie im HTML-Formular als Namen angeben. Nehmen wir an, Sie haben folgenden HTML-Code f&uuml;r ein Formularfeld:</p>\r
+\r
+<p><code>&lt;input type=&quot;text&quot; name=&quot;beruf&quot; /&gt;</code></p>\r
+\r
+<p>Der Name des Feldes lautet also <b>beruf</b>. Dies ben&ouml;tigen wir f&uuml;r die weitere Definition.</p>\r
+\r
+<p>Sie k&ouml;nnen nun verschiedene Pr&uuml;fwerte definieren, mit denen <i>Form E-Mail</i> den Inhalt des Formularfeldes &uuml;berpr&uuml;ft und ggf. eine Fehlermeldung ausgibt. Diese werden in der folgenden Tabelle erl&auml;utert (die Tabelle geht der Einfachheit halber weiterhin vom Formularfeld <b>beruf</b> aus - Sie m&uuml;ssen dies nat&uuml;rlich anpassen!):</p>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['min']</code></td>\r
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert mindestens sein muss</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['max']</code></td>\r
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert h&ouml;chstens sein darf</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['required']</code></td>\r
+<td>Geben Sie hier den Wert 1 an, wenn das Formularfeld ausgef&uuml;llt sein muss. Wenn Sie hier eine 0 oder die Option weglassen, ist das Feld optional.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['regex']</code></td>\r
+<td>Geben Sie hier einen <a href="http://de.php.net/manual/de/book.pcre.php">Perl-kompatiblen regul&auml;ren Ausdruck</a> zur Pr&uuml;fung des Wertes ein. Der Ausdruck wird direkt an <a href="http://de.php.net/manual/de/function.preg-match.php"><code>preg_match()</code></a> weitergegeben.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['check']</code></td>\r
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert gepr&uuml;ft werden soll.</td>\r
+</tr>\r
+</table>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['too_short']</code></td>\r
+<td></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['too_long']</code></td>\r
+<td></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['not_set']</code></td>\r
+<td></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['match_fail']</code></td>\r
+<td></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['check_fail']</code></td>\r
+<td></td>\r
+</tr>\r
+</table>\r
+\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['prepare']</code></td>\r
+<td></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['tpl_var']</code></td>\r
+<td></td>\r
+</tr>\r
+</table>\r
+\r
+\r

 <p class="upanddown"><a href="#top">Nach oben</a></p>\r
 \r
 <h2><a name="templates" id="templates">Templates anpassen</a></h2>\r
 <p class="upanddown"><a href="#top">Nach oben</a></p>\r
 \r
 <h2><a name="templates" id="templates">Templates anpassen</a></h2>\r


@@ -543,7 +667,7 @@ Zus&auml;tzlich ist es m&ouml;glich, einen Bereich, der nur angezeigt werden sol
 \r
 <hr width="80%" noshade="noshade" />\r
 \r
 \r
 <hr width="80%" noshade="noshade" />\r
 \r

-<p style="font-size:8pt">&copy;&nbsp;2002-2011 Patrick Canterino</p>\r
+<p style="font-size:8pt">&copy;&nbsp;2002-2012 Patrick Canterino</p>\r

 \r
 <table border="0" cellspacing="0" style="font-size:8pt">\r
 <tr>\r
 \r
 <table border="0" cellspacing="0" style="font-size:8pt">\r
 <tr>\r