Der Befehl flag() dient dem Markieren einer E-Mail ermöglicht die spätere Abfrage dieser Markierung.
Damit können X-Header und Subject-Tags für das Triggern bestimmter Aktionen abgelöst werden.
Aufbau des Befehls
flag('name'[,'boolean']);
.
Rückgabewert
positiv |
falls gesetzt |
negativ |
falls nicht vorhanden |
Parameter
name
Gibt den Namen der Markierung an. Dieser muss eindeutig sein.
boolean (optional)
Wird der Parameter nicht angegeben, so wird der Wert der Markierung für eine if-Anweisung ausgelesen
Mögliche Werte
•true, yes oder 1 |
Setzt die Markierung |
•false, no oder 0 |
Entfernt die Markierung |
Standardeinstellung ist 1 |
|
Beispiel 1
Zeile |
Code |
|---|---|
01 |
if (!flag('webmail')) { |
02 |
log(1,'Webmail ist nicht vorhanden/aktiviert'); |
03 |
} |
04 |
flag('webmail', 1); |
05 |
if (flag('webmail')) { |
06 |
log(1,'Webmail ist aktiviert'); |
07 |
} |
08 |
if (flag('webmail', 0)) { |
09 |
log(1,'Webmail war aktiv und wurde deaktiviert'); |
10 |
} |
Erklärung
In diesem Beispiel wird in Zeile 01 abgefragt, ob die Markierung webmail noch nicht vorhanden ist. Da diese zuvor nicht gesetzt wurde, ist der Rückgabewert aufgrund der Negierung (!) positiv und Zeile 02 wird ausgeführt. Der Text Webmail ist nicht vorhanden/aktiviert wird in das Log geschrieben.
In Zeile 04 wird nun die Markierung webmail gesetzt. In Zeile 05 wird die Markierung webmail erneut abgefragt. Der Rückgabewert ist aufgrund des Setzen des Flags in Zeile 04 positiv, so dass der Text Webmail ist aktiviert aus Zeile 06 in das Log geschrieben wird.
In Zeile 08 wird die Markierung erneut abgefragt und gleichzeitig deaktiviert. Da der Wert zum Zeitpunkt der Abfrage noch positiv war und erst mit der Abfrage negativ wurde, wird der Text aus Zeile 09 Webmail wurde deaktiviert noch in das Log geschrieben, auch wenn der Wert danach negativ ist.
Das heisst mit dem Befehl ist ein gleichzeitiges Abfragen und Setzen möglich!
