Der Befehl disclaimer() fügt einer E-Mail eine Fussnote einer bestehenden E-Mail hinzu.
Dieser Befehl fügt einer E-Mail einen vordefinierten Text- beziehungsweise HTML-Baustein (template) hinzu. Wird keine Vorlage angegeben, so wird versucht, anhand der Einstellungen der Managed domains den richtigen Baustein zu wählen. Dazu werden die den jeweiligen E-Mail Domänen zugeordneten Disclaimer ausgewertet.
Aufbau des Befehls
disclaimer(['template'][,'position'][,'force']);
Dieser Befehl fügt einen Textanhang aus dem angeführten template einer bestehenden E-Mail hinzu. Wenn eine leere Zeichenfolge als template angegeben ist, wird versucht, anhand der Einstellungen der Managed domains den richtigen Baustein zu wählen. Dazu werden die den jeweiligen E-Mail Domänen zugeordneten Disclaimer ausgewertet.
Rückgabewert
positiv |
wenn der Disclaimer erfolgreich angehangen wurde |
negativ |
wenn kein template gefunden/zugeordnet (beispielsweise wegen einer nicht definierten Variable) oder der Disclaimer nicht angehangen werden kann. |
Parameter
template (optional)
Definiert den Namen der Vorlage (template), welche als Textanhang verwendet werden soll. Fussnoten- (Disclaimer-)Vorlagen werden über die Administrationsoberfläche (siehe Mail System Edit mail disclaimer...) konfiguriert und verwaltet.
Wird keine Vorlage angegeben, so wird das Standard disclaimer template der jeweiligen Managed domain verwendet.
Variablen verfügbar!
position (optional)
Mögliche Werte
•top |
oberhalb des E-Mail Body |
•bottom |
unterhalb des E-Mail Body |
Standardeinstellung ist bottom |
|
Das Positionieren eines Disclaimers kann alternativ auch manuell in einer E-Mail selbst erfolgen.
Hierzu ist einer E-Mail an der Stelle, an welcher der Disclaimer positioniert werden soll, eine Zeile mit dem Text
##MAILDISCLAIMER##
hinzuzufügen.
(erweitert in 12.0)
Durch Angabe von
##MAILDISCLAIMER_<disclaimer>##
(wobei <disclaimer> dem gewünschten Disclaimer aus entspricht), kann nicht nur die Position, sondern auch explizit der zu verwendende Disclaimer ausgewählt werden.
force (optional)
Ist der Parameter gesetzt ('1'), wird das Hinzufügen eines Textanhangs an eine ausgehende E-Mail erzwungen. Das heisst der Textanhang wird auch an Antwort-E-Mails angehängt.
Mögliche Werte
•true, yes oder 1 |
|
•false, no oder 0 |
|
Standardeinstellung ist 0 |
|
Beispiel 1
Zeile |
Code |
|---|---|
01 |
disclaimer('','bottom','yes'); |
Erklärung
In diesem Beispiel wird der Standard Textanhang anhand der Einstellungen innerhalb der Managed domains ausgewählt und am Ende jeder versendeten E-Mail angehängt. Dabei ist unerheblich, ob es sich um eine Antwort-E-Mail handelt oder nicht.
Beispiel 2
Zeile |
Code |
|---|---|
01 |
encrypt_webmail(); |
02 |
disclaimer('GINAdisclaimer','bottom'); |
03 |
deliver(); |
Erklärung
Die Disclaimer Funktion kann über die Custom commands auch innerhalb der GINA-Träger-E-Mails verwendet werden.
Im vorliegenden Beispiel wurde hierfür zunächst ein eigenes mit dem Namen «GINAdisclaimer» angelegt.
In Zeile 01 wird die GINA-Verschlüsselung ausgeführt. Im direkten Anschluss (Zeile 02) muss nun das Anhängen des Disclaimers für die GINA-Träger-E-Mail erfolgen. Dabei wird das zuvor erstellte mit dem Namen «GINAdisclaimer» verwendet. Aufgrund des Parameters 'bottom' wird dieser Disclaimer jeweils an das Ende des Hinweistextes jeder ausgewählten Sprache der GINA-Träger-E-Mail angehangen. Danach wird die GINA-Mail versendet (Zeile 03).
