readme.htm

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6 <head>
   7 <title>ReadMe f&uuml;r Form E-Mail&nbsp;3.5</title>
   8 <meta name="author" content="Patrick Canterino" />
   9 <style type="text/css">
  10 <!--
  11 .upanddown
  12 {
  13  font-size: 8pt;
  14  background-color: #E8E8E8;
  15  padding: 3px;
  16  margin-left: 0.5cm;
  17  margin-right: 0.5cm;
  18  white-space: nowrap;
  19 }
  20 a:link, a:visited, a:active, a:focus
  21 {
  22  font-weight: normal;
  23  text-decoration: none;
  24  color: #0000FF;
  25  cursor: hand;
  26 }
  27 a:link:hover, a:visited:hover, a:active:hover, a:focus:hover
  28 {
  29  font-weight: normal;
  30  text-decoration: underline;
  31  color: #0000FF;
  32  cursor: hand;
  33 }
  34 body
  35 {
  36  font-family: Verdana, Tahoma, Arial, Helvetica, sans-serif;
  37  font-size: 10pt;
  38  color: #000000;
  39  background-color: #FFFFFF;
  40 }
  41 code
  42 {
  43  font-family: 'Courier New', Courier, monospace;
  44  font-size: 10pt;
  45  color: #0000B0;
  46 }
  47 h1
  48 {
  49  font-size: 18pt;
  50  font-weight: bold;
  51 }
  52 h2
  53 {
  54  font-size: 13pt;
  55  font-weight: bold;
  56  padding-left: 0.2cm;
  57  padding-right: 0.2cm;
  58 }
  59 li
  60 {
  61  margin-top: 3px;
  62 }
  63 p
  64 {
  65  padding-left: 0.5cm;
  66  padding-right: 0.5cm;
  67 }
  68 pre
  69 {
  70  padding-left: 0.7cm;
  71  padding-right: 0.7cm;
  72  font-family: 'Courier New', Courier, monospace;
  73  font-size: 10pt;
  74  color: #0000B0;
  75 }
  76 table
  77 {
  78  font-size: 10pt;
  79  margin-left: 0.5cm;
  80  margin-right: 0.5cm;
  81 }
  82 td
  83 {
  84  vertical-align: top;
  85 }
  86 ul
  87 {
  88  padding-left: 0.5cm;
  89  padding-right: 0.5cm;
  90  margin-left: 1cm;
  91 }
  92 -->
  93 </style>
  94 <base target="_self" />
  95 </head>
  96 <body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#0000FF" alink="#0000FF">
  97
  98 <h1><a name="top" id="top">ReadMe f&uuml;r Form E-Mail&nbsp;3.5</a></h1>
  99
 100 <p>
 101 <a href="#wasistfeml">Was ist <i>Form E-Mail</i>?</a><br />
 102 <a href="#einrichten">Einrichten von <i>Form E-Mail</i></a><br />
 103 <a href="#einstellungen">Einstellungen</a><br />
 104 <a href="#individuell">Individuelle Formularfelder</a><br />
 105 <a href="#templates">Templates anpassen</a>
 106 </p>
 107
 108 <h2><a name="wasistfeml" id="wasistfeml">Was ist <i>Form E-Mail</i>?</a></h2>
 109
 110 <p><i>Form E-Mail</i> ist ein in PHP programmierter Form-Mailer, der speziell darauf ausgerichtet ist, ein Kontaktformular zu verarbeiten. Unter Kontaktformular verstehe ich ein Formular mit Feldern f&uuml;r Name und E-Mail-Adresse des Absenders, eines f&uuml;r den Betreff und ein weiteres f&uuml;r den Text der Mail.<br />
 111 Auf diese Weise m&uuml;ssen Sie zum Beispiel nicht &uuml;berall auf Ihrer Homepage Ihre E-Mail-Adresse angeben und sie so nicht der Gefahr aussetzen, ein Opfer von Spammern zu werden.</p>
 112
 113 <p class="upanddown"><a href="#top">Nach oben</a></p>
 114
 115 <h2><a name="einrichten" id="einrichten">Einrichten von <i>Form E-Mail</i></a></h2>
 116
 117 <p>Sie brauchen als erstes ein HTML-Formular. Dieses muss mindestens diese Felder enthalten:</p>
 118
 119 <table border="1">
 120 <tr>
 121 <td><b>Feldname</b></td>
 122 <td><b>Zweck</b></td>
 123 </tr>
 124 <tr>
 125 <td><i>email</i></td>
 126 <td>E-Mail-Adresse des Absenders</td>
 127 </tr>
 128 <tr>
 129 <td><i>name</i></td>
 130 <td>Name des Absenders</td>
 131 </tr>
 132 <tr>
 133 <td><i>text</i></td>
 134 <td>Text der E-Mail</td>
 135 </tr>
 136 </table>
 137
 138 <p>Sie k&ouml;nnen au&szlig;erdem noch ein Feld namens <i>subject</i> anlegen. Hier kann ein Betreff f&uuml;r die Mail eingegeben werden. Wenn Sie auf dieses Feld verzichten, erhalten die E-Mails automatisch den in <code>$default_subject</code> definierten Betreff (s.u.).<br />
 139 Weiterhin ist noch ein Feld namens <i>recipient</i> m&ouml;glich. Dieses Feld enth&auml;lt einen Alias-Empf&auml;nger. Wie das funktioniert, k&ouml;nnen Sie bei der Beschreibung der Einstellung <code>$aliases</code> lesen.</p>
 140
 141 <p>Zus&auml;tzlich k&ouml;nnen Sie die vorgegebenen Formularfelder mit <a href="#individuell">individuellen</a> erg&auml;nzen.</p>
 142
 143 <p>Wenn Sie Captchas (zuf&auml;llige Zeichenfolgen, die der Benutzer vor dem Absenden des Formulars eingeben muss, um Spambots auszuschlie&szlig;en) benutzen wollen (siehe unten), m&uuml;ssen Sie im Formular die Datei <i>captcha.php</i> als Bild einbinden (<code>&lt;img&gt;</code>-Tag). Bedenken Sie, dass Sie diese Datei auch in den <a href="#templates">Templates</a> einbinden m&uuml;ssen!</p>
 144
 145 <p>Das Formular muss dann noch mit <tt>POST</tt> die Daten an die Datei <i>mailer.php</i> (oder wie Sie die Datei genannt haben) senden.</p>
 146
 147 <p>Ein beispielhaftes Formular finden Sie in der Datei <a href="formular.htm" target="_blank"><i>formular.htm</i></a>.</p>
 148
 149 <p>Die Adresse, an der die mit <i>Form E-Mail</i> erzeugte Mail gesendet werden soll, wird in der Datei <i>config.php</i> festgelegt. &Ouml;ffnen Sie die Datei mit einem beliebigen Editor und suchen Sie nach dieser Zeile:</p>
 150
 151 <p><code>$mailto = '';</code></p>
 152
 153 <p>Geben Sie zwischen den einfachen Anf&uuml;hrungszeichen die Adresse an, an die die Mail gehen soll. Wenn die Mail an mehrere Empf&auml;nger gehen soll, so trennen Sie die einzelnen E-Mail-Adressen ganz einfach durch Semikolons.</p>
 154
 155 <p>Sie haben nun <i>Form E-Mail</i> f&uuml;r die Standard-Nutzung konfiguriert. <i>Form E-Mail</i> l&auml;sst sich jedoch noch feiner konfigurieren. Mehr dazu finden Sie in den n&auml;chsten Abschnitten.</p>
 156
 157 <p class="upanddown"><a href="#top">Nach oben</a></p>
 158
 159 <h2><a name="einstellungen" id="einstellungen">Einstellungen</a></h2>
 160
 161 <p><b>Empf&auml;nger</b></p>
 162
 163 <table border="1">
 164 <tr>
 165 <td><b>Einstellung</b></td>
 166 <td><b>Beschreibung</b></td>
 167 </tr>
 168 <tr>
 169 <td><code>$mailto</code></td>
 170 <td>siehe oben</td>
 171 </tr>
 172 <tr>
 173 <td><code>$aliases</code></td>
 174 <td>Hier k&ouml;nnen Sie eine Alias-Namen f&uuml;r Empf&auml;nger angeben. Soll einem Alias mehrere Empf&auml;nger zugeordnet werden, gilt dasselbe wie f&uuml;r <code>$mailto</code>.<br />
 175 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&auml;ren kann, hier ein Beispiel:<br /><br />
 176 <code>array('info' =&gt; 'info@example.com', 'support' =&gt; 'support@example.com',<br />
 177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'alle' =&gt; 'info@example.com; support@example.com')</code></td>
 178 </tr>
 179 </table>
 180
 181 <p><b>Allgemeines</b></p>
 182
 183 <table border="1">
 184 <tr>
 185 <td><b>Einstellung</b></td>
 186 <td><b>Beschreibung</b></td>
 187 </tr>
 188 <tr>
 189 <td><code>$default_subject</code></td>
 190 <td>Der Standard-Betreff. Dieser wird verwendet, wenn der Benutzer keinen Betreff f&uuml;r seine Mail angegeben hat.</td>
 191 </tr>
 192 <tr>
 193 <td><code>$friendly_sender</code></td>
 194 <td>Wenn 1, wird die E-Mail-Adresse des Autors der Mail als Absender angegeben. Bei 0 erscheint das, was der Server als Absender eintr&auml;gt und die E-Mail-Adresse des Absenders wird in den <code>Reply-To</code>-Header eingetragen, so dass beim Antworten auf die E-Mail schon der richtige Empf&auml;nger eingetragen wird. Wenn 2, wird zus&auml;tzlich noch der Name als Absender angegeben.<br />
 195 Bitte setzen Sie diese Option nur auf 0, wenn es wirklich sein muss!</td>
 196 </tr>
 197 <tr>
 198 <td><code>$line_break</code></td>
 199 <td>Legt fest, ab wievielen Zeichen ein automatischer Zeilenumbruch durchgef&uuml;hrt werden soll (0 f&uuml;r keine Zeilenumbr&uuml;che).</td>
 200 </tr>
 201 <tr>
 202 <td><code>$add_header</code></td>
 203 <td>Legt beim Wert&nbsp;1 fest, ob <i>Form E-Mail</i> Informationen zur Zeichencodierung, MIME-Version usw. in den Mail-Header schreiben soll.<br />
 204 Bitte setzen Sie diese Option nur auf 0, wenn es wirklich sein muss!</td>
 205 </tr>
 206 <tr>
 207 <td><code>$timeformat</code></td>
 208 <td>Legt das Aussehen der Zeitangaben der Mail fest. Was hier alles m&ouml;glich ist, finden Sie im PHP-Handbuch bei der <a href="http://www.php.net/manual/de/function.strftime.php">Beschreibung zu <code>strftime()</code></a>.<br />
 209 Beachten Sie bitte, dass bei neueren PHP-Versionen, trotz deutscher Spracheinstellungen, die Namen von Wochentagen und Monaten englisch dargestellt werden. Es handelt sich hierbei aber um ein allgemeines Problem.</td>
 210 </tr>
 211 <tr>
 212 <td><code>$return_url</code></td>
 213 <td>Geben Sie hier die URL einer Seite an, auf die nach dem erfolgreichen Versenden einer Mail weitergeleitet werden soll. Wenn Sie hier nichts angeben, wird eine per Template formatierte Seite angezeigt.<br />
 214 <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>
 215 </tr>
 216 <tr>
 217 <td><code>$allowed_envs</code></td>
 218 <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 />
 219 Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 220 </tr>
 221 <tr>
 222 <td><code>$charset</code></td>
 223 <td>Geben Sie hier den Zeichensatz, der f&uuml;r die E-Mail verwendet werden soll, an.</td>
 224 </tr>
 225 <tr>
 226 <td><code>$timezone</code></td>
 227 <td>Geben Sie hier Ihre Zeitzone an (dies ist bei neueren PHP-Versionen n&ouml;tig, da ansonsten eine Fehlermeldung auftreten kann).</td>
 228 </tr>
 229 </table>
 230
 231 <p><b>L&auml;ngen&uuml;berpr&uuml;fungen</b></p>
 232
 233 <table border="1">
 234 <tr>
 235 <td><b>Einstellung</b></td>
 236 <td><b>Beschreibung</b></td>
 237 </tr>
 238 <tr>
 239 <td><code>$name_min</code></td>
 240 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Name mindestens sein muss (0 =&nbsp;beliebig lang)</td>
 241 </tr>
 242 <tr>
 243 <td><code>$subject_min</code></td>
 244 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Betreff mindestens sein muss (0 =&nbsp;beliebig lang)</td>
 245 </tr>
 246 <tr>
 247 <td><code>$text_min</code></td>
 248 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Text mindestens sein muss (0 =&nbsp;beliebig lang)</td>
 249 </tr>
 250 <tr>
 251 <td><code>$name_max</code></td>
 252 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Name h&ouml;chstens sein darf (0 =&nbsp;beliebig lang)</td>
 253 </tr>
 254 <tr>
 255 <td><code>$subject_max</code></td>
 256 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Betreff h&ouml;chstens sein darf (0 =&nbsp;beliebig lang)</td>
 257 </tr>
 258 <tr>
 259 <td><code>$text_max</code></td>
 260 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Text h&ouml;chstens sein darf (0 =&nbsp;beliebig lang)</td>
 261 </tr>
 262 </table>
 263
 264 <p><b>Sicherheit</b></p>
 265
 266 <table border="1">
 267 <tr>
 268 <td><b>Einstellung</b></td>
 269 <td><b>Beschreibung</b></td>
 270 </tr>
 271 <tr>
 272 <td><code>$check_referer</code></td>
 273 <td>Wenn &gt; 0, &uuml;berpr&uuml;ft <i>Form E-Mail</i> die Host-Angabe im HTTP-Referer. Das ist n&uuml;tzlich, wenn Sie verhindern wollen, dass irgendjemand Ihr Script f&uuml;r sich ausnutzt.</td>
 274 </tr>
 275 <tr>
 276 <td><code>$referer_ok</code></td>
 277 <td>Geben Sie hier die Hosts an, von denen <i>Form E-Mail</i> aus aufgerufen werden darf (zum Beispiel <i>www.example.com</i>). Trennen Sie mehrere Hosts durch Semikolons.<br />
 278 <b style="color:#FF0000">Achtung:</b> Mit einer Referer-Pr&uuml;fung kann man zwar unbedarfte Anwender abschrecken, aber wirklich zuverl&auml;ssig ist diese Methode nicht, da sich der Referer f&auml;lschen l&auml;sst oder auch komplett fehlen kann.</td>
 279 </tr>
 280 </table>
 281
 282 <p><b>Mails speichern</b></p>
 283
 284 <table border="1">
 285 <tr>
 286 <td><b>Einstellung</b></td>
 287 <td><b>Beschreibung</b></td>
 288 </tr>
 289 <tr>
 290 <td><code>$store_mails</code></td>
 291 <td>Wenn &gt; 0, speichert <i>Form E-Mail</i> die Mails nach dem Versenden noch auf dem Server als Datei ab.</td>
 292 </tr>
 293 <tr>
 294 <td><code>$store_mails_dir</code></td>
 295 <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>
 296 </tr>
 297 <tr>
 298 <td><code>$store_mails_prefix</code></td>
 299 <td>Geben Sie hier einen Pr&auml;fix an, der den Dateinamen der gespeicherten Mails vorangestellt werden soll (Standard ist <i>feml_</i>).</td>
 300 </tr>
 301 <tr>
 302 <td><code>$store_mails_max</code></td>
 303 <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>
 304 </tr>
 305 </table>
 306
 307 <p><b>Captchas</b></p>
 308
 309 <table border="1">
 310 <tr>
 311 <td><b>Einstellung</b></td>
 312 <td><b>Beschreibung</b></td>
 313 </tr>
 314 <tr>
 315 <td><code>$captcha_enable</code></td>
 316 <td>Wenn &gt; 0, wird die Captcha-&Uuml;berpr&uuml;fung aktiviert.</td>
 317 </tr>
 318 <tr>
 319 <td><code>$captcha_case</code></td>
 320 <td>Wenn 1, wird bei Captchas auf Gro&szlig;- und Kleinschreibung geachtet. Beachten Sie bitte, dass bei deaktiverter Einstellung im Captcha selbst immer noch Gro&szlig;- und Kleinbuchstaben angezeigt werden - lediglich bei der Auswertung wird die Gro&szlig;- und Kleinschreibung nicht ber&uuml;cksichtigt.</td>
 321 </tr>
 322 <tr>
 323 <td><code>$captcha_max</code></td>
 324 <td>Wenn &gt; 0, ist nur eine bestimmte Anzahl von Fehlversuchen bei der Eingabe des Captcha-Texts m&ouml;glich.</td>
 325 </tr>
 326 <tr>
 327 <td><code>$captcha_length</code></td>
 328 <td>Geben Sie hier die L&auml;nge des Captcha-Textes an.</td>
 329 </tr>
 330 <tr>
 331 <td><code>$captcha_width</code></td>
 332 <td>Geben Sie hier die Breite des Captcha-Bilds an (in Pixeln). Dieser Wert wird &uuml;berschrieben, wenn <code>$captcha_image_bg</code> gesetzt ist.</td>
 333 </tr>
 334 <tr>
 335 <td><code>$captcha_height</code></td>
 336 <td>Geben Sie hier die H&ouml;he des Captcha-Bilds an (in Pixeln). Dieser Wert wird &uuml;berschrieben, wenn <code>$captcha_image_bg</code> gesetzt ist.</td>
 337 </tr>
 338 <tr>
 339 <td><code>$captcha_angle</code></td>
 340 <td>Geben Sie hier den Winkel-Bereich an, in dem der Captcha-Text ausgerichtet werden soll. Es wird ein zuf&auml;lliger Wert aus diesem Bereich ausgew&auml;hlt.</td>
 341 </tr>
 342 <tr>
 343 <td><code>$captcha_x</code></td>
 344 <td>Geben Sie hier den Bereich an, in dem sich der horizontale Startpunkt des Captcha-Texts befinden soll. Es wird ein zuf&auml;lliger Wert aus diesem Bereich ausgew&auml;hlt.</td>
 345 </tr>
 346 <tr>
 347 <td><code>$captcha_y</code></td>
 348 <td>Geben Sie hier den Bereich an, in dem sich der vertikale Startpunkt des Captcha-Texts befinden soll. Es wird ein zuf&auml;lliger Wert aus diesem Bereich ausgew&auml;hlt.</td>
 349 </tr>
 350 <tr>
 351 <td><code>$captcha_possible</code></td>
 352 <td>Geben Sie hier die m&ouml;glichen Zeichen des Captcha-Texts an. Standardm&auml;&szlig;ig vorgegeben ist <i>'ABCDEFGHJKLMNPRSTUVWXYZabcdefghijkmnpqrstuvwxyz23456789'</i>.</td>
 353 </tr>
 354 <tr>
 355 <td><code>$captcha_font</code></td>
 356 <td>Schriftart f&uuml;r den Captcha-Text. Geben Sie hier den Pfad zu einer <i>.ttf</i>-Datei an. Standardm&auml;&szlig;ig ist hier die mitgelieferte <i>XFILES.TTF</i> angegeben.</td>
 357 </tr>
 358 <tr>
 359 <td><code>$captcha_font_size</code></td>
 360 <td>Geben Sie hier die Schriftgr&ouml;&szlig;e des Captcha-Textes an.</td>
 361 </tr>
 362 <tr>
 363 <td><code>$captcha_lines</code></td>
 364 <td>Wenn &gt; 0, werden zuf&auml;llige St&ouml;rlinien in das Captcha-Bild eingef&uuml;gt.</td>
 365 </tr>
 366 <tr>
 367 <td><code>$captcha_color_bg</code></td>
 368 <td>Geben Sie hier die RGB-Werte (in Form eines PHP-Arrays) der Hintergrundfarbe des Captcha-Bilds an.</td>
 369 </tr>
 370 <tr>
 371 <td><code>$captcha_color_text</code></td>
 372 <td>Geben Sie hier die RGB-Werte (in Form eines PHP-Arrays) der Textfarbe des Captcha-Bilds an.</td>
 373 </tr>
 374 <tr>
 375 <td><code>$captcha_image_bg</code></td>
 376 <td>Hier k&ouml;nnen Sie, wenn Sie m&ouml;chten, ein Hintergrundbild f&uuml;r das Captcha-Bild angeben. Diese Option &uuml;berschreibt <code>$captcha_length</code> und <code>$captcha_height</code> mit den Angaben aus dem Bild.</td>
 377 </tr>
 378 </table>
 379
 380 <p><b>Fehlermeldungen</b></p>
 381
 382 <table border="1">
 383 <tr>
 384 <td><b>Einstellung</b></td>
 385 <td><b>Beschreibung</b></td>
 386 </tr>
 387 <tr>
 388 <td><code>$err_nothing</code></td>
 389 <td>Der Benutzer hat &uuml;berhaupt nichts eingegeben</td>
 390 </tr>
 391 <tr>
 392 <td><code>$err_no_name</code></td>
 393 <td>Der Benutzer hat keinen Namen angegeben</td>
 394 </tr>
 395 <tr>
 396 <td><code>$err_no_email</code></td>
 397 <td>Der Benutzer hat keine E-Mail-Adresse angegeben</td>
 398 </tr>
 399 <tr>
 400 <td><code>$err_invalid_email</code></td>
 401 <td>Der Benutzer hat eine von der Syntax her ung&uuml;ltige E-Mail-Adresse angegeben</td>
 402 </tr>
 403 <tr>
 404 <td><code>$err_no_text</code></td>
 405 <td>Der Benutzer hat keinen Text angegeben</td>
 406 </tr>
 407 <tr>
 408 <td><code>$err_name_short</code></td>
 409 <td>Der vom Benutzer eingegebene Name ist nicht lang genug</td>
 410 </tr>
 411 <tr>
 412 <td><code>$err_subject_short</code></td>
 413 <td>Der vom Benutzer eingegebene Betreff ist nicht lang genug</td>
 414 </tr>
 415 <tr>
 416 <td><code>$err_text_short</code></td>
 417 <td>Der vom Benutzer eingegebene Text ist nicht lang genug</td>
 418 </tr>
 419 <tr>
 420 <td><code>$err_name_long</code></td>
 421 <td>Der vom Benutzer eingegebene Name ist nicht zu lang</td>
 422 </tr>
 423 <tr>
 424 <td><code>$err_subject_long</code></td>
 425 <td>Der vom Benutzer eingegebene Betreff ist zu lang</td>
 426 </tr>
 427 <tr>
 428 <td><code>$err_text_long</code></td>
 429 <td>Der vom Benutzer eingegebene Text ist zu lang</td>
 430 </tr>
 431 <tr>
 432 <td><code>$err_send_error</code></td>
 433 <td>Die Mail konnte nicht versendet werden</td>
 434 </tr>
 435 <tr>
 436 <td><code>$err_store_error</code></td>
 437 <td>Die Mail konnte nicht gespeichert werden</td>
 438 </tr>
 439 <tr>
 440 <td><code>$err_only_post</code></td>
 441 <td><i>Form E-Mail</i> darf nur mit <tt>POST</tt> aufgerufen werden</td>
 442 </tr>
 443 <tr>
 444 <td><code>$err_referer_not_ok</code></td>
 445 <td>Der im HTTP-Referer angegebene Host darf keine Mails &uuml;ber das Script senden</td>
 446 </tr>
 447 <tr>
 448 <td><code>$err_indiv_errmsg_miss</code></td>
 449 <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>
 450 </tr>
 451 <tr>
 452 <td><code>$err_captcha_incorrect</code></td>
 453 <td>Der vom Benutzer eingegebene Captcha-Code ist nicht korrekt</td>
 454 </tr>
 455 <tr>
 456 <td><code>$err_captcha_max</code></td>
 457 <td>Der Benutzer hat den Captcha-Code zu oft falsch eingegeben</td>
 458 </tr>
 459 <tr>
 460 <td><code>$err_captcha_disabled</code></td>
 461 <td>Wird angezeigt, wenn <i>captcha.php</i> aufgerufen wird und Captchas eigentlich deaktiviert sind.</td>
 462 </tr>
 463 <tr>
 464 <td><code>$err_captcha_session_failure</code></td>
 465 <td>Wird angezeigt, wenn keine Session-Variablen gefunden werden konnten.</td>
 466 </tr>
 467 </table>
 468
 469 <p><b>Pfade zu Templates</b></p>
 470
 471 <table border="1">
 472 <tr>
 473 <td><b>Einstellung</b></td>
 474 <td><b>Beschreibung</b></td>
 475 </tr>
 476 <tr>
 477 <td><code>$tpl_mail</code></td>
 478 <td>Template f&uuml;r die Mail</td>
 479 </tr>
 480 <tr>
 481 <td><code>$tpl_sent</code></td>
 482 <td>Die Mail wurde erfolgreich versendet</td>
 483 </tr>
 484 <tr>
 485 <td><code>$tpl_user_error</code></td>
 486 <td>Der Benutzer hat etwas falsch gemacht</td>
 487 </tr>
 488 <tr>
 489 <td><code>$tpl_fatal</code></td>
 490 <td>Es ist ein Fehler aufgetreten, den der Benutzer nicht mehr beheben kann</td>
 491 </tr>
 492 </table>
 493
 494 <p class="upanddown"><a href="#top">Nach oben</a></p>
 495
 496 <h2><a name="individuell" id="individuell">Individuelle Formularfelder</a></h2>
 497
 498 <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 />
 499 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>
 500
 501 <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>
 502
 503 <p><code>&lt;input type=&quot;text&quot; name=&quot;beruf&quot; /&gt;</code></p>
 504
 505 <p>Der Name des Feldes lautet also <b>beruf</b>. Dies ben&ouml;tigen wir f&uuml;r die weitere Definition.</p>
 506
 507 <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>
 508
 509 <table border="1">
 510 <tr>
 511 <td><b>Einstellung</b></td>
 512 <td><b>Beschreibung</b></td>
 513 </tr>
 514 <tr>
 515 <td><code>$user_fields['beruf']['min']</code></td>
 516 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert mindestens sein muss</td>
 517 </tr>
 518 <tr>
 519 <td><code>$user_fields['beruf']['max']</code></td>
 520 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert h&ouml;chstens sein darf</td>
 521 </tr>
 522 <tr>
 523 <td><code>$user_fields['beruf']['required']</code></td>
 524 <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>
 525 </tr>
 526 <tr>
 527 <td><code>$user_fields['beruf']['regex']</code></td>
 528 <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>
 529 </tr>
 530 <tr>
 531 <td><code>$user_fields['beruf']['check']</code></td>
 532 <td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert gepr&uuml;ft werden soll. Das erste und einzige Argument der Funktion ist der Inhalt des Formularfeldes. Die Funktion muss <code>true</code> zur&uuml;ckgeben, wenn der Wert in Ordnung ist, ansonsten <code>false</code>.</td>
 533 </tr>
 534 </table>
 535
 536 <p>Weiterhin m&uuml;ssen Sie noch diverse Fehlermeldungen definieren (als Unter-Array). Das Definieren dieser Fehlermeldungen ist Pflicht (Sie m&uuml;ssen jedoch nur die Fehlermeldungen zu den Dingen definieren, die auch wirklich gepr&uuml;ft werden).</p>
 537
 538 <table border="1">
 539 <tr>
 540 <td><b>Einstellung</b></td>
 541 <td><b>Beschreibung</b></td>
 542 </tr>
 543 <tr>
 544 <td><code>$user_fields['beruf']['errors']['too_short']</code></td>
 545 <td>Der vom Benutzer eingegebene Wert ist nicht lang genug</td>
 546 </tr>
 547 <tr>
 548 <td><code>$user_fields['beruf']['errors']['too_long']</code></td>
 549 <td>Der vom Benutzer eingegebene Wert ist zu lang</td>
 550 </tr>
 551 <tr>
 552 <td><code>$user_fields['beruf']['errors']['not_set']</code></td>
 553 <td>Das Formularfeld ist ein Pflichtfeld und es wurde nicht ausgef&uuml;llt.</td>
 554 </tr>
 555 <tr>
 556 <td><code>$user_fields['beruf']['errors']['match_fail']</code></td>
 557 <td>Die &Uuml;berpr&uuml;fung des Wertes durch den regul&auml;ren Ausdruck ist fehlgeschlagen.</td>
 558 </tr>
 559 <tr>
 560 <td><code>$user_fields['beruf']['errors']['check_fail']</code></td>
 561 <td>Die &Uuml;berpr&uuml;fung des Wertes durch die PHP-Funktion ist fehlgeschlagen.</td>
 562 </tr>
 563 </table>
 564
 565 <p>Zus&auml;tzlich sind noch die folgenden Einstellungen m&ouml;glich:</p>
 566
 567 <table border="1">
 568 <tr>
 569 <td><b>Einstellung</b></td>
 570 <td><b>Beschreibung</b></td>
 571 </tr>
 572 <tr>
 573 <td><code>$user_fields['beruf']['prepare']</code></td>
 574 <td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, die den Wert des Formularfeldes nach den Pr&uuml;fungen noch ver&auml;ndern (bspw. kann man hier Funktionen angeben, die alle Buchstaben in Gro&szlig;buchstaben umwandelt). Das erste und einzige Argument der Funktion ist der Inhalt des Formularfeldes. Die Funktion muss den bearbeiteten Wert zur&uuml;ckgeben.</td>
 575 </tr>
 576 <tr>
 577 <td><code>$user_fields['beruf']['tpl_var']</code></td>
 578 <td>Geben Sie hier die <a href="#templates">Template-Variable</a> 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 <b>beruf</b> w&auml;re das dann <code>USER_beruf</code>).</td>
 579 </tr>
 580 </table>
 581
 582 <p>Sie m&uuml;ssen die individuellen Formularfelder nun noch in Ihrem Mail-Formular und in den <a href="#templates">Templates</a> erg&auml;nzen.</p>
 583
 584 <p>Es folgt Beispiel-Konfiguration f&uuml;r ein Formularfeld namens <i>beruf</i>:</p>
 585
 586 <pre>
 587 $user_fields['beruf']['min'] = 5;
 588 $user_fields['beruf']['max'] = 10;
 589 $user_fields['beruf']['required'] = 1;
 590 $user_fields['beruf']['regex'] = '/^[A-Za-z]+$/';
 591 $user_fields['beruf']['check'] = 'check_beruf';
 592 $user_fields['beruf']['prepare'] = 'prepare_beruf';
 593 $user_fields['beruf']['tpl_var'] = 'BERUF';
 594
 595 $user_fields['beruf']['errors']['too_short'] = 'Der Beruf muss mind. 5 Zeichen lang sein!';
 596 $user_fields['beruf']['errors']['too_long'] = 'Der Beruf darf h&ouml;chstens 10 Zeichen lang sein!';
 597 $user_fields['beruf']['errors']['not_set'] = 'Sie haben keinen Beruf eingegeben!';
 598 $user_fields['beruf']['errors']['match_fail'] = 'Der Beruf darf nur aus Buchstaben bestehen!';
 599 $user_fields['beruf']['errors']['check_fail'] = 'Der Beruf sollte keine &auml;&ouml;&uuml; haben!';
 600
 601 # Beispiel-Check-Funktion
 602
 603 function check_beruf($content) {
 604     if(strpos($content,'&auml;') !== false) return false;
 605     if(strpos($content,'&ouml;') !== false) return false;
 606     if(strpos($content,'&uuml;') !== false) return false;
 607
 608     return true;
 609 }
 610
 611 # Beispiel-Vorbereitungs-Funktion
 612
 613 function prepare_beruf($content) {
 614     return strtolower($content);
 615 }
 616 </pre>
 617
 618 <p>Das Formularfeld hat die folgenden Eigenschaften:</p>
 619
 620 <ul>
 621 <li>Der Beruf muss aus mind. 5 Zeichen und max. 10 Zeichen bestehen (<code>min</code> und <code>max</code>)</li>
 622 <li>Das Formularfeld ist ein Pflichtfeld (<code>required</code>)</li>
 623 <li>Es sind nur die Buchstaben A-Z (gro&szlig; und klein) erlaubt (<code>regex</code>)</li>
 624 <li>&Uuml;ber die Pr&uuml;ffunktion <code>check_beruf()</code> wird verhindert, dass &auml;, &ouml; und &uuml; angegeben werden (das wird nat&uuml;rlich auch durch den regul&auml;ren Ausdruck ausgeschlossen, es soll lediglich zur Verdeutlichung dienen)</li>
 625 <li>Durch die Vorbereitungsfunktion <code>prepare_beruf()</code> werden alle Gro&szlig;buchstaben in Kleinbuchstaben umgewandelt</li>
 626 <li>In den Templates wird die Variable <code>{BERUF}</code> durch den Inhalt des Formularfeldes ersetzt (<code>tpl_var</code>)</li>
 627 <li>Die Fehlermeldungen sollten selbsterkl&auml;rend sein</li>
 628 </ul>
 629
 630 <p class="upanddown"><a href="#top">Nach oben</a></p>
 631
 632 <h2><a name="templates" id="templates">Templates anpassen</a></h2>
 633
 634 <p>Die Anpassung der Ausgaben von <i>Form E-Mail</i> erfolgt &uuml;ber Templates (englisch f&uuml;r &quot;Vorlagen&quot;). Jede der Templates enth&auml;lt Variablen der Form <b>{VARIABLENNAME}</b>, die dann von <i>Form E-Mail</i> durch entsprechende Daten ersetzt werden.</p>
 635
 636 <p>Hier nun eine Auflistung der einzelnen Templates und der verwendeten Variablen (ohne geschweifte Klammern):</p>
 637
 638 <table border="1">
 639 <tr>
 640 <td width="20%"><b>Datei</b></td>
 641 <td width="40%"><b>Zweck</b></td>
 642 <td width="40%"><b>Verwendete Variablen</b></td>
 643 </tr>
 644 <tr>
 645 <td><i>fatal.htm</i></td>
 646 <td>Wird angezeigt, wenn ein Fehler aufgetreten ist, den der Benutzer nicht mehr beheben kann</td>
 647 <td>
 648 <ul>
 649 <li><b>ERROR</b><br />
 650 Die Fehlermeldung</li>
 651 </ul>
 652 </td>
 653 </tr>
 654 <tr>
 655 <td><i>mail.txt</i></td>
 656 <td>Legt das Aussehen der Mail fest</td>
 657 <td>
 658 <ul>
 659 <li><b>EMAIL</b><br />
 660 Die eingegebene E-Mail-Adresse</li>
 661 <li><b>NAME</b><br />
 662 Der eingegebene Name</li>
 663 <li><b>SUBJECT</b><br />
 664 Der Betreff der Mail</li>
 665 <li><b>TEXT</b><br />
 666 Der eingegebene Mail-Text</li>
 667 <li><b>TIME</b><br />
 668 Die formatierte Zeitangabe</li>
 669 </ul>
 670
 671 Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben haben) verwenden.<br />
 672 <br />
 673 Zus&auml;tzlich k&ouml;nnen Sie hier durch Variablen, die mit <b>ENV_</b> beginnen, Server-Umgebungsvariablen im Text einf&uuml;gen (siehe auch Konfigurationsvariable <code>$allowed_envs</code>.
 674 </td>
 675 </tr>
 676 <tr>
 677 <td><i>sent.htm</i></td>
 678 <td>Wird angezeigt, wenn die Mail erfolgreich versendet wurde</td>
 679 <td>
 680 <ul>
 681 <li><b>EMAIL</b><br />
 682 Die eingegebene E-Mail-Adresse</li>
 683 <li><b>MAIL</b><br />
 684 Die komplette Mail, so wie sie versendet wurde (nat&uuml;rlich ohne Header)</li>
 685 <li><b>NAME</b><br />
 686 Der eingegebene Name</li>
 687 <li><b>SUBJECT</b><br />
 688 Der Betreff der Mail</li>
 689 <li><b>TEXT</b><br />
 690 Der eingegebene Mail-Text</li>
 691 <li><b>TIME</b><br />
 692 Die formatierte Zeitangabe</li>
 693 </ul>
 694
 695 Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben haben) verwenden.
 696 </td>
 697 </tr>
 698 <tr>
 699 <td><i>user_error.htm</i></td>
 700 <td>Wird angezeigt, wenn der Benutzer einen Fehler gemacht hat, der sich aber noch beheben l&auml;sst (zum Beispiel wenn ein Formularfeld nicht ausgef&uuml;llt wurde)</td>
 701 <td>
 702 <ul>
 703 <li><b>EMAIL</b><br />
 704 Die eingegebene E-Mail-Adresse</li>
 705 <li><b>ERROR</b><br />
 706 Die Fehlermeldung</li>
 707 <li><b>NAME</b><br />
 708 Der eingegebene Name</li>
 709 <li><b>SUBJECT</b><br />
 710 Der Betreff der Mail</li>
 711 <li><b>TEXT</b><br />
 712 Der eingegebene Mail-Text</li>
 713 </ul>
 714
 715 Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben haben) verwenden.<br />
 716 <br />
 717 Zus&auml;tzlich ist es m&ouml;glich, einen Bereich, der nur angezeigt werden soll, wenn Captchas aktiviert sind, anzuzeigen, indem Sie diesen in folgenden Block einschlie&szlig;en (der <code>{ELSE}</code>-Teil ist optional):<br />
 718 <br />
 719 <code>{IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF}</code>
 720 </td>
 721 </tr>
 722 </table>
 723
 724 <p>&nbsp;</p>
 725
 726 <hr width="80%" noshade="noshade" />
 727
 728 <p><a href="changes.htm">Versionshistorie</a></p>
 729
 730 <hr width="80%" noshade="noshade" />
 731
 732 <p style="font-size:8pt">&copy;&nbsp;2002-2012 Patrick Canterino</p>
 733
 734 <table border="0" cellspacing="0" style="font-size:8pt">
 735 <tr>
 736 <td>Homepage:</td>
 737 <td><a href="http://www.patshaping.de/" target="_blank">http://www.patshaping.de/</a></td>
 738 </tr>
 739 <tr>
 740 <td><a name="bottom" id="bottom">E-Mail:</a></td>
 741 <td><a href="mailto:patrick@patshaping.de">patrick@patshaping.de</a></td>
 742 </tr>
 743 </table>
 744 </body>
 745 </html>