← Back to plugin index

Email Event Subscriber (Loginapp)
Description
An event subscriber that sends an email to notify a user.
Type name
LoginappEmailEventSubscriber
Class
com.airlock.iam.login.application.configuration.event.LoginappEmailEventSubscriberConfig
May be used by
Loginapp 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 Event Value Recipient From String Value Provider
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.
  • ${valueMapKey} for the value of valueMapKey provided by any of the configured Value Map Providers.
  • ${event.createdAt,date,format} to include 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.airlock2FAAccountId
  • event.data.airlock2FADeviceId
  • event.data.activeAuthenticationMethod
  • event.data.authenticationMethods
  • event.data.browser
  • event.data.city
  • 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.countryCode
  • event.data.crontoDeviceId
  • event.data.device
  • event.data.deviceTokenId
  • event.data.fidoCredentialId
  • event.data.fidoPublicKeyCredentialId
  • event.data.oauth2.authorizationServerId
  • event.data.fidoRelyingPartyId
  • event.data.lockReason
  • event.data.mtanNewPhoneNumber
  • event.data.mtanNumberId
  • event.data.mtanOldPhoneNumber
  • event.data.newEmailAddress
  • event.data.newRealm
  • event.data.oauth2.acceptedScopes
  • event.data.oauth2.alwaysGrantedScopes
  • event.data.oauth2.clientId
  • event.data.oauth2.deniedScopes
  • event.data.oldEmailAddress
  • event.data.oldRealm
  • event.data.operatingSystem
  • event.data.previousAuthenticationMethod
  • event.data.stepResult.attributes.<attribute-name> (where <attribute-name> ist the name of the additional attribute, could be nested.)
  • event.data.stepResult.errorCode
  • event.data.stepResult.nextAction
  • event.data.stepResult.type
  • event.data.userId
  • event.id
  • event.metadata.requestIp
  • event.metadata.userAgent
  • event.source.applicationId
  • event.source.configurationContext
  • event.source.flowId
  • event.source.stepId
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-activated-event.subject, email.notification.airlock2fa-device-deleted-event.subject, email.notification.airlock2fa-device-in-cooldown-used-event.subject, email.notification.authentication-flow-successfully-completed-event.subject, email.notification.authentication-method-changed-event.subject, email.notification.cronto-device-activated-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.device-token-registered-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.fido-credential-registered-event.subject, email.notification.login-from-new-device-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-locked-event.subject, email.notification.user-unlocked-event.subject, email.notification.oath-otp-secret-added-event.subject, email.notification.oath-otp-secret-viewed-event.subject, email.notification.oauth2-user-consent-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.
  • ${valueMapKey} for the value of valueMapKey provided by any of the configured Value Map Providers.
  • ${event.createdAt,date,format} to include 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.airlock2FAAccountId
  • event.data.airlock2FADeviceId
  • event.data.activeAuthenticationMethod
  • event.data.authenticationMethods
  • event.data.browser
  • event.data.city
  • 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.countryCode
  • event.data.crontoDeviceId
  • event.data.device
  • event.data.deviceTokenId
  • event.data.fidoCredentialId
  • event.data.fidoPublicKeyCredentialId
  • event.data.oauth2.authorizationServerId
  • event.data.fidoRelyingPartyId
  • event.data.lockReason
  • event.data.mtanNewPhoneNumber
  • event.data.mtanNumberId
  • event.data.mtanOldPhoneNumber
  • event.data.newEmailAddress
  • event.data.newRealm
  • event.data.oauth2.acceptedScopes
  • event.data.oauth2.alwaysGrantedScopes
  • event.data.oauth2.clientId
  • event.data.oauth2.deniedScopes
  • event.data.oldEmailAddress
  • event.data.oldRealm
  • event.data.operatingSystem
  • event.data.previousAuthenticationMethod
  • event.data.stepResult.attributes.<attribute-name> (where <attribute-name> ist the name of the additional attribute, could be nested.)
  • event.data.stepResult.errorCode
  • event.data.stepResult.nextAction
  • event.data.stepResult.type
  • event.data.userId
  • event.id
  • event.metadata.requestIp
  • event.metadata.userAgent
  • event.source.applicationId
  • event.source.configurationContext
  • event.source.flowId
  • event.source.stepId
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-activated-event.body, email.notification.airlock2fa-device-deleted-event.body, email.notification.airlock2fa-device-in-cooldown-used-event.body, email.notification.authentication-flow-successfully-completed-event.body, email.notification.authentication-method-changed-event.body, email.notification.cronto-device-activated-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.device-token-registered-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.fido-credential-registered-event.body, email.notification.login-from-new-device-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.oath-otp-secret-added-event.body, email.notification.oath-otp-secret-viewed-event.body, email.notification.password-changed-event.body, email.notification.password-letter-ordered-event.body, email.notification.user-created-event.body, email.notification.user-locked-event.body, email.notification.user-unlocked-event.body, email.notification.oath-otp-secret-added-event.body, email.notification.oath-otp-secret-viewed-event.body, email.notification.oauth2-user-consent-event.body
Send As HTML (sendAsHtml)
Description
If enabled, the notification email will be sent as an HTML mail. Otherwise it will be sent as plain text.
Attributes
Boolean
Optional
Default value
false
Language (language)
Description
A String Value Provider which provides the language of the message. It is recommended to use a context data field and not the display language, as latter could be misused by an attacker to confuse the victim with an unknown language.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Changed Email Address Provider Display Language String Provider Fallback String Value Provider Generic Session Attribute String Provider HTTP Request Cookie Value Provider HTTP Request Header Value Provider Identity Value Provider OAuth 2.0/OIDC Authorization Request Parameter Value Provider OAuth2 Access Token String Value Provider Realm String Provider Static String Value Provider String Context Data Value Provider String From Map Value Provider Template-based String Provider Ticket String Provider Transforming String Value Provider Translated String Provider User Principal Name Provider mTAN Registration Label Provider mTAN Registration Number Provider
Value Map Providers (valueMapProviders)
Description
Mappings that are used to replace the variables in the localized templates for the notification's content. The value map providers are called in the configured order and their values are added to a map. Later added values will overwrite earlier ones if they have the same key.
Attributes
Plugin-List
Optional
Assignable plugins
Additional Password Check Attribute Map Airlock 2FA Authentication Data Map Airlock 2FA Login ID Parameter Authentication Data Map Conditional Value Map Provider Context Data Map Edited Context Data Map Generic Session Attribute Value Map Provider HTTP Request Information Map OAuth 2.0 Credential Context Data Map OAuth 2.0 Tokens Map Roles Provider SSI Verification Data Provider SSO Ticket Context Data Provider Script Execution Result Value Map Provider Transaction Approval Parameters Map Transforming Value Map Provider User Identity Map User Passwords Map User Statistics Map Value Provider Map mTAN Token Flow Value Map
Event (event)
Description
The general Loginapp event about which the subscriber should be notified.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Airlock 2FA Device Activated Airlock 2FA Device Deleted Airlock 2FA Device In Cooldown Used Authentication Flow Successfully Completed Authentication Method Changed Context Data Changed Cronto Device Activated Cronto Device Deleted Cronto Letter Ordered Device Token Deleted Device Token Registered Email Address Added Email Address Changed Email Address Deleted FIDO Credential Deleted FIDO Credential Registered Filtered Flow Event Generic Step Result Generic Step Result With Identified User Logged in from new Device MTAN Token Deleted MTAN Token Phone Number Changed MTAN Token Registered OATH OTP Secret Added OATH OTP Secret Viewed OAuth 2.0 User Consent Processed Password Changed Password Letter Ordered User Created User Locked User Realm Changed User Unlocked
YAML Template (with default values) 

type: LoginappEmailEventSubscriber
id: LoginappEmailEventSubscriber-xxxxxx
displayName: 
comment: 
properties:
  bodyResourceKey: email.notification.body
  emailService:
  event:
  language:
  recipientAddress:
  sendAsHtml: false
  subjectResourceKey: email.notification.subject
  valueMapProviders: