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 the 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 mail field value to the user's email address. When this parameter is disabled, it will use the default From mail address for all the emails sent by the application (all emails sent by the application will have the same From mail 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 mail with a From mail field value of user@mail.com, this kind of mail server configuration is usually set to prevent spam), then this parameter must be designated as "false." true |
|
notification.message.subject |
Text |
The subject of the message is sent when a user has chosen to notify someone else. OpenKM - NOTIFICATION |
|
notification.message.body |
HTML |
Body of the message sent when a user has chosen to notify someone else. ReplaceMessage: ${notificationMessage} User: ${userId} <#list documentList as doc>Document: ${doc.path} |
|
subscription.message.subject |
Text |
The subject of the message is sent automatically in response to some event. This happens because the user is subscribed to some node. OpenKM - ${eventType} - ${documentPath} |
|
subscription.message.body |
HTML |
The body of the message is sent automatically in response to some event. This happens because the user is subscribed to some node. Date: ${eventDate?string("yyyy-MM-dd HH:mm:ss")} Document: ${documentPath} User: ${userId} Event: ${eventType} Comment: ${subscriptionComment} |
|
download.message.body |
HTML |
The body of the message is sent when a user shares a document with others for downloading. Your archive is ready. Please download it from ${url} |
|
download.message.subject |
String |
The subject of the message is sent when a user shares a document with others for downloading. OpenKM - DOWNLOAD |
|
download.token.validity |
Integer |
The number of days the download URL will be available. 7 |
|
template.message.body |
String |
Set the basic template for all notifications. |
|
notification.url |
String |
The notification URL parameter is the template URL that OpenKM uses for building the direct access URL to OpenKM nodes (documents, folders, emails, records). 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 user name who caused the event.
- ${userId} shows the user ID who caused the action.
- ${notificationMessage} shows the notification message.
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:
