← Back to plugin index

Email Notifier
Description
Configuration of an EmailNotifier which sends an email to a user.
Type name
EmailNotifier
Class
com.airlock.iam.core.misc.impl.notification.EmailNotifier
May be used by
Vasco OTP Token Controller
Properties
Email Service (emailService)
Description
Email service plugin. This defines what mail server is used for sending the email. It also defines the sender address and whether the email should be signed or not.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Dummy Email Service SMTP Email Service
User Persister (userPersister)
Description
The user persister plug-in used to load the email address of an user.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Active Directory Connector Cipher User Persister Combining Extended User Persister Combining User Persister Database User Persister Dummy Extended User Persister LDAP Connector LDAP User Persister Property User Persister
Email Context Data Field (emailContextDataField)
Description
Context data field in which the email address is stored in.
Attributes
String
Mandatory
Mail Subject (mailSubject)
Description
The subject used in the email.
Attributes
String
Mandatory
Mail Body (mailBody)
Description
The template used as body. This text may contain specific variable strings defined one plugin level higher (e.g. $USERNAME$) or context data variables (e.g. ${givenname}).
Attributes
String
Mandatory
Multi-line-text
Example
Hi $USERNAME$, this email notifies you about something.
Example
Hi Mr/Ms ${givenname}, this email notifies you about something.
Example
Hi Mr/Ms ${givenname}, your username is $USERNAME$.
YAML Template (with default values) 

type: EmailNotifier
id: EmailNotifier-xxxxxx
displayName: 
comment: 
properties:
  emailContextDataField:
  emailService:
  mailBody:
  mailSubject:
  userPersister: