← Back to plugin index

Mail Notificator

Description
Event notificator that sends an email to a configured address for each event. It uses SMTP to send emails.
Type name
MailNotificator
Class
com.airlock.iam.core.misc.impl.notification.MailNotificator
May be used by
Properties
SMTP Host (smtpHost)
Description
The name or ip address of the SMTP host (mail server).
Attributes
String
Mandatory
Example
smtp
Example
mailer.company.com
Example
192.168.0.13
SMTP Port (smtpPort)
Description
The port number of the SMTP server (mail server). Usually it is port 25.
Attributes
Integer
Optional
Default value
25
SMTP User (smtpUser)
Description
The user to authenticate at the SMTP server. This property is optional. If not set or empty, no authentication is performed when connecting to the SMTP server.
Attributes
String
Optional
Example
mail
Example
root
Example
userxyz
SMTP Password (smtpPassword)
Description
The password to authenticate at the SMTP server. This property is optional. If not set or empty, no authentication is performed when connecting to the SMTP server.
Attributes
String
Optional
Sensitive
From Address (fromAddress)
Description
The from-address of the email being sent when handling an event.
Attributes
String
Mandatory
Example
airlock@yourcompany.com
Example
authserver@intranet.net
To Addresses (toAddresses)
Description
The to-address of the email being sent when handling an event. Multiple addresses can be specified using a comma-separated list (no spaces!).
Attributes
String-List
Mandatory
Mail Subject (mailSubject)
Description
The subject of the email being sent when handling an event.
Attributes
String
Mandatory
Example
Airlock IAM Notification: Renew Matrix Card
Example
Notificator for Password Letters
Mail Template (mailTemplate)
Description
The name of mail template file used to generate the mail body.

The mail template may contain references enclosed in <%...%>. A corresponding get-method call (bean-like) is performed on the event object and the return value of the method call is used to replace the reference.
Example: let the mail template contain the following excerpt.
Dear Mrs. <%lastName%>

 You are subject to our ...
The method getLastName() is invoked on the event object handled and the return value of the method replaces the <%lastName%> in the mail.

Attributes
File/Path
Mandatory
Mail Template Encoding (mailTemplateEncoding)
Description
This optional property specifies the file encoding of the mail template file.

This configuration property is optional. If the property is not set, the default file encoding (as returned by System.getProperty("file.encoding") is used.

Attributes
String
Optional
Default value
UTF-8
Allowed values
UTF-8, ISO-8859-1, UTF-16, UTF-16BE, UTF-16LE, US-ASCII, ISO-8859-15
YAML Template (with default values)

type: MailNotificator
id: MailNotificator-xxxxxx
displayName: 
comment: 
properties:
  fromAddress:
  mailSubject:
  mailTemplate:
  mailTemplateEncoding: UTF-8
  smtpHost:
  smtpPassword:
  smtpPort: 25
  smtpUser:
  toAddresses: