HTML-E-Mail-Vorlagen

Allgemeines

Die HTML-E-Mail-Vorlagen sind Teil der Cryptshare-Sprachpakete und können für jedes Produkt individuell angepasst werden. Wenn beispielsweise ein anderes Layout oder ein anderer Wortlaut für die Empfängerbenachrichtigung bei einem Transfer über den Cryptshare Robot eine andere Gestaltung oder Formulierung für die Empfängerbenachrichtigung wünschen, kann ein zusätzliches Sprachpaket für den Cryptshare-Robot installiert werden, das die Standardvorlage für die Empfängerbenachrichtigung überschreibt.

Aufbau einer E-Mail-Vorlage

Alle E-Mail-Vorlagen befinden sich im Verzeichnis „templates“ eines Sprachpakets. Jeder Unterordner in diesem Verzeichnis steht für die Vorlage einer bestimmten Art von E-Mail. Jede Vorlage besteht aus Vorlagenkomponenten und Konfigurationsdateien. Die Reihenfolge der einzelnen Komponenten innerhalb der zusammengesetzten Vorlage kann in der Konfigurationsdatei der jeweiligen Vorlage überschrieben werden. Die Standardreihenfolge lautet wie folgt:

  • Kopfzeile

  • Nachricht

  • Fußzeile

  • Signatur

Konfigurationsdateien
Konfigurationsdateien (conf++\*++.properties) enthalten Vorlageneinstellungen sowie
Textausschnitte für die Vorlagen.
Kopfzeile
Kopfzeilendateien (head++\*++.html) enthalten den HTML-Code für den
Kopfzeilenbereich der E-Mail.
Nachricht
Nachrichtendateien (message++\*++.html) enthalten den HTML-Code für den
Nachrichtenteil der E-Mail.

37388776

Fußzeile
Fußzeilendateien (foot++\*++.html) enthalten den HTML-Code für den
Fußzeilenbereich der E-Mail. Im Allgemeinen enthält dieser Abschnitt zusätzliche Informationen.
Signatur
Signaturdateien (signature++\*++.html) enthalten den HTML-Code für den
Signaturbereich der E-Mail.

37388778

37388780

Vorlagenkonfiguration

Struktur

Das Vorlagenverzeichnis muss bestimmte Dateien enthalten:

Speicherort Name Obligatorisch Zweck

1

templates-root

skeleton.html

Ja

Diese Datei enthält das umgebende Markup für die Vorlagenkomponenten und darf niemals geändert oder entfernt werden.

2

templates-root template-dir

conf\*.properties

Mindestens eine globale Definition ist erforderlich

Diese Datei dient zur Konfiguration von E-Mail-Vorlagen und kann die folgenden Einstellungen definieren:

  • Definition der Teilreihenfolge

  • Text-Snippets

3

templates-root template-dir

\*.html

Mindestens eine globale Markup-Datei ist erforderlich

HTML-Markup-Komponentendateien: Diese Dateien enthalten HTML- Markup-Code für die verschiedenen Komponenten der E-Mail.

Verhalten

Um zu verstehen, wie flexibel Vorlagen angepasst und erweitert werden können, ist es hilfreich zu wissen, wie die Vorlagen-Engine E-Mail- Vorlagen verarbeitet.

Vererbung

Eine Vorlage muss nur jene Ressourcen definieren, die für diese spezifische Vorlage unterschiedlich sein sollen. Alles, was nicht speziell für diese Vorlage definiert ist, wird aus den Definitionen des übergeordneten Verzeichnisses (templates-root) übernommen. Dazu gehören Einstellungen, Textausschnitte sowie HTML-Markup.

Sprach-Fallback

Wenn die Fallback-Sprache installiert ist („en:english“ – diese Dateien enthalten keinen ISO-Code im Dateinamen), werden Einstellungen, Textausschnitte oder HTML- Markup aus diesem Paket geladen, falls die angeforderte Sprache nicht verfügbar ist.

Anpassung

Es wird nicht empfohlen, den HTML-Code direkt zu ändern. Alle Anpassungen sollten durch Bearbeitung der Konfigurationsdateien (conf\*.properties) vorgenommen werden. Änderungen an den Markup-Dateien können andernfalls zu Layoutproblemen oder sogar zu Fehlern in der Vorlagen-Engine führen.

Bitte beachten Sie, dass das E-Mail-Header-Logo NICHT Teil des UI-Pakets ist. Sie können das Logo über die Administrationsoberfläche ändern.

Farben ändern

Bitte beachten Sie, dass die Farben für E-Mail-Vorlagen NICHT Teil des UI-package sind. Sie können die Farben für das E-Mail-Layout über die Administrationsoberfläche ändern.

Reihenfolge der Vorlagenkomponenten ändern

Die verschiedenen Vorlagenkomponenten erscheinen in der Reihenfolge, die in der globalen Vorlagenkonfigurationsdatei unter „template.order“ definiert ist.

Einfügen zusätzlicher Komponenten

Es ist auch möglich, zusätzliche Vorlagenkomponenten einzufügen. Wenn der Administrator beispielsweise einen speziellen Hinweis in eine der Benachrichtigungen einfügen möchte, kann er dies tun, indem er eine zusätzliche HTML-Markup-Datei hinzufügt und diese in die Definition der Vorlagenreihenfolge aufnimmt:

  1. Erstellen Sie eine zusätzliche Vorlagenkomponente (HTML-Markup)

HTML-Vorlagenteil-Markup` `Quelltext erweitern

Dies ist ein benutzerdefinierter Textteil.

Es wird empfohlen, einfach eine vorhandene Markup-Datei (z. B. signature.html) zu kopieren und anzupassen, um das Tabellenlayout beizubehalten. Wenn das Layout nicht persistent ist, kann dies zu unerwünschten Layout- Problemen in E-Mail-Clients führen.

  1. Legen Sie die Markup-Datei entweder im Vorlagen-Stammverzeichnis (damit sie über Vererbung auf alle Vorlagen angewendet werden kann) oder in einem bestimmten Vorlagenordner ab.

  2. Fügen Sie den neuen Teil zur Definition der Vorlagenreihenfolge

conf.properties
template.order = head,custom,message,foot,signature

Text-Snippets definieren

Innerhalb des HTML-Markups können zusätzliche Text-Snippets eingefügt werden. Innerhalb der Markup-Datei können diese Snippets wie folgt referenziert werden:

$<variable\_name>

Um ein solches Textfragment zu definieren, muss eine zusätzliche Eigenschaft „snippet.<variable\_name>“ in der entsprechenden Konfigurationsdatei platziert werden:

conf\*.properties
snippet.<variable \_ name>=Mein eigenes Textfragment