]> git.p6c8.net - form-email.git/blob - readme.htm
ad07faa763620a9999fc6395d979cd9de8f0e727
[form-email.git] / 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.5cm;
71 padding-right: 0.5cm;
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>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>
142
143 <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>
144
145 <p>Ein beispielhaftes Formular finden Sie in der Datei <a href="formular.htm" target="_blank"><i>formular.htm</i></a>.</p>
146
147 <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>
148
149 <p><code>$mailto = '';</code></p>
150
151 <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>
152
153 <p>Das war es im Grunde genommen. Aber <i>Form E-Mail</i> l&auml;sst sich noch weiter konfigurieren. Mehr dazu finden Sie in den n&auml;chsten beiden Abschnitten.</p>
154
155 <p class="upanddown"><a href="#top">Nach oben</a></p>
156
157 <h2><a name="einstellungen" id="einstellungen">Einstellungen</a></h2>
158
159 <p><b>Empf&auml;nger</b></p>
160
161 <table border="1">
162 <tr>
163 <td><b>Einstellung</b></td>
164 <td><b>Beschreibung</b></td>
165 </tr>
166 <tr>
167 <td><code>$mailto</code></td>
168 <td>siehe oben</td>
169 </tr>
170 <tr>
171 <td><code>$aliases</code></td>
172 <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 />
173 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 />
174 <code>array('info' =&gt; 'info@IhreDomain.xyz', 'support' =&gt; 'support@IhreDomain.xyz',<br />
175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'alle' =&gt; 'info@IhreDomain.xyz; support@IhreDomain.xyz')</code></td>
176 </tr>
177 </table>
178
179 <p><b>Allgemeines</b></p>
180
181 <table border="1">
182 <tr>
183 <td><b>Einstellung</b></td>
184 <td><b>Beschreibung</b></td>
185 </tr>
186 <tr>
187 <td><code>$default_subject</code></td>
188 <td>Der Standard-Betreff. Dieser wird verwendet, wenn der Benutzer keinen Betreff f&uuml;r seine Mail angegeben hat.</td>
189 </tr>
190 <tr>
191 <td><code>$friendly_sender</code></td>
192 <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 />
193 Bitte setzen Sie diese Option nur auf 0, wenn es wirklich sein muss!</td>
194 </tr>
195 <tr>
196 <td><code>$line_break</code></td>
197 <td>Legt fest, ab wievielen Zeichen ein automatischer Zeilenumbruch durchgef&uuml;hrt werden soll (0 f&uuml;r keine Zeilenumbr&uuml;che).</td>
198 </tr>
199 <tr>
200 <td><code>$add_header</code></td>
201 <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 />
202 Bitte setzen Sie diese Option nur auf 0, wenn es wirklich sein muss!</td>
203 </tr>
204 <tr>
205 <td><code>$timeformat</code></td>
206 <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 />
207 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>
208 </tr>
209 <tr>
210 <td><code>$return_url</code></td>
211 <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 />
212 <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>
213 </tr>
214 <tr>
215 <td><code>$allowed_envs</code></td>
216 <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 />
217 Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
218 </tr>
219 <tr>
220 <td><code>$charset</code></td>
221 <td>Geben Sie hier den Zeichensatz, der f&uuml;r die E-Mail verwendet werden soll, an.</td>
222 </tr>
223 <tr>
224 <td><code>$timezone</code></td>
225 <td>Geben Sie hier Ihre Zeitzone an (dies ist bei neueren PHP-Versionen n&ouml;tig, da ansonsten eine Fehlermeldung auftreten kann).</td>
226 </tr>
227 </table>
228
229 <p><b>L&auml;ngen&uuml;berpr&uuml;fungen</b></p>
230
231 <table border="1">
232 <tr>
233 <td><b>Einstellung</b></td>
234 <td><b>Beschreibung</b></td>
235 </tr>
236 <tr>
237 <td><code>$name_min</code></td>
238 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Name mindestens sein muss (0 =&nbsp;beliebig lang)</td>
239 </tr>
240 <tr>
241 <td><code>$subject_min</code></td>
242 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Betreff mindestens sein muss (0 =&nbsp;beliebig lang)</td>
243 </tr>
244 <tr>
245 <td><code>$text_min</code></td>
246 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Text mindestens sein muss (0 =&nbsp;beliebig lang)</td>
247 </tr>
248 <tr>
249 <td><code>$name_max</code></td>
250 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Name h&ouml;chstens sein darf (0 =&nbsp;beliebig lang)</td>
251 </tr>
252 <tr>
253 <td><code>$subject_max</code></td>
254 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Betreff h&ouml;chstens sein darf (0 =&nbsp;beliebig lang)</td>
255 </tr>
256 <tr>
257 <td><code>$text_max</code></td>
258 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Text h&ouml;chstens sein darf (0 =&nbsp;beliebig lang)</td>
259 </tr>
260 </table>
261
262 <p><b>Sicherheit</b></p>
263
264 <table border="1">
265 <tr>
266 <td><b>Einstellung</b></td>
267 <td><b>Beschreibung</b></td>
268 </tr>
269 <tr>
270 <td><code>$check_referer</code></td>
271 <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>
272 </tr>
273 <tr>
274 <td><code>$referer_ok</code></td>
275 <td>Geben Sie hier die Hosts an, von denen <i>Form E-Mail</i> aus aufgerufen werden darf (zum Beispiel <i>www.IhreDomain.xyz</i>). Trennen Sie mehrere Hosts durch Semikolons.<br />
276 <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>
277 </tr>
278 </table>
279
280 <p><b>Mails speichern</b></p>
281
282 <table border="1">
283 <tr>
284 <td><b>Einstellung</b></td>
285 <td><b>Beschreibung</b></td>
286 </tr>
287 <tr>
288 <td><code>$store_mails</code></td>
289 <td>Wenn &gt; 0, speichert <i>Form E-Mail</i> die Mails nach dem Versenden noch auf dem Server als Datei ab.</td>
290 </tr>
291 <tr>
292 <td><code>$store_mails_dir</code></td>
293 <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>
294 </tr>
295 <tr>
296 <td><code>$store_mails_prefix</code></td>
297 <td>Geben Sie hier einen Pr&auml;fix an, der den Dateinamen der gespeicherten Mails vorangestellt werden soll (Standard ist <i>feml_</i>).</td>
298 </tr>
299 <tr>
300 <td><code>$store_mails_max</code></td>
301 <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>
302 </tr>
303 </table>
304
305 <p><b>Captchas</b></p>
306
307 <table border="1">
308 <tr>
309 <td><b>Einstellung</b></td>
310 <td><b>Beschreibung</b></td>
311 </tr>
312 <tr>
313 <td><code>$captcha_enable</code></td>
314 <td>Wenn &gt; 0, wird die Captcha-&Uuml;berpr&uuml;fung aktiviert.</td>
315 </tr>
316 <tr>
317 <td><code>$captcha_case</code></td>
318 <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>
319 </tr>
320 <tr>
321 <td><code>$captcha_max</code></td>
322 <td>Wenn &gt; 0, ist nur eine bestimmte Anzahl von Fehlversuchen bei der Eingabe des Captcha-Texts m&ouml;glich.</td>
323 </tr>
324 <tr>
325 <td><code>$captcha_length</code></td>
326 <td>Geben Sie hier die L&auml;nge des Captcha-Textes an.</td>
327 </tr>
328 <tr>
329 <td><code>$captcha_width</code></td>
330 <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>
331 </tr>
332 <tr>
333 <td><code>$captcha_height</code></td>
334 <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>
335 </tr>
336 <tr>
337 <td><code>$captcha_angle</code></td>
338 <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>
339 </tr>
340 <tr>
341 <td><code>$captcha_x</code></td>
342 <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>
343 </tr>
344 <tr>
345 <td><code>$captcha_y</code></td>
346 <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>
347 </tr>
348 <tr>
349 <td><code>$captcha_possible</code></td>
350 <td>Geben Sie hier die m&ouml;glichen Zeichen des Captcha-Texts an. Standardm&auml;&szlig;ig vorgegeben ist <i>'ABCDEFGHJKLMNPRSTUVWXYZabcdefghijkmnpqrstuvwxyz23456789'</i>.</td>
351 </tr>
352 <tr>
353 <td><code>$captcha_font</code></td>
354 <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>
355 </tr>
356 <tr>
357 <td><code>$captcha_font_size</code></td>
358 <td>Geben Sie hier die Schriftgr&ouml;&szlig;e des Captcha-Textes an.</td>
359 </tr>
360 <tr>
361 <td><code>$captcha_lines</code></td>
362 <td>Wenn &gt; 0, werden zuf&auml;llige St&ouml;rlinien in das Captcha-Bild eingef&uuml;gt.</td>
363 </tr>
364 <tr>
365 <td><code>$captcha_color_bg</code></td>
366 <td>Geben Sie hier die RGB-Werte (in Form eines PHP-Arrays) der Hintergrundfarbe des Captcha-Bilds an.</td>
367 </tr>
368 <tr>
369 <td><code>$captcha_color_text</code></td>
370 <td>Geben Sie hier die RGB-Werte (in Form eines PHP-Arrays) der Textfarbe des Captcha-Bilds an.</td>
371 </tr>
372 <tr>
373 <td><code>$captcha_image_bg</code></td>
374 <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>
375 </tr>
376 </table>
377
378 <p><b>Fehlermeldungen</b></p>
379
380 <table border="1">
381 <tr>
382 <td><b>Einstellung</b></td>
383 <td><b>Beschreibung</b></td>
384 </tr>
385 <tr>
386 <td><code>$err_nothing</code></td>
387 <td>Der Benutzer hat &uuml;berhaupt nichts eingegeben</td>
388 </tr>
389 <tr>
390 <td><code>$err_no_name</code></td>
391 <td>Der Benutzer hat keinen Namen angegeben</td>
392 </tr>
393 <tr>
394 <td><code>$err_no_email</code></td>
395 <td>Der Benutzer hat keine E-Mail-Adresse angegeben</td>
396 </tr>
397 <tr>
398 <td><code>$err_invalid_email</code></td>
399 <td>Der Benutzer hat eine von der Syntax her ung&uuml;ltige E-Mail-Adresse angegeben</td>
400 </tr>
401 <tr>
402 <td><code>$err_no_text</code></td>
403 <td>Der Benutzer hat keinen Text angegeben</td>
404 </tr>
405 <tr>
406 <td><code>$err_name_short</code></td>
407 <td>Der vom Benutzer eingegebene Name ist nicht lang genug</td>
408 </tr>
409 <tr>
410 <td><code>$err_subject_short</code></td>
411 <td>Der vom Benutzer eingegebene Betreff ist nicht lang genug</td>
412 </tr>
413 <tr>
414 <td><code>$err_text_short</code></td>
415 <td>Der vom Benutzer eingegebene Text ist nicht lang genug</td>
416 </tr>
417 <tr>
418 <td><code>$err_name_long</code></td>
419 <td>Der vom Benutzer eingegebene Name ist nicht zu lang</td>
420 </tr>
421 <tr>
422 <td><code>$err_subject_long</code></td>
423 <td>Der vom Benutzer eingegebene Betreff ist zu lang</td>
424 </tr>
425 <tr>
426 <td><code>$err_text_long</code></td>
427 <td>Der vom Benutzer eingegebene Text ist zu lang</td>
428 </tr>
429 <tr>
430 <td><code>$err_send_error</code></td>
431 <td>Die Mail konnte nicht versendet werden</td>
432 </tr>
433 <tr>
434 <td><code>$err_only_post</code></td>
435 <td><i>Form E-Mail</i> darf nur mit <tt>POST</tt> aufgerufen werden</td>
436 </tr>
437 <tr>
438 <td><code>$err_referer_not_ok</code></td>
439 <td>Der im HTTP-Referer angegebene Host darf keine Mails &uuml;ber das Script senden</td>
440 </tr>
441 <tr>
442 <td><code>$err_indiv_errmsg_miss</code></td>
443 <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>
444 </tr>
445 <tr>
446 <td><code>$err_captcha_incorrect</code></td>
447 <td>Der vom Benutzer eingegebene Captcha-Code ist nicht korrekt</td>
448 </tr>
449 <tr>
450 <td><code>$err_captcha_max</code></td>
451 <td>Der Benutzer hat den Captcha-Code zu oft falsch eingegeben</td>
452 </tr>
453 <tr>
454 <td><code>$err_captcha_disabled</code></td>
455 <td>Wird angezeigt, wenn <i>captcha.php</i> aufgerufen wird und Captchas eigentlich deaktiviert sind.</td>
456 </tr>
457 <tr>
458 <td><code>$err_captcha_session_failure</code></td>
459 <td>Wird angezeigt, wenn keine Session-Variablen gefunden werden konnten.</td>
460 </tr>
461 </table>
462
463 <p><b>Pfade zu Templates</b></p>
464
465 <table border="1">
466 <tr>
467 <td><b>Einstellung</b></td>
468 <td><b>Beschreibung</b></td>
469 </tr>
470 <tr>
471 <td><code>$tpl_mail</code></td>
472 <td>Template f&uuml;r die Mail</td>
473 </tr>
474 <tr>
475 <td><code>$tpl_sent</code></td>
476 <td>Die Mail wurde erfolgreich versendet</td>
477 </tr>
478 <tr>
479 <td><code>$tpl_user_error</code></td>
480 <td>Der Benutzer hat etwas falsch gemacht</td>
481 </tr>
482 <tr>
483 <td><code>$tpl_fatal</code></td>
484 <td>Es ist ein Fehler aufgetreten, den der Benutzer nicht mehr beheben kann</td>
485 </tr>
486 </table>
487
488 <p class="upanddown"><a href="#top">Nach oben</a></p>
489
490 <h2><a name="individuell" id="individuell">Individuelle Formularfelder</a></h2>
491
492 <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 />
493 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>
494
495 <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>
496
497 <p><code>&lt;input type=&quot;text&quot; name=&quot;beruf&quot; /&gt;</code></p>
498
499 <p>Der Name des Feldes lautet also <b>beruf</b>. Dies ben&ouml;tigen wir f&uuml;r die weitere Definition.</p>
500
501 <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>
502
503 <table border="1">
504 <tr>
505 <td><b>Einstellung</b></td>
506 <td><b>Beschreibung</b></td>
507 </tr>
508 <tr>
509 <td><code>$user_fields['beruf']['min']</code></td>
510 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert mindestens sein muss</td>
511 </tr>
512 <tr>
513 <td><code>$user_fields['beruf']['max']</code></td>
514 <td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert h&ouml;chstens sein darf</td>
515 </tr>
516 <tr>
517 <td><code>$user_fields['beruf']['required']</code></td>
518 <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>
519 </tr>
520 <tr>
521 <td><code>$user_fields['beruf']['regex']</code></td>
522 <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>
523 </tr>
524 <tr>
525 <td><code>$user_fields['beruf']['check']</code></td>
526 <td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert gepr&uuml;ft werden soll.</td>
527 </tr>
528 </table>
529
530 <table border="1">
531 <tr>
532 <td><b>Einstellung</b></td>
533 <td><b>Beschreibung</b></td>
534 </tr>
535 <tr>
536 <td><code>$user_fields['beruf']['errors']['too_short']</code></td>
537 <td>Der vom Benutzer eingegebene Wert ist nicht lang genug</td>
538 </tr>
539 <tr>
540 <td><code>$user_fields['beruf']['errors']['too_long']</code></td>
541 <td>Der vom Benutzer eingegebene Wert ist zu lang</td>
542 </tr>
543 <tr>
544 <td><code>$user_fields['beruf']['errors']['not_set']</code></td>
545 <td>Das Formularfeld ist ein Pflichtfeld und es wurde nicht ausgef&uuml;llt.</td>
546 </tr>
547 <tr>
548 <td><code>$user_fields['beruf']['errors']['match_fail']</code></td>
549 <td>Die &Uuml;berpr&uuml;fung des Wertes durch den regul&auml;ren Ausdruck ist fehlgeschlagen.</td>
550 </tr>
551 <tr>
552 <td><code>$user_fields['beruf']['errors']['check_fail']</code></td>
553 <td>Die &Uuml;berpr&uuml;fung des Wertes durch eine PHP-Funktion ist fehlgeschlagen.</td>
554 </tr>
555 </table>
556
557
558 <table border="1">
559 <tr>
560 <td><b>Einstellung</b></td>
561 <td><b>Beschreibung</b></td>
562 </tr>
563 <tr>
564 <td><code>$user_fields['beruf']['prepare']</code></td>
565 <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).</td>
566 </tr>
567 <tr>
568 <td><code>$user_fields['beruf']['tpl_var']</code></td>
569 <td>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 <b>beruf</b> w&auml;re das dann <code>USER_beruf</code>).</td>
570 </tr>
571 </table>
572
573 <p class="upanddown"><a href="#top">Nach oben</a></p>
574
575 <h2><a name="templates" id="templates">Templates anpassen</a></h2>
576
577 <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>
578
579 <p>Hier nun eine Auflistung der einzelnen Templates und der verwendeten Variablen (ohne geschweifte Klammern):</p>
580
581 <table border="1">
582 <tr>
583 <td width="20%"><b>Datei</b></td>
584 <td width="40%"><b>Zweck</b></td>
585 <td width="40%"><b>Verwendete Variablen</b></td>
586 </tr>
587 <tr>
588 <td><i>fatal.htm</i></td>
589 <td>Wird angezeigt, wenn ein Fehler aufgetreten ist, den der Benutzer nicht mehr beheben kann</td>
590 <td>
591 <ul>
592 <li><b>ERROR</b><br />
593 Die Fehlermeldung</li>
594 </ul>
595 </td>
596 </tr>
597 <tr>
598 <td><i>mail.txt</i></td>
599 <td>Legt das Aussehen der Mail fest</td>
600 <td>
601 <ul>
602 <li><b>EMAIL</b><br />
603 Die eingegebene E-Mail-Adresse</li>
604 <li><b>NAME</b><br />
605 Der eingegebene Name</li>
606 <li><b>SUBJECT</b><br />
607 Der Betreff der Mail</li>
608 <li><b>TEXT</b><br />
609 Der eingegebene Mail-Text</li>
610 <li><b>TIME</b><br />
611 Die formatierte Zeitangabe</li>
612 </ul>
613
614 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>.
615 </td>
616 </tr>
617 <tr>
618 <td><i>sent.htm</i></td>
619 <td>Wird angezeigt, wenn die Mail erfolgreich versendet wurde</td>
620 <td>
621 <ul>
622 <li><b>EMAIL</b><br />
623 Die eingegebene E-Mail-Adresse</li>
624 <li><b>MAIL</b><br />
625 Die komplette Mail, so wie sie versendet wurde (nat&uuml;rlich ohne Header)</li>
626 <li><b>NAME</b><br />
627 Der eingegebene Name</li>
628 <li><b>SUBJECT</b><br />
629 Der Betreff der Mail</li>
630 <li><b>TEXT</b><br />
631 Der eingegebene Mail-Text</li>
632 <li><b>TIME</b><br />
633 Die formatierte Zeitangabe</li>
634 </ul>
635 </td>
636 </tr>
637 <tr>
638 <td><i>user_error.htm</i></td>
639 <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>
640 <td>
641 <ul>
642 <li><b>EMAIL</b><br />
643 Die eingegebene E-Mail-Adresse</li>
644 <li><b>ERROR</b><br />
645 Die Fehlermeldung</li>
646 <li><b>NAME</b><br />
647 Der eingegebene Name</li>
648 <li><b>SUBJECT</b><br />
649 Der Betreff der Mail</li>
650 <li><b>TEXT</b><br />
651 Der eingegebene Mail-Text</li>
652 </ul>
653
654 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 />
655 <br />
656 <code>{IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF}</code>
657 </td>
658 </tr>
659 </table>
660
661 <p>&nbsp;</p>
662
663 <hr width="80%" noshade="noshade" />
664
665 <p><a href="changes.htm">Versionshistorie</a></p>
666
667 <hr width="80%" noshade="noshade" />
668
669 <p style="font-size:8pt">&copy;&nbsp;2002-2012 Patrick Canterino</p>
670
671 <table border="0" cellspacing="0" style="font-size:8pt">
672 <tr>
673 <td>Homepage:</td>
674 <td><a href="http://www.patshaping.de/" target="_blank">http://www.patshaping.de/</a></td>
675 </tr>
676 <tr>
677 <td><a name="bottom" id="bottom">E-Mail:</a></td>
678 <td><a href="mailto:patrick@patshaping.de">patrick@patshaping.de</a></td>
679 </tr>
680 </table>
681 </body>
682 </html>

patrick-canterino.de