Syntax

sendInvitation($invitation)

Beschreibung

Versendet eine Einladungs-E-Mail an den im invitation-Objekt hinterlegten Empfänger. Die E-Mail enthält einen Registrierungslink, über den der Eingeladene sein Konto anlegen kann. Inhalt und Betreff der E-Mail werden durch den im InvitationModule konfigurierten Ausdruck invitation-mail bestimmt.

Damit diese Funktion genutzt werden kann, muss das Modul tl-security-selfservice in der Applikation eingebunden sein und der E-Mail-Versand muss konfiguriert sein.

Parameter

Name	Typ	Beschreibung	Pflicht	Default
invitation	Fachobjekt (`tl.security.selfservice:Invitation`)	Die Einladung, deren Empfänger die Einladungs-E-Mail erhalten soll. Die Einladung muss eine gültige E-Mail-Adresse im Attribut `email` hinterlegt haben.	ja

Rückgabewert

Typ: Wahrheitswert

Ob der Versand der Einladungs-E-Mail erfolgreich war.

Beispiele

Einladung versenden

sendInvitation($invitation)

Ausgabe: true

Versendet die Einladungs-E-Mail an die im Attribut email von $invitation hinterlegte Adresse.

Einladung erstellen und versenden

{
  invitation = new(`tl.security.selfservice:Invitation`);
  set($invitation, `tl.security.selfservice:Invitation#email`, "new.user@example.com");
  sendInvitation($invitation);
}

Ausgabe: true

Erstellt eine neue Einladung für die angegebene E-Mail-Adresse und versendet die Einladungs-E-Mail direkt im Anschluss.