E-Mail-Vorlagen
E-Mail-Vorlagen definieren Inhalt und Gestaltung der automatisch vom System versendeten Nachrichten – z. B. Benachrichtigungen über neue Veranstaltungen oder VM-Erstellungen.
Sie sorgen für ein einheitliches Erscheinungsbild und stellen sicher, dass alle Systemmails klar und verständlich formuliert sind.
Wo finde ich den Bereich?
Über das Hauptmenü: E-Mails → Vorlagen
Alternativ erreichbar über: Über die Detailansicht gesendeter E-Mails oder aus Systemaufgaben erreichbar
Funktionen im Überblick
- Anlegen und Bearbeiten von E-Mail-Vorlagen mit Betreff, Text und HTML-Layout
- Verwendung von Platzhaltern für dynamische Inhalte (z. B. Benutzername, Veranstaltungstitel)
- Testversand einzelner Vorlagen zur Kontrolle des Inhalts
- Verknüpfung der Vorlage mit bestimmten Systemereignissen (z. B. VM-Erstellung)
- Anzeige aller mit dieser E-Mail-Vorlage versendeten E-Mails
Wichtige Felder im Überblick
| Feldname | Beschreibung |
|---|---|
Antworten An E-Mail | E-Mail-Adresse, an welche Nutzende auf automatisch versendete Nachrichten antworten können. |
Beschreibung | Kurze Beschreibung, wofür die Vorlage verwendet wird (z. B. „Benachrichtigung bei neuer VM“). |
Betreff | Betreffzeile der E-Mail. |
E-Mail Aktion | Zugewiesene E-Mail Aktion der E-Mail-Vorlage. Kann leer sein, um E-Mail-Vorlage nicht zu verwenden. |
Inhalt (HTML) | Hauptinhalt der E-Mail im Text- oder HTML-Format. Kann dynamische Platzhalter enthalten. |
Name | Anzeigename der Vorlage. Dient der Identifikation und Verknüpfung mit Systemaktionen. |
Vorhandene Platzhalter
Damit E-Mails personalisiert gestaltet werden können, stehen verschiedene Platzhalter für den Inhalt von E-Mail-Vorlagen zur Verfügung.
Welche Platzhalter verfügbar sind, hängt von der jeweils zugewiesenen E-Mail-Aktion ab.
Die Spalte „Verfügbarkeit“ in der folgenden Tabelle zeigt, in welchen Kontexten die einzelnen Platzhalter verwendet werden können.
Bitte beachte, dass beim Versenden von E-Mails keine zusätzliche Berechtigungsprüfung durchgeführt wird.
Das bedeutet, dass E-Mail-Vorlagen auch Daten oder Informationen enthalten können, die für den jeweiligen Empfänger eigentlich nicht sichtbar sein sollten.
Dies betrifft insbesondere E-Mails an Studierende, da diese in OpenVLE in der Regel nur eingeschränkte Berechtigungen besitzen.
Beispiel:
Wird in einer E-Mail-Vorlage, die an Studierende gesendet wird, der Platzhalter {{ virtualmachine.ipv4 }} oder {{ virtualmachine.proxmoxNode }} verwendet,
enthält die E-Mail technische Details wie die interne IP-Adresse oder den Servernamen (Node) der bereitgestellten VM.
Diese Informationen sind in OpenVLE normalerweise nur für Administratoren oder Lehrende sichtbar – Studierende könnten sie jedoch über die E-Mail einsehen.
Verwende daher in E-Mail-Vorlagen nur Platzhalter, die für die jeweilige Empfängergruppe bestimmt und unkritisch sind.
| Objektmodell | Platzhalter | Beschreibung | Verfügbarkeit |
|---|---|---|---|
| Benutzer | {{ user.email }} | E-Mail-Adresse des Benutzers, der die Nachricht erhält. | Immer (Veranstaltungen & VMs) |
| Benutzer | {{ user.name }} | Vollständiger Name des Benutzers, der die Nachricht erhält. | Immer (Veranstaltungen & VMs) |
| Benutzer | {{ user.username }} | Benutzername des Benutzers, der die Nachricht erhält. | Immer (Veranstaltungen & VMs) |
| Projekt | {{ project.name }} | Interner Name des Projekts. | Immer (Veranstaltungen & VMs) |
| Projekt | {{ project.title }} | Öffentlich sichtbarer Titel des Projekts. | Immer (Veranstaltungen & VMs) |
| SubTask | {{ subtask.action }} | Ausgeführte Aktion. | Veranstaltungen |
| SubTask | {{ subtask.attempt }} | Anzahl der bisherigen Wiederholungsversuche dieses SubTasks. | Veranstaltungen |
| SubTask | {{ subtask.createdAt }} | Zeitpunkt, zu dem der SubTask erstellt wurde. | Veranstaltungen |
| SubTask | {{ subtask.createdById }} | Benutzer-ID des Erstellers des SubTasks. | Veranstaltungen |
| SubTask | {{ subtask.id }} | Eindeutige Kennung (UUID) des SubTasks. | Veranstaltungen |
| SubTask | {{ subtask.job_id }} | Interne ID des Hintergrundjobs (RQ-Job), der diesen SubTask ausführt. | Veranstaltungen |
| SubTask | {{ subtask.name }} | Name oder Typ des SubTasks. | Veranstaltungen |
| SubTask | {{ subtask.object_id }} | Kennung (UUID) des Objekts, auf das sich der SubTask bezieht. | Veranstaltungen |
| SubTask | {{ subtask.object_type }} | Typ des Objekts, auf das sich der SubTask bezieht. | Veranstaltungen |
| SubTask | {{ subtask.parent_task }} | Kennung des übergeordneten Tasks, zu dem der SubTask gehört. | Veranstaltungen |
| SubTask | {{ subtask.response_code }} | Antwort- oder Statuscode nach Ausführung des SubTasks. | Veranstaltungen |
| SubTask | {{ subtask.response_message }} | Rückgabe- oder Fehlermeldung aus der Ausführung des SubTasks. | Veranstaltungen |
| SubTask | {{ subtask.status }} | Aktueller Status, z. B. queued, running, failed oder success. | Veranstaltungen |
| SubTask | {{ subtask.updatedAt }} | Zeitpunkt der letzten Aktualisierung oder Fertigstellung des SubTasks. | Veranstaltungen |
| SubTask | {{ subtask.updatedById }} | Benutzer-ID des letzten Bearbeiters des SubTasks. | Veranstaltungen |
| Veranstaltung | {{ event.course }} | Zugehöriger Kurs, welcher der Veranstaltung zugeordnet ist. | Veranstaltungen |
| Veranstaltung | {{ event.createdAt }} | Zeitpunkt, zu dem die Veranstaltung erstellt wurde. | Veranstaltungen |
| Veranstaltung | {{ event.createdById }} | Benutzer-ID des Erstellers der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.dateEnd }} | Enddatum der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.dateStart }} | Startdatum der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.deployment_status }} | Bereitstellungsstatus der Veranstaltung, z. B. pending oder ready. | Veranstaltungen |
| Veranstaltung | {{ event.description }} | Beschreibung oder zusätzliche Informationen zur Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.guacamole }} | Angabe, ob Guacamole für diese Veranstaltung aktiv ist (Standard: True). | Veranstaltungen |
| Veranstaltung | {{ event.id }} | Eindeutige Kennung (UUID) der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.name }} | Name der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.slug }} | Kurzname der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.status }} | Aktuelle StatusID der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.updatedAt }} | Zeitpunkt der letzten Aktualisierung der Veranstaltung. | Veranstaltungen |
| Veranstaltung | {{ event.updatedById }} | Benutzer-ID des letzten Bearbeiters der Veranstaltung. | Veranstaltungen |
| VM | {{ virtualmachine.cpu }} | Anzahl der zugewiesenen CPU-Kerne der virtuellen Maschine. | VMs |
| VM | {{ virtualmachine.createdAt }} | Zeitpunkt, zu dem die VM erstellt wurde. | VMs |
| VM | {{ virtualmachine.createdById }} | Benutzer-ID des Erstellers der VM. | VMs |
| VM | {{ virtualmachine.description }} | Beschreibung oder Zweck der VM. | VMs |
| VM | {{ virtualmachine.disk }} | Größe des zugewiesenen Festplattenspeichers in GB. | VMs |
| VM | {{ virtualmachine.event }} | Zugehörige Veranstaltung, in deren Kontext die VM erstellt wurde. | VMs |
| VM | {{ virtualmachine.id }} | Eindeutige Kennung (UUID) der VM. | VMs |
| VM | {{ virtualmachine.ipv4 }} | IPv4-Adresse der VM, sofern verfügbar. | VMs |
| VM | {{ virtualmachine.name }} | Name der virtuellen Maschine. | VMs |
| VM | {{ virtualmachine.os }} | Zugewiesene BetriebssystemID der VM. | VMs |
| VM | {{ virtualmachine.prevent_delete }} | Gibt an, ob das Löschen der VM verhindert wird (true/false). | VMs |
| VM | {{ virtualmachine.proxmoxId }} | Interne ID der VM im Proxmox-Cluster. | VMs |
| VM | {{ virtualmachine.proxmoxNode }} | Name des Proxmox-Nodes, auf dem die VM ausgeführt wird. | VMs |
| VM | {{ virtualmachine.ram }} | Zugewiesener Arbeitsspeicher der VM in MB. | VMs |
| VM | {{ virtualmachine.status }} | Aktueller Status der VM, z. B. running, stopped oder error. | VMs |
| VM | {{ virtualmachine.template }} | VM-Vorlage, auf der die virtuelle Maschine basiert. | VMs |
| VM | {{ virtualmachine.updatedAt }} | Zeitpunkt der letzten Aktualisierung der VM. | VMs |
| VM | {{ virtualmachine.updatedById }} | Benutzer-ID des letzten Bearbeiters der VM. | VMs |
Erstellen einer E-Mail-Vorlage
- Öffne im Hauptmenü den Bereich E-Mails → Vorlagen.
- Klicke auf Hinzufügen, um eine neue E-Mail-Vorlage zu erstellen.
- Gib einen Namen, einen Betreff, eine Beschreibung und einen Inhalt für die E-Mail-Vorlage an.
- Für den Inhalt kannst du außerdem die oben genannten Platzhalter verwenden, um Inhalte dynamisch und personalisiert darzustellen.
- Optional kannst du eine HTML-Vorschau des Inhalts anzeigen lassen.
- Optional kannst du die E-Mail-Vorlage bereits einer E-Mail-Aktion zuweisen – dies ist jedoch auch zu einem späteren Zeitpunkt möglich.
- Speichere die E-Mail-Vorlage.
Bearbeiten einer E-Mail-Vorlage
- Öffne im Hauptmenü den Bereich E-Mails → Vorlagen.
- Suche in der Liste nach der gewünschten E-Mail-Vorlage.
- Klicke auf Bearbeiten, oder öffne das Kontextmenü der E-Mail-Vorlage und wähle Bearbeiten.
- Im Formular werden alle aktuellen Daten der E-Mail-Vorlage angezeigt.
- Passe die gewünschten Felder an – beispielsweise Name, Betreff oder Inhalt.
- Wenn du die Zuordnung einer E-Mail-Vorlage zu einer E-Mail-Aktion entfernen möchtest, kannst du das Feld E-Mail-Aktion einfach leer lassen.
- Speichere die Änderungen.
Wenn du Änderungen an einer E-Mail-Vorlage zunächst testen möchtest, empfiehlt es sich, eine neue E-Mail-Vorlage anzulegen, ohne ihr eine E-Mail-Aktion zuzuweisen.
So stellst du sicher, dass nicht versehentlich bereits produktive E-Mails mit der neuen Vorlage versendet werden.
Löschen einer E-Mail-Vorlage
- Öffne im Hauptmenü den Bereich E-Mails → Vorlagen.
- Suche in der Liste nach der gewünschten E-Mail-Vorlage.
- Klicke auf Löschen, oder öffne das Kontextmenü der E-Mail-Vorlage und wähle Löschen.
- Bestätige den Löschvorgang im angezeigten Dialog.
- Die E-Mail-Vorlage wird daraufhin dauerhaft entfernt.
Wenn die E-Mail-Vorlage einer E-Mail-Aktion zugewiesen war und dieser Aktion keine weitere E-Mail-Vorlage zugewiesen ist,
werden für diese E-Mail-Aktion keine E-Mails mehr versendet.
Beispiel oder Anwendungsfall
Eine Administratorin möchte den Text anpassen, der versendet wird, wenn eine neue Veranstaltung startet. Im Bereich E-Mails → Vorlagen öffnet sie die Vorlage Veranstaltung erfolgreich bereitgestellt, fügt eine persönliche Anrede hinzu und testet den Versand mit einer Beispieladresse. Nach dem Speichern wird die geänderte Version bei allen zukünftigen Veranstaltungen verwendet.
Hinweise / Besonderheiten
- Platzhalter in Vorlagen werden beim Versand automatisch durch reale Werte ersetzt.
- Änderungen wirken sich nur auf zukünftige E-Mails aus – bereits versendete Nachrichten bleiben unverändert.
- HTML-Vorlagen unterstützen grundlegendes Styling, Inline-Bilder und dynamische Inhalte.
- Es können sowohl reine Text- als auch HTML-Vorlagen angelegt werden.
- Die Vorschau und der Testversand helfen, Layout und Platzhalter zu prüfen, bevor Änderungen live gehen.
Beziehungen zu anderen Objekten
Viele Objekte in OpenVLE stehen in Beziehung zu anderen Elementen innerhalb des Systems. Die folgende Übersicht zeigt, welche Verknüpfungen bestehen und ob diese bestimmte Automatisierungen auslösen.
| Objekt | Beschreibung | Automatisches Verhalten |
|---|---|---|
| Berechtigungen | Objektspezifische Berechtigungen können direkt am Objekt vergeben werden. | Automatisches Entfernen beim Löschen des Objekts. |
| Changelogs | Alle Änderungen am Objekt werden automatisch protokolliert. | Automatisches Entfernen beim Löschen des Objekts. |
| E-Mail Aktion | Einer E-Mail-Vorlage kann genau eine E-Mail Aktion zugewiesen werden | Keine Automatisierungen. |
| Gesendete E-Mail | Einer E-Mail-Vorlage können beliebig viele Gesendete E-Mails zugewiesen werden. | Keine Automatisierungen. |
| Tags | Objekte können mit beliebig vielen Tags versehen werden, um sie zu kategorisieren oder zu filtern. | Automatisches Entfernen beim Löschen des Objekts. |
Erforderliche Berechtigungen
Die für Aktionen benötigten Berechtigungen können über Rollen oder individuell vergeben werden. Fehlen Ihnen bestimmte Rechte, sind die entsprechenden Funktionen in der Benutzeroberfläche ausgeblendet oder deaktiviert.
| Aktion | Benötigte Berechtigung | Pfad | Weitere Informationen |
|---|---|---|---|
| E-Mail-Vorlagen anzeigen | mailtemplates_read | / oder /<objectID> | |
| E-Mail-Vorlagen anlegen | mailtemplates_create | / | |
| E-Mail-Vorlagen bearbeiten | mailtemplates_update | / oder /<objectID> | |
| E-Mail-Vorlagen löschen | mailtemplates_delete | / oder /<objectID> |
Beispiel:
/4a3bc312-d1af-4b3f-b222-f5e9cecbf007 – So erhält der Benutzer nur Zugriff auf dieses eine Objekt.Wird als Pfad / verwendet, gilt die Berechtigung global für alle Objekte dieses Typs.
Für *_create-Berechtigungen ist nur der globale Pfad / zulässig.