Notification configuration parameters
When a user is subscribed to a document, any change to the document will trigger an email notification. These email messages are created using predefined templates, and these default templates for creating messages can be adapted to your style.
| Field / Property | Type | Description |
|---|---|---|
|
send.mail.from.user |
Boolean |
By default, the application sends mail notifications, setting the 'from' email field value to the user's email address. When this parameter is disabled, it will use the default from email address for all emails sent by the application (all emails sent by the application will have the same 'from' email address). When the mail server restricts changing the default 'from' mail field (for example, when it is not allowed to use the general@mail.com account to send a mail with the 'from' mail field value user@mail.com, usually this kind of mail server configuration is set to prevent spam), then this parameter must be set to "false." true |
|
notification.message.subject |
Text |
The subject of the message sent when a user has chosen to notify about something else. OpenKM - NOTIFICATION |
|
notification.message.body |
HTML |
Body of the message sent when a user has chosen to notify about something else. ReplaceMessage: ${notificationMessage} User: ${userId} <#list documentList as doc>Document: ${doc.path} |
|
subscription.message.subject |
Text |
Subject of the message sent automatically due to some event. This happens because the user is subscribed to a node. OpenKM - ${eventType} - ${documentPath} |
|
subscription.message.body |
HTML |
Body of the message sent automatically due to some event. This happens because the user is subscribed to a node. Date: ${eventDate?string("yyyy-MM-dd HH:mm:ss")} Document: ${documentPath} User: ${userId} Event: ${eventType} Comment: ${subscriptionComment} |
|
task.message.subject |
Text |
The message's subject is sent when there's some change in the task assigned to a user. OpenKM - Task Manager Notification: ${message} |
|
task.message.body |
HTML |
Body of the message sent when there's some change to the task assigned to a user. Task: ${tasksubject} Start: ${taskstart!} End: ${taskend!} Project: ${taskproject!} Status: ${taskstatus!} Note: ${tasknote!} |
|
download.message.body |
HTML |
Body of the message sent when a user shares a document with others for download. Your archive is ready. Please download from ${url} |
|
download.message.subject |
String |
The message's subject is sent when a user shares a document with others for download. OpenKM - DOWNLOAD |
|
download.token.validity |
Integer |
Range of days during which the download URL will be available. 7 |
|
template.message.body |
String |
Set the basic template for all notifications. |
|
notification.url |
String |
KCenter user interface: http://localhost:8080/openkm/kcenter/# |
Substitutions
For notification.message.body property:
- ${documentUrl} shows the node URL.
- ${documentPath} shows the node path.
- ${documentName} shows the node name.
- ${userName} displays the name of the user who caused the event.
- ${userId} shows the user ID of the user who caused the action.
- ${notificationMessage} shows the notification message.
For task.message.body property:
- ${tasksubject} shows the subject of the task.
- ${taskstart} shows when the task started.
- ${taskend} shows when the task ended.
- ${taskproject} shows the task project.
- ${taskstatus} indicates the status of the task.
- ${tasknote} shows the notes.
FreeMarker does not allow you to render null values (it will throw an exception). If you expect a value to be null, you can also use the ! operator: ${content.title!}. This is equivalent to ${content.title!}.
More information at:
