← Back to plugin index

Email Event Subscriber (Adminapp)
Description
An event subscriber that sends an email to notify a user.
Type name
AdminappEmailEventSubscriber
Class
com.airlock.iam.admin.application.configuration.event.AdminappEmailEventSubscriberConfig
May be used by
Adminapp Event Settings
Properties
Email Service (emailService)
Description
Email service for sending emails.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Dummy Email Service SMTP Email Service
Recipient Address (recipientAddress)
Description
Email address to which the notification email is sent.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Recipient From Context Data Recipient From Event Value
Subject Resource Key (subjectResourceKey)
Description
The resource key under which the localized template for the email subject can be found. The following syntax can be used to include data in the template.
  • ${contextDataName} for the value of contextDataName in the context-data of the managed user.
  • ${event.createdAt,date,format} for the date/time at which the event was created, where "format" is a date pattern like "yyyy-MM-dd HH:mm:ss".
Depending on the event and on the conditions in which the event originated, the following variables may also be available:
  • event.createdAt
  • event.data.addedRoles (list of strings)
  • event.data.airlock2FAAccountId
  • event.data.airlock2FADeviceId
  • event.data.activeAuthenticationMethod
  • event.data.contextDataChanged.%s.newValue (where "%s" is replaced by the context-data field name).
  • event.data.contextDataChanged.%s.oldValue (where "%s" is replaced by the context-data field name).
  • event.data.crontoDeviceId
  • event.data.delegation.newPermissions (list of strings)
  • event.data.delegation.oldPermissions (list of strings)
  • event.data.delegation.permissions (list of strings)
  • event.data.delegation.realm
  • event.data.delegation.role
  • event.data.fidoCredentialId
  • event.data.lockReason
  • event.data.mtanNewPhoneNumber
  • event.data.mtanNumberId
  • event.data.mtanOldPhoneNumber
  • event.data.newEmailAddress
  • event.data.newRealm
  • event.data.newRoles (list of strings)
  • event.data.oldEmailAddress
  • event.data.oldRealm
  • event.data.oldRoles (list of strings)
  • event.data.previousAuthenticationMethod
  • event.data.removedRoles (list of strings)
  • event.data.userId
  • event.id
  • event.metadata.requestIp
  • event.metadata.userAgent
  • event.source.adminId
Variables that are not defined are replaced by an empty string. The Airlock IAM documentation provides further information about the availability of specific variables.
Attributes
String
Optional
Default value
email.notification.subject
Suggested values
email.notification.address-changed-event.subject, email.notification.airlock2fa-device-deleted-event.subject, email.notification.authentication-method-changed-event.subject, email.notification.cronto-device-deleted-event.subject, email.notification.cronto-letter-ordered-event.subject, email.notification.device-token-deleted-event.subject, email.notification.email-added-event.subject, email.notification.email-changed-event.subject, email.notification.email-deleted-event.subject, email.notification.fido-credential-deleted-event.subject, email.notification.mtan-token-deleted-event.subject, email.notification.mtan-token-phone-number-changed-event.subject, email.notification.mtan-token-registered-event.subject, email.notification.password-changed-event.subject, email.notification.password-letter-ordered-event.subject, email.notification.user-created-event.subject, email.notification.user-deleted-event.subject, email.notification.user-locked-event.subject, email.notification.user-roles-changed-event.subject, email.notification.user-unlocked-event.subject
Body Resource Key (bodyResourceKey)
Description
The resource key under which the localized template for the email message body can be found. The following syntax can be used to include data in the template.
  • ${contextDataName} for the value of contextDataName in the context-data of the managed user.
  • ${event.createdAt,date,format} for the date/time at which the event was created, where "format" is a date pattern like "yyyy-MM-dd HH:mm:ss".
Depending on the event and on the conditions in which the event originated, the following variables may also be available:
  • event.createdAt
  • event.data.addedRoles (list of strings)
  • event.data.airlock2FAAccountId
  • event.data.airlock2FADeviceId
  • event.data.activeAuthenticationMethod
  • event.data.contextDataChanged.%s.newValue (where "%s" is replaced by the context-data field name).
  • event.data.contextDataChanged.%s.oldValue (where "%s" is replaced by the context-data field name).
  • event.data.crontoDeviceId
  • event.data.delegation.newPermissions (list of strings)
  • event.data.delegation.oldPermissions (list of strings)
  • event.data.delegation.permissions (list of strings)
  • event.data.delegation.realm
  • event.data.delegation.role
  • event.data.fidoCredentialId
  • event.data.lockReason
  • event.data.mtanNewPhoneNumber
  • event.data.mtanNumberId
  • event.data.mtanOldPhoneNumber
  • event.data.newEmailAddress
  • event.data.newRealm
  • event.data.newRoles (list of strings)
  • event.data.oldEmailAddress
  • event.data.oldRealm
  • event.data.oldRoles (list of strings)
  • event.data.previousAuthenticationMethod
  • event.data.removedRoles (list of strings)
  • event.data.userId
  • event.id
  • event.metadata.requestIp
  • event.metadata.userAgent
  • event.source.adminId
Variables that are not defined are replaced by an empty string. The Airlock IAM documentation provides further information about the availability of specific variables.
Attributes
String
Optional
Default value
email.notification.body
Suggested values
email.notification.address-changed-event.body, email.notification.airlock2fa-device-deleted-event.body, email.notification.authentication-method-changed-event.body, email.notification.cronto-device-deleted-event.body, email.notification.cronto-letter-ordered-event.body, email.notification.device-token-deleted-event.body, email.notification.email-added-event.body, email.notification.email-changed-event.body, email.notification.email-deleted-event.body, email.notification.fido-credential-deleted-event.body, email.notification.mtan-token-deleted-event.body, email.notification.mtan-token-phone-number-changed-event.body, email.notification.mtan-token-registered-event.body, email.notification.password-changed-event.body, email.notification.password-letter-ordered-event.body, email.notification.user-created-event.body, email.notification.user-deleted-event.body, email.notification.user-locked-event.body, email.notification.user-roles-changed-event.body, email.notification.user-unlocked-event.body
Send As HTML (sendAsHtml)
Description
If enabled, the verification email will be sent as an HTML mail. Otherwise it will be sent as plain text.
Attributes
Boolean
Optional
Default value
false
Language Context Data Name (languageContextDataName)
Description
The context data field whose value is to be used as the recipient's message language. If the provided value is blank or invalid, the default language will be used.
Attributes
Plugin-Link
Mandatory
Assignable plugins
String Context Data Item Name
Default Language (defaultLanguage)
Description
The default language code used when no (or no valid) information about the current language is present. The code must resolve to a locale that's available on the server. Use a lowercase ISO-639 two-letter language code, optionally followed by "_" and an uppercase ISO-3166 two-letter country code.
Attributes
String
Optional
Default value
de
Suggested values
de, fr, en, en_GB, de_CH
Event (event)
Description
The general Adminapp event about which the subscriber should be notified.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Airlock 2FA Device Deleted Authentication Method Changed Context Data Changed Cronto Device Deleted Cronto Letter Ordered Delegation Created Delegation Deleted Delegation Permissions Changed Device Token Deleted Email Address Added Email Address Changed Email Address Deleted FIDO Credential Deleted MTAN Token Deleted MTAN Token Phone Number Changed MTAN Token Registered Password Changed Password Letter Ordered User Created User Deleted User Locked User Realm Changed User Roles Changed User Unlocked
YAML Template (with default values) 

type: AdminappEmailEventSubscriber
id: AdminappEmailEventSubscriber-xxxxxx
displayName: 
comment: 
properties:
  bodyResourceKey: email.notification.body
  defaultLanguage: de
  emailService:
  event:
  languageContextDataName:
  recipientAddress:
  sendAsHtml: false
  subjectResourceKey: email.notification.subject