Der Befehl encrypt_webmail() verschlüsselt eine E-Mail unter Verwendung der GINA-Technologie.
Dieser Befehl verschlüsselt eine ausgehende Nachricht via GINA-Technologie an die Empfängeradresse.
Die Empfänger- sowie die Absenderadresse wird aus der aktuell verarbeiteten Nachricht für die GINA-Träger-E-Mail entnommen.
Nach dem Verschlüsseln einer Nachricht mittels GINA-Technologie sollte diese immer direkt mit deliver() versendet werden.
Aufbau des Befehls
encrypt_webmail(['template'], ['no_pw_mail_if_sms_sent']);
Rückgabewert
positiv |
bei erfolgreicher GINA-Verschlüsselung |
negativ |
bei fehlgeschlagener GINA-Verschlüsselung |
Parameter
template (optional)
Definiert die zu verwendende GINA-Domain.
Wird kein Parameter angegeben, so wird die Vorlage anhand der E-Mail Domäne der Absenderadresse ausgewählt (siehe Mail System Managed domains Settings GINA domain)
no_pw_mail_if_sms_sent (optional)
Unterdrückt ('1') die Passwort-E-Mail an den Absender, bei Verwenden eines 'template' mit der Einstellung Unique e-mail password, sofern das Passwort bereits via SMS übermittelt werden konnte (siehe auch Schlüsselwort [SMS:] in Tabelle 1 des Kapitels Steuern der Appliance).
Mögliche Werte:
•true, yes oder 1
•false, no oder 0
Standardeinstellung ist 0
Beispiel 1
Zeile |
Code |
|---|---|
01 |
if (encrypt_webmail()) { |
02 |
log(1,'mail successfully GINA encrypted'); |
03 |
deliver(); |
04 |
} else { |
05 |
log(1,'mail could not be GINA encrypted'); |
06 |
drop('451','Die Nachricht konnte nicht verschluesselt werden'); |
07 |
} |
Erklärung
In diesem Beispiel wird versucht eine E-Mail mittels GINA-Technologie zu Verschlüsseln (Zeile 01). Erfolg beziehungsweise Misserfolg der Aktion wird protokolliert (Zeile 02 und 05). Bei erfolgreichem Verschlüsseln wird die E-Mail - wie empfohlen - direkt ausgeliefert (Zeile 03). Andernfalls wird sie mit dem temporären Fehler „451“ und dem Hinweistext „Die Nachricht konnte nicht verschlüsselt werden“ abgewiesen (Zeile 06).
|
Wird encrypt_webmail() mit einem 'template' verwendet, welches in der Sektion Event login die Einstellung Unique e-mail password aktiv hat, so wird durch Verwenden des Befehls dieses Unique e-mail password versendet. Dieses Passwort wird somit auch nicht gespeichert. Ein GINA Account ist dennoch erforderlich, da andernfalls encrypt_webmail() fehlschlagen würde. Die Funktion versendet keine Passwörter bei den 'template' Einstellungen No password event oder One-time password via SMS only, da mit diesen Einstellungen der erforderliche GINA Account maßgeblich ist. |
Beispiel 2
Zeile |
Code |
|---|---|
01 |
if (webmail_keys_avail()) { |
02 |
log(1,'GINA account already exists'); |
03 |
} else { |
04 |
log(1,'no GINA account available, creating new account'); |
05 |
webmail_keys_gen('','0'); |
06 |
} |
07 |
if (encrypt_webmail('<GINA-template_with_Unique-e-mail-password>')) { |
08 |
log(1,'mail successfully GINA encrypted'); |
09 |
deliver(); |
11 |
} else { |
12 |
log(1,'mail could not be GINA encrypted'); |
13 |
drop('451','Message could not be encrypted'); |
14 |
} |
Erklärung
In diesem Beispiel wird zunächst geprüft, ob für den Empfänger bereits ein GINA Account vorhanden ist (Zeile 1). Falls nicht, wird ein GINA Account mit der Passwort-Länge „0“ generiert. Durch die eingestellte Passwort-Länge „0“ wird keine Passwort-E-Mail gesendet. Nun wird die E-Mail mittels GINA-Technologie verschlüsselt (Zeile 07). Dabei wird der Parameter 'template' verwendet, der auf eine GINA Domain verweist, welche in der Sektion Event login die Einstellung Unique e-mail password aktiv hat. Somit wird für jede E-Mail, welche über diesen Mechanismus gesendet wird ein E-Mail bezogenes Passwort mit der in der GINA Domain aus 'template' unter Event login Password strength angegebenen Passwort-Länge generiert und versendet.
Erfolg beziehungsweise Misserfolg der Aktion wird protokolliert (Zeile 08 und 12). Bei erfolgreichem Verschlüsseln wird die E-Mail - wie empfohlen - direkt ausgeliefert (Zeile 09). Andernfalls wird sie mit dem temporären Fehler „451“ und dem Hinweistext „Message could not be encrypted“ abgewiesen (Zeile 13).
