← Back to plugin index

Email Notification Task
Description
Sends an email notification to all users returned by the specified iterator. After the notification has been sent successfully, the current date is written to the specified user attribute.
Type name
EmailNotificationTask
Class
com.airlock.iam.servicecontainer.app.application.configuration.task.EmailNotificationTask
May be used by
Task Schedule
Properties
Email Service (emailService)
Description
The Email Service plugin used to send emails.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Dummy Email Service SMTP Email Service
Subject Renderer (subjectRenderer)
Description
The subject renderer is used to create the language-dependent email subject.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Simple Text Renderer Text File Renderer
Content Renderer (contentRenderer)
Description
The content renderer is used to create the language-dependent email content.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Simple Text Renderer Text File Renderer
Content Is HTML (contentIsHtml)
Description
Defines whether the email content should be treated as HTML or plain text. This flag affects the MIME type of the email body.
Attributes
Boolean
Optional
Default value
false
User Persister (userPersister)
Description
The User Persister plugin used to read user data and write the date when the email was sent.
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
User Iterator (userIterator)
Description
The User Iterator defines the set of users a notification email is sent to. It has to be configured to return correct user set.
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
Notification Sent Date Context Attribute (notificationSentDateContextAttribute)
Description
Selects the user context attribute to store the date and time when the notification email was sent. Make sure it is configured in the configured user persister.
If not configured, the context data field with the name 'inactivity_reminder_sent_date' is used.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Date And Time Context Data Item Name
Email Address Context Attribute (emailAddressContextAttribute)
Description
Selects the user context attribute to read the recipient's email address from.
If not configured, the context data field with the name 'email' is used.
Attributes
Plugin-Link
Optional
Assignable plugins
String Context Data Item Name
Givenname Context Attribute (givennameContextAttribute)
Description
Selects the user context attribute to read the recipient's given name from. This is used for the human-readable name in the "to:" field, but has no effect on the data used for subject or body.
If not configured, the context data field with the name 'givenname' is used.
Attributes
Plugin-Link
Optional
Assignable plugins
String Context Data Item Name
Surname Context Attribute (surnameContextAttribute)
Description
Selects the user context attribute to read the recipient's surname from. This is used for the human-readable name in the "to:" field, but has no effect on the data used for subject or body.
If not configured, the context data field with the name 'surname' is used.
Attributes
Plugin-Link
Optional
Assignable plugins
String Context Data Item Name
Correspondance Language Context Attribute (correspondanceLanguageContextAttribute)
Description
Selects the user context attribute to read the recipient's correspondence language from.
If not configured, the context data field with the name 'language' is used.
Attributes
Plugin-Link
Optional
Assignable plugins
String Context Data Item Name
YAML Template (with default values) 

type: EmailNotificationTask
id: EmailNotificationTask-xxxxxx
displayName: 
comment: 
properties:
  contentIsHtml: false
  contentRenderer:
  correspondanceLanguageContextAttribute:
  emailAddressContextAttribute:
  emailService:
  givennameContextAttribute:
  notificationSentDateContextAttribute:
  subjectRenderer:
  surnameContextAttribute:
  userIterator:
  userPersister: