E-Mail-Footer konfigurieren

Sie können E-Mail-Footer individuell nach bestimmten Kriterien oder Regeln konfigurieren.

Anwendungsbeispiele

Das System soll:

keine Footer anhängen, wenn es sich etwa um interne Empfängeradressen handelt
bei geschäftlichen E-Mails Footer mit den Pflichtangaben zur Firma anhängen
zusätzlich pro Abteilung oder Themen, etwa für Marketing-Aktionen, spezifische Footer anhängen

Die Konfigurationsdatei öffnen

Sie konfigurieren den Verwendungszweck der E-Mail-Footer in einer speziellen Konfigurationsdatei mit Regeln, die angeben:

wann das System welchen Footer verwendet
ob eine Regel aktiv ist
dass eine Regel nur für bestimmte ACLs (Benutzergruppen oder Benutzer) greift

So öffnen Sie die Konfigurationsdatei:

Öffnen Sie links in der Seitenleiste Administration und dann Root Ordner.
Öffnen Sie den Pfad:
```
Root/agorum/roi/MailFooter/rules
```
In diesem Ordner sehen Sie den Unterordner, der als Beispiel dient:
```
#sample
```
Kopieren Sie den Ordner #sample und fügen Sie ihn in den Ordner rules ein.

Mit # vor einem Ordnername (hier am Beispiel des Ordners #sample) können Sie die enthaltene Konfiguration deaktivieren.
Benennen Sie den kopierten Ordner über das Kontextmenü um, etwa in einen Ordner mit dem Namen Ihres Konfigurationsprojekts.
Doppelklicken Sie auf die Konfigurationsdatei rules.yml.

Ergebnis: Die Konfigurationsdatei öffnet sich.

Ordner rules mit kopiertem Unterordner (hier: AG.Doku)

Die Konfigurationsdatei bearbeiten

Die Konfigurationsdatei rules.yml enthält alle spezifischen Regeln für die Verwendung von E-Mail-Footern. Bearbeiten Sie die Konfigurationsdatei nach Ihren Wünschen, indem Sie die Parameter anpassen.

Beispielhafter Inhalt mit erklärenden Kommentaren

# if no rule matches, then the legacy method is used (from de/en)
#
# configuration for global footer rules
# can be multiple (array)

# Sample for removing footer, for specific mail addresses
# name: unique name
- name: "agorum.footer.disabled.internally"

  # describe the rule here
  description: "this rule disables footer for mails, sent internally"

  # active true/false
  active: true
  
  # priority, when there are more rules. 1=high, 5=low
  priority: 1
  
  # if one of the following regular expressions matches on any/all of the receivers (to, cc, bcc), this rule matches
  # ! at the beginning negates the rule
  recipients:
    # all=true: has to match each receiver
    all: true
    expressions:
      - "[\\w!#$%&\\'\\*\\+-\\/=\\?\\^_\\`\\.\\{\\|\\}~]+@agorum(\\.(de|com|cz|cn))"
  
  # if one of the following regular expressions matches on the subject, this rule matches  
  subject:
    # all=true: has to match each receiver 
    all: true
    expressions: []

  # if one of the following regular expressions matches on the body, this rule matches  
  body:
    # all=true: has to match each receiver
    all: true
    expressions: []
  
  # the path to the html file for the footer, undefined/empty means disabled
  # example: ./footer.html
  # give language en, de, ...
  # first the language of the user is tried, if not found, en is used as fallback
  footer: 
    en: null
  
  # an optional acl can be defined, to limit the rule to specific groups
  acl: null
  
  # true=do not perform other rules
  # if other rule matches, then the footer is also appended (e.g. for marketing footers)
  stop: true

Parameter

Parameter	Beschreibung	Mögliche Werte/Beispiele
name	Definiert den eindeutigen internen Namen der Regel. Dieser Name darf nur 1x über alle rules.yml-Dateien vorkommen.	String
description	Definiert eine interne Beschreibung der Regel.	String
active	true Aktiviert die Regel. false Deaktiviert die Regel.	siehe Spalte Beschreibung
priority	Definiert die Priorität der Regel, wenn diese greift oder zutrifft. Die Priorität gilt sowohl innerhalb der rules.yml als auch in anderen rules.yml-Dateien der anderen Ordner, d. h. das System sammelt zuerst die Prioritäten in allen Ordnern und sortiert diese dann nach Wichtigkeit.	1 = hoch 2, 3, 4, 5 = niedrig
recipients all	true Wendet die Regel an, wenn die nachfolgende Expression auf alle Empfänger zutrifft. false (Standard) Wendet die Regel an, wenn die nachfolgende Expression auf mindestens einen Empfänger zutrifft.	siehe Spalte Beschreibung
recipients expressions	Definiert eine Regular Expression für die Empfängeradressen. Schließen Sie die Regular Expression mit "" ein.	String Duplizieren Sie die Zeile, um mehrere Expressions anzugeben. Das System wendet die Regel an, sofern eine der Expressions zutrifft. Stellen Sie ein ! voran, um die Expression negativ zu verwenden. Verwenden Sie .* als Expression, sofern das System die Regel auf beliebige Empfänger anwenden soll.
subject expressions	Definiert eine Regular Expression für den Betreff an. Schließen Sie die Regular Expression mit "" ein.	String Duplizieren Sie die Zeile, um mehrere Expressions anzugeben. Das System wendet die Regel an, sofern eine der Expressions zutrifft. Stellen Sie ein ! voran, um die Expression negativ zu verwenden.
body expressions	Definiert eine Regular Expression für den Inhalt an. Schließen Sie die Regular Expression mit "" ein.	String • Um mehrere Expressions anzugeben, duplizieren Sie die Zeile. • Stellen Sie ein ! voran, um die Expression negativ zu verwenden oder umzukehren.
footer de	Definiert den Pfad zum deutschen Footer. Sie können einen absoluten Pfad angeben, etwa /agorum/roi/Files/Globale Footer/xxx.html. Befinden sich die rules.yml und das HTML-Dokument zum Footer im gleichen Ordner, genügt die Angabe ./xxx.html. Das System: prüft die eingestellte Sprache des Benutzers, der die E-Mail versendet verwendet den englischen Footer, wenn die eingestellte Sprache etwa Deutsch lautet, aber kein deutscher Footer existiert hängt den Footer des Benutzers an die E-Mail (wenn eingestellt), sofern weder ein deutscher noch ein englischer Footer existieren hängt den globalen Footer nicht an	./footer_de.html
footer en	Definiert den Pfad zum englischen Footer. Sie können einen absoluten Pfad angeben, etwa /agorum/roi/Files/Globale Footer/xxx.html. Befinden sich die rules.yml und das HTML-Dokument zum Footer im gleichen Ordner, genügt die Angabe ./xxx.html. Das System: prüft die eingestellte Sprache des Benutzers, der die E-Mail versendet verwendet den Footer des Benutzers, wenn die eingestellte Sprache etwa Englisch lautet, aber kein englischer Footer existiert hängt den globalen Footer nicht an	./footer_en.html
acl	Definiert eine ACL, mit der Sie die Regel nur für bestimmte Benutzergruppen aktivieren. Das System wendet die Regel an, wenn einer der Benutzer aus dieser Benutzergruppe eine E-Mail versendet. Verwenden Sie diesen Parameter, wenn Sie Regeln nach Abteilungen unterscheiden möchten.	ACL_abteilung
stop	true Das System ignoriert alle Regeln, die nach dieser Regel folgen. Die Regel, für die ein stop=true definiert ist, muss gültig sein. false Das System berücksichtigt alle Regeln, die nach dieser Regel folgen.	siehe Spalte Beschreibung

Weitere Regeln definieren

Kopieren Sie den bereits enthaltenen Code und passen Sie diesen an, um in einer rules.yml-Datei eine weitere Regel zu definieren.

Verwenden Sie in der neuen Regel beim Parameter name zwingend einen neuen Namen.

Beispiel einer rules.yml-Datei mit mehreren Regeln

# rule 1
- name: "agorum.footer.test.1"
  description: "this is a test for footer 1"
  active: true
  priority: 2
  recipients:
    expressions:
      - ".*"
  
  subject:
    expressions: []

  body:
    expressions: []
  
  footer: 
    en: './footer-1_en.html'
    
  acl: null
  stop: false
  
# rule 2
- name: "agorum.footer.test.2"
  description: "this is a test for footer 2"
  active: true
  priority: 2
  recipients:
    expressions:
      - ".*"
  
  subject:
    expressions: []

  body:
    expressions: []
  
  footer: 
    en: './footer-2_en.html'
    de: './footer-2_de.html'
    
  acl: null
  stop: false

HTML-Dateien für die Footer erstellen

Erstellen Sie die HTML-Dateien zu den Footern, damit das System die Footer an eine E-Mail hängt.

Die Angabe im Parameter footer in der Datei rules.yml muss mit dem Dateinamen des HTML-Dokuments übereinstimmen, damit das System den Footer finden und anhängen kann.

So erstellen Sie die HTML-Dateien für die Footer:

Öffnen Sie links in der Seitenleiste Administration und dann Root.
Öffnen Sie Ihren rules-Ordner.
Öffnen Sie mit der rechten Maustaste das Kontextmenü.
Wählen Sie Neu > HTML-Dokument.
Vergeben Sie den gleichen Namen für den Footer, wie Sie ihn auch in der rules.yml-Datei pro Sprache angegeben haben.
Bearbeiten Sie das HTML-Dokument und fügen Sie dort Ihren Footer ein.

Projektordner mit HTML-Dateien für den Footer