Dokumentation Tell-A-Friend-Script

Vielen Dank für Ihr Interesse an unserem Tell-A-Friend-Script. Wir empfehlen Ihnen, sich Zeit für die Lektüre dieser Anleitung zu nehmen.

Einleitung

Das Script kann aus Sicherheitsgründen nicht direkt aufgerufen werden, sondern muss über einen Link aufgerufen werden. Dabei wird die Verweisseite überprüft und mit den Angaben der Script-Konfiguration verglichen. Bei Übereinstimmung wird das Script ausgeführt.

Das HTML-Template wurde nach den Spezifikationen für XHTML 1.0 erstellt. Deshalb enthalten alle einfachen Tags (<br> oder <input>) einen abschließenden Slash (<br /> oder <input type="text" name="feld" />).

Konfiguration des Scripts

Achtung: Wenn Sie folgende Fehlermeldung beim Aufruf des Scripts erhalten - 'Falscher oder leerer Referrer (Verweisseite)!' - dann müssen Sie in der Datei 'index.php' in die Variable '$referring_server' Ihren Servernamen (also Ihre Domain mit und ohne www und am besten auch die IP-Adresse) eintragen.

Beispiel:

$referring_server = 'www.ihr-server.de, ihr-server.de, 127.0.0.1';

Für den Fall, dass Sie alle Daten korrekt eingegeben haben und trotzdem diese Fehlermeldung erhalten, stellen Sie bitte sicher, dass Sie das Script über einen Link von Ihrer Website aus aufrufen (Tell A Friend).

Weitere Variablen in der Datei 'index.php':

$language     Tragen Sie hier das Kürzel für die Sprache ein (z.B.: de oder en). Welche Sprachen verfügbar sind können Sie im Verzeichnis 'languages' herausfinden.

Die folgenden Funktionen sollen die die Missbrauchsmöglichkeit des Scripts durch Dritte (Spammer) einschränken. Sie können die Anzahl der gesendeten E-Mails an die E-Mail-Adresse des Benutzers, an die E-Mail-Adresse des Empfängers oder/und an die IP-Adresse des Benutzers koppeln.

$sender_count     Sie können bestimmen, wie oft und innerhalb welchen Zeitraums E-Mails mit der selben E-Mail-Adresse als Absender versandt werden können. Tragen Sie dazu die Anzahl der E-Mails mit der selben Absender-E-Mail (0 schaltet die Funktion ab) ein.

$sender_duration     Angabe des Zeitraums in ganzen Stunden (1, 2, 5, 10, 20, 300). Nach Ablauf kann die E-Mail-Adresse wieder als Absender benutzt werden.

$recipient_count     Sie können - analog zu oben - bestimmen, wie oft und innerhalb welchen Zeitraums E-Mails an dieselbe E-Mail-Adresse als Empfänger versandt werden können. Anzahl der E-Mails mit derselben Empfänger-E-Mail (0 schaltet die Funktion ab).

$recipient_duration     Angabe des Zeitraums in ganzen Stunden (1, 2, 5, 10, 20, 300).

$ip_address_count     Als dritte Möglichkeit können Sie die Anzahl der gesendeten E-Mails an die IP-Adresse des Benutzers koppeln. Analog den beiden oberen Möglichkeiten können Sie die Anzahl der E-Mails und die Dauer festlegen. Anzahl der E-Mails mit der selben IP-Adresse (0 schaltet die Funktion ab).

$ip_address_duration     Angabe der Dauer in ganzen Stunden (1, 2, 5, 10, 20, 300).

Wenn eine dieser drei Sicherheits-Funktion aktiviert wird, wird auch gleichzeitig die Log-Funktion eingeschaltet. Stellen Sie deshalb sicher, dass der Ordner 'logs' und die Log-Datei ('logs/logfile.txt') Schreibrechte besitzen (chmod 777).

$show_limit_errors     Hat ein Benutzer die maximale Anzahl seiner erlaubten E-Mails erreicht, können Sie ihm eine Fehlermeldung anzeigen.

$log_messages     Hier schalten Sie die Logging-Funktion der E-Mails ein beziehungsweise aus. Wollen Sie die Funktion nutzen, stellen Stellen Sie deshalb sicher, dass der Ordner 'logs' und die Log-Datei ('logs/logfile.txt') Schreibrechte besitzen (chmod 777).

$path['logfile']     Diese Variable enthält den Pfad zur Log-Datei für die E-Mail-Mail-Nachrichten.

$path['templates']     Diese Variable enthält den Pfad zu den Template-Dateien (HTML und Mail). Der Pfad kann relativ (./templates/ oder templates/) und absolut (z.B.: /usr/local/etc/httpd/.../tell_a_friend/templates/ oder /kunden/homepages/.../.../htdocs/tell_a_friend/templates/) angegeben werden (immer mit Slash am Ende).

$file['default_html']     In dieser Variable ist das Template gespeichert, dass beim Aufruf für das Layout verwendet wird.

$file['default_mail']     Diese Variable enthält den Namen des Mail-Templates, wenn im HTML-Formular kein Mail-Template definiert wurde.

Nach oben

Anpassung des HTML-Templates - templates/form.tpl.html

Sollten Sie für die Anpassung WYSIWYG-Editoren wie Dreamweaver, Frontpage oder NetObjects verwenden, achten Sie bitte darauf, dass die Software keine eigenmächtigen Veränderungen vornimmt. Die Funktionsweise des Scripts könnte dadurch beeinträchtigt werden.

In den Templates befinden sich Markierungen/Platzhalter in geschweiften Klammern, wie zum Beispiel {txt_script_name}. Die werden beim Aufruf des Scripts durch die entsprechenden Wörter ersetzt. Diese Wörter, also den Text für das Script, finden Sie in der Datei 'languages/language.de.inc.php'. Natürlich können Sie diese Wörter auch ändern oder an eine andere Position innerhalb des Templates verschieben. Es spricht auch nichts dagegen, wenn Sie die Markierungen durch richtige Wörter ersetzen. Ebenso können Sie die Sprachdatei nach dem vorgegebenen Muster erweitern.

Folgende Platzhalter sind nicht in der Sprachdatei enthalten und dürfen auch nicht verändert oder in der Sprachdatei durch eigene Definitionen angepasst werden:

{check_referer}
{check_server}
{message}
{redirect}
{referer}
{server}
{link}

Formularfelder

Zu jedem Formularfeldnamen im Template existiert automatisch ein gleichnamiger Platzhalter, der sowohl im HTML als auch im Mail-Template verwendet werden kann. Dadurch ist sichergestellt, dass die Daten bei einer Fehlermeldung im Formular wieder erscheinen. Der Platzhalter hat die gleiche Bezeichnung, wie das Formularfeld.

Das Script nutzt drei vordefinierte Formularfelder:

<input type="hidden" name="link" value="{redirect}" />

Dieses Feld erscheint in einem Template auch als Radio-Button.

<input type="text" name="sender_email" value="{sender_email}" />
<input type="text" name="friend_email" value="{friend_email}" />

Sie können das Formular beliebig um weitere Felder erweitern. Bitte achten Sie darauf, dass die Feldnamen und Platzhalter keine Leer- oder Sonderzeichen enthalten.

Pflichtfelder

Alle Formularfelder lassen als Pflichtfelder definieren. Das Formular wird damit erst dann abgeschickt, wenn alle Pflichtfelder ausgefüllt sind. Tragen Sie dazu die Formularfeldnamen der gewünschten Formularfelder in folgendes Hidden-Formularfeld im Template:

<input type="hidden" name="required_fields" value="" />

Beispiel:

<input type="hidden" name="required_fields" value="lastname, sender_email, friend_email" />

E-Mail-Syntax

Ähnlich wie bei den Pflichtfeldern können Sie bestimmen, welche Felder auf einen korrekten E-Mail-Syntax geprüft werden sollen.

<input type="hidden" name="email_fields" value="" />

Beispiel:

<input type="hidden" name="email_fields" value="sender_email" />

Danke-Seite

Nachdem das Formular abgeschickt wurde, wird auf eine vordefinierte Seite weitergeleitet. Diese Seite können Sie im folgenden Feld definieren:

<input type="hidden" name="thanks" value="" />

Beispiel:

<input type="hidden" name="thanks" value="danke.html" />

Mail-Template

Die Mail-Templates definieren Sie auf folgende Weise:

<input type="hidden" name="mail_template" value="" />

Dazu können Sie ein Mail-Template,

<input type="hidden" name="mail_template" value="mail.tpl.txt" />

oder mehrere Mail-Templates definieren. Durch die mehrfachen Mail-Templates können Sie mehrere E-Mails mit verschieden formatierten Inhalten versenden.

<input type="hidden" name="mail_template" value="mail.tpl.txt, mail2.tpl.txt" />

Nach oben

Anpassung des E-Mail Templates - templates/mail.tpl.txt

Im oberen Bereich des E-Mail-Templates befinden sich die Daten für den Kopfbereich der E-Mail. Dazu gehören:

      Empfänger    To:
      Absender     From:
      Betreff      Subject:
      Kopie        CC:
      Blindkopie   BCC:
    

Sie können den Empfänger der E-Mail im Template festlegen. Der Empfänger ist dabei normalerweise derjenige, der im Formular eingetragen wurde:

      To: {friend_email}
    

Zusätzlich können Sie weitere Empfänger per Kopie und Blind-Kopie hinzufügen:

      CC: name@anderer-server.de
      CC: chef@firma.de
      BCC: secret@firma.de
    

Als Absender können Sie eine feste Adresse eingeben oder die Daten aus dem Formular verwenden:

      From: {sender_email}
    

Sie können auch den Namen des Absenders einfügen. Dabei steht der Name vor der E-Mail-Adresse, die sich in spitzen Klammern befindet.

      From: {firstname} {lastname} <{email}>
    

Nach dem Kopfbereich folgt eine Leerzeile. Danach folgt der Inhalt der E-Mail. Sie können hier den Text nach Belieben ändern. Wenn Sie eigene Formularfelder hinzufügen, müssen die Namen der Felder im E-Mail-Template in geschweiften Klammern stehen - {formularfeldname}. Andernfalls werden die Inhalte aus dem Formular nicht in die E-Mail geschrieben.

Nach oben

Die Log-Datei - logs/logfile.txt

Das Verzeichnis 'logs' und die Datei logfile.txt muessen das Dateiattribut 777 besitzen (chmod 777) - also schreibbar sein.

Nach oben

Nutzung und Lizenzierung

Das Tell-A-Friend-Script können Sie kostenlos nutzen. Wenn Sie das Script ohne Hinweis und Link auf Stadtaus.com betreiben möchten, können Sie die Vollversion online erwerben (15 Euro).

Nach dem Kauf erhalten Sie zusätzlich zur Script-Lizenz kostenlose Updates und Upgrades.

  1. Sie können die Script-Lizenz an Dritte verkaufen, auch als professioneller Reseller.
  2. Den Preis können Sie dabei selbst bestimmen.
  3. Die Script-Lizenz gilt für eine Domain.

Kontakt: http://www.stadtaus.com/

Weitere Scripts auf STADTAUS.com:

  1. Bildergalerie-Script
  2. Formmail-Script
  3. Apotheken-Notdienstkalender
  4. Website-Empfehlungs-Script
  5. Online-Terminplaner
  6. Google-Tool

Besuchen Sie unser Projekt MetaCollection. Die Seite ist ein Verzeichnis deutscher und internationaler Script-Archive.

http://www.metacollection.com/

Nach oben

Support

Antworten auf Ihre Fragen und Lösungen für Probleme mit dem Script finden Sie in unserem Support-Forum.

Nach oben