E-mail notification system
From FileRun Documentation
Contents |
Introduction
There are 60 actions that FileRun can monitor in order to send e-mail notifications. Each action can have its own e-mail body template. For each action there is a corresponding template file, located inside the folder “/path-to-filerun/customizables/emails/". For the actions that do not have a template file, the template "/path-to-filerun/customizables/emails/generic.tpl.txt" will be used.
The template file "/path-to-filerun/customizables/emails/actions.tpl.txt" is used to configure the following information for all the outgoing notifications:
- From e-mail address
- An optionl BCC (Blind carbon copy) e-mail address
- E-mail subject
- Body content
Adding an email notification template
Each action has a unique keyname. Here are two examples:
- “upload” for “When a file gets uploaded.”
- “download” for “When a file gets downloaded”).
(You can check the table found at the end of this document for a full list of keynames.)
To add a custom template for a certain action, a text file named “keyname.tpl.txt” should be created in the e-mail notifications templates folder (as pointed above).
E-mail template file format
<Action>
[...]
User "{$info.userInfo.name}" has performed the following action: "{$info.details.action}
[...]
</Action>
The XML tags (<Action>, <From>, <Subject>, etc...) should not be altered or removed from the template files.
The following Smarty variables are available for use inside the templates:
| {$info.userInfo.username} | User’s login name. |
| {$info.userInfo.name} | User’s name. |
| {$info.userInfo.company} | Company name |
| {$info.userInfo.website} | User’s website address. |
| {$info.userInfo.description} | User’s admin note. |
| {$info.config.url.root} | The URL of the FileRun installation. |
| {$info.settings} | Array containing FileRun's current settings. |
| {$info.details} | Array containing details related to the performed action.
The structure varies according to each specific action. |
(For more information on how to use Smarty syntax please check http://smarty.php.net/manual/en/language.basic.syntax.php)
Actions keynames
| More often used | |
| upload | File uploaded |
| receive_upload | File received (via upload) |
| receive_copy | File received (via copy) |
| receive_move | File received (via move) |
| download | File downloaded |
| weblink_download | WebLink download |
| shared_folder_available | New shared folder available |
| comment_added | File comment added |
| comment_received | Comment received on a file from other user |
| login | Login |
| folder_shared | Folder shared |
| Less used | |
| logout | Logout |
| login_failed | Login failed |
| login_failed_account_deactivated | Account deactivated |
| comment_removed | File comment removed |
| folder_unshared | Folder unshared |
| Successful file actions | |
| file_moved | File moved |
| file_copied | File copied |
| file_deleted | File deleted |
| deleted_file_restored | Restored deleted file |
| trash_delete_file | File permanently deleted |
| file_renamed | File renamed |
| zip_files | Files zipped |
| files_send_by_email | Files sent by email |
| file_locked | File locked |
| file_unlocked | File unlocked |
| version_restored | File version restored |
| version_deleted | File version deleted |
| Successful folder actions | |
| new_folder | New folder created |
| folder_moved | Folder moved |
| folder_deleted | Folder deleted |
| deleted_folder_restored | Restored deleted folder |
| trash_delete_folder | Folder permanently deleted |
| folder_renamed | Folder renamed |
| folder_copied | Folder copied |
| zip_folder | Folder zipped |
| Failed file actions | |
| upload_failed | Upload failed |
| file_copy_failed | Failed to copy file |
| file_deletion_failed | Failed to delete file |
| file_move_failed | Failed to move file |
| failed_file_rename | Failed to rename file |
| zip_files_failed | Failed to zip files |
| files_send_by_email_failed | Failed to send files by email |
| file_lock_failed | Failed to lock file |
| file_unlock_failed | Failed to unlock file |
| failed_to_add_comment | Failed to add comment to file |
| failed_to_remove_comment | Failed to remove comment from file |
| version_restoration_failed | Failed to restore file version |
| version_deletion_failed | Failed to delete file version |
| Failed folder actions | |
| new_folder_failed | Failed to create new folder |
| failed_folder_rename | Failed to rename folder |
| folder_copy_failed | Failed to copy folder |
| folder_deletion_failed | Failed to delete folder |
| folder_move_failed | Failed to move folder |
| zip_folder_failed | Failed to zip folder |
| Misc | |
| new_user_registration | New user registration |
| Administrative | |
| user_added | User added |
| user_edited | User edited |
| user_deleted | User deleted |
| space_quota_warning | Space quota usage warning |
E-mail notification digest
You can configure FileRun to send all the notifications for a certain time period in a single e-mail message.
To enable this uncheck the option "Instant email notifications" available in "Control Panel" » "System configuration" » "E-mail settings". The notification will no longer be sent instantly, but queued until you run the following script "//path-to-filerun/cron/email_notifications.php". Using a Cron job on Linux servers or a scheduled task on Windows, you can choose the time interval the e-mail notifications are getting sent.