HowTo:EMail Template: Unterschied zwischen den Versionen

Aus WEB-Shop Software Wiki
Zur Navigation springenZur Suche springen
Zeile 30: Zeile 30:
 
  {mail_include file="signature.txt"}
 
  {mail_include file="signature.txt"}
 
Gesucht wird die Datei '''signature.txt''' dann in den folgenden Verzeichnissen, wobei er wenn er eine Datei gefunden hat aufhört zu suchen:
 
Gesucht wird die Datei '''signature.txt''' dann in den folgenden Verzeichnissen, wobei er wenn er eine Datei gefunden hat aufhört zu suchen:
* templates/''DeineVorlage''/mail/'''Sprache'''/
+
* templates/''DeineVorlage''/mail/''Sprache''/
 
* templates/''DeineVorlage''/mail/
 
* templates/''DeineVorlage''/mail/
* templates/_core/mail/'''Sprache'''/
+
* templates/_core/mail/''Sprache''/
 
* templates/_core/mail/
 
* templates/_core/mail/
 
Es sind also sowohl sprachabhängige als auch -unabhängige Templates möglich.
 
Es sind also sowohl sprachabhängige als auch -unabhängige Templates möglich.

Version vom 26. Juli 2009, 21:22 Uhr

Einrichten der Email-Konfiguration

ACHTUNG: Feature noch nicht implementiert

Die Email Vorlagen liegen im tempates/_core/mail Verzeichnis

Wenn Du eines dieser Templates verändern möchtes, so kopiere es in das entsprechende Verzeichnis in Deinem Template-Ordner!

Für jede mögliche Email gibt es zwei verschiedene Templates, ein Text-Template und ein HTML-Template. Das Text-Template kann die folgenden Kopfzeilen enthalten, Kursiv geschriebene Werte sind hierbei optional:

  • SUBJECT Betreff der Email
  • FROM "Klartext-Name" <email-adresse>
  • REPLY "Klartext-Name" <email-adresse>
  • CC "Klartext-Name" <email-adresse>
  • BCC "Klartext-Name" <email-adresse>
  • ATTACHMENT Link-Name Dateiname

Für die HTML-Variante gibt es lediglich eine Möglichkeit:

  • IMAGE Link-Name Dateiname

Diese Zeilen müssen am Anfang der TEXT-Version (hinter dem Kommentar /* ... */ der jeweiligen Email) definiert werden, und zwar je Zeile ein Feld.

Der Vorteil bei den Angaben im Template ist, dass diese nun sprachgesteuert angegeben werden können. Natürlich hätte man diese Angaben auch im Admin-Backend belassen können - aber dann wäre es ja noch umfangreicher gewesen, da man alles Sprachabhängig hätte eingeben müssen.

Smarty-Plugin: mail_include

Es wurde eine Smarty-Plugin realisiert um innerhalb eines Templates leicht ein weiters Email-Template einzulesen. Dies kann z.B. genutzt werden um eine Signatur einzufügen. Der Code im Template dazu sieht wie folgt aus:

{mail_include file="signature.txt"}

Gesucht wird die Datei signature.txt dann in den folgenden Verzeichnissen, wobei er wenn er eine Datei gefunden hat aufhört zu suchen:

  • templates/DeineVorlage/mail/Sprache/
  • templates/DeineVorlage/mail/
  • templates/_core/mail/Sprache/
  • templates/_core/mail/

Es sind also sowohl sprachabhängige als auch -unabhängige Templates möglich.

Kopfzeilen der Text-Datei

SUBJECT
Die Angabe vom SUBJECT ist zwingend vorgeschrieben, alle anderen Angaben sind optional.
FROM optional
Angabe des Absenders den der Empfänger der Email sieht.
Default-Werte
Klartext-Name: ShopName
<email-adresse> Wert von Konfiguration/Mein-Shop/Email_von
REPLY optional
Optionale Angabe des Antwort-Empfängers (Reply-To). Die Angabe dieses Wertes ist sinnvoll wenn der Server Emails nur über einen bestimmten account verschicken kann, Kundenantworten zu diesem Thema aber in einer anderen InBox landen sollen.
Der Klartext-Name muß in Anführungszeichen stehen, die EMail eingeschlossen in spitzen Klammern
Beispiel: REPLY "John Doe" <john.doe@demo.webs.de>
CC optional
Angabe von Email-Empfängern die diese Email immer als Kopie erhalten sollen.
Format & Beispiel entsprechend REPLY
BCC optional
Angabe von Email-Empfängern die diese Email immer als Blindkopie erhalten sollen.
Format & Beispiel entsprechend REPLY
ATTACHMENT optional
Angabe von Dateien die mit der Email verschickt werden sollen, z.B. PDF-Dokumente o.ä.
Die Datei wird nacheinander in den folgenden Vereichnissen gesucht - die zuerst gefundene wird benutzt:
templates/DeineVorlage/email/Sprache/attachment
templates/DeineVorlage/email/attachment
templates/_core/email/Sprache/attachment
templates/_core/email/attachment

Kopfzeilen der HTML-Datei

IMAGE optional
Hier können Bilddaten angegeben werden die mit der Email verschickt werden (Embedded Images), die Bild-Datei muß hierbei im GIF-Format vorliegen!
Die Bild-Datei wird entsprechend der Angabe für ATTACHMENT gesucht.
Um zum Beispiel ein ShopLogo zu übergeben wäre folgendes nötig:
Speichern des Logos als GIF-Datei logo.gif unter /templates/myTemplate/email/attachment
IMAGE shop-logo logo.gif
in der Email das Bild mit <img src="cid:shop-logo" alt="logo"> referenzieren

Verzeichnisstruktur

templates/_core/mail
sprachunabhängig Vorlagen
templates/_core/mail/attachment
sprachunabhängige Anhänge & Bilder
templates/_core/mail/Sprache
Emails in der jeweiligen Sprache
templates/_core/mail/Sprache/attachment
sprachabhängige Anhänge & Bilder

Hinweis zum Update

Die Email-Templates befinden sich in dem folgenden Verzeichnis:

  • templates/*/admin/mail/sprache/

Der Update-Prozess wird die neuen Email-Templates im templates/_core Verzeichnis installieren und versuchen die vorhandenen Email-Templates in das entsprechende Template-Verzeichnis zu verschieben.

gelöschte Konstanten

Wenn Du eigene Erweiterungen implementiert hast, so prüfe daß nicht eine der folgenden Konstanten verwendet wurde:

  • EMAIL_EMBED_IMAGES
  • CONTACT_US_EMAIL_ADDRESS
  • CONTACT_US_EMAIL_SUBJECT
  • EMAIL_SUPPORT_ADDRESS
  • EMAIL_SUPPORT_NAME
  • EMAIL_SUPPORT_REPLY_ADDRESS
  • EMAIL_SUPPORT_REPLY_ADDRESS_NAME
  • EMAIL_SUPPORT_SUBJECT
  • EMAIL_SUPPORT_FORWARDING_STRING
  • EMAIL_BILLING_ADDRESS
  • EMAIL_BILLING_NAME
  • EMAIL_BILLING_REPLY_ADDRESS
  • EMAIL_BILLING_REPLY_ADDRESS_NAME
  • EMAIL_BILLING_SUBJECT
  • EMAIL_BILLING_FORWARDING_STRING
  • EMAIL_BILLING_SUBJECT_ORDER

Noch offen

  • Ob eine Modifikation des Templates stattfindet steht noch nicht fest.