The primary purpose of this screen is to allow admin users to customise the notification messages that are sent out. The outgoing emails can use html formatting so, within the email contents, you can enter lines like:
You could add background or use colours - just treat yourself to an html editor or a book on HTML to explore the full range of possibilities. You cannot use HTML in the email subject lines, only within the email body/contents.
The code also allows for a number of fields pertaining to the subscribed file to be included in the email - if you put the text '[fname]' in your email subject or contents then the filename of the document will be substituted. The fields that are permitted for substitution are:
[fname] - the filename
[fpath] - the full file path (including the filename).
[fid] - the file ID
[ftitle] - the document title (which defaults to the document filename if not filled in).
[flastmod] - the date the change was made - not really needed since the date of the email should be the time the change was made
[name] - the username of the user whose change to the document triggered the notification.
[mail] - the email address of the user whose change to the document triggered the notification.
[link] - a direct link to the document
[parent_link] - a direct link to the parent directory
Note that for 'change' emails (where the file metadata or name changes) the fields that have changed are included automatically at the end of the notification email.
The following options are available on the admin subscription setting form:
Option |
Function |
Allow subscriptions (dbfm_subson) | This checkbox gives the admin user the option of enabling or switching off all subscriptions. |
Items per page (dbfm_subppage) | the maximum number of entries per page on the 'My Subscriptions' and 'My documents' pages (in 'My Accounts'). |
Reply email (dbfm_subscribemail) | the email address used to send the subscription emails (if not entered this will default to whatever is in the php.ini file) |
Change Subject (dbfm_change_subj) | Configure the subject line of the email that is sent when the metadata for a file is changed or the file is renamed. |
Change Contents (dbfm_change_body) | Configure the body of the email that is sent when the metadata for a file is changed or the file is renamed. |
New Revision Subject (dbfm_revise_subj) | Configure the subject line of the email that is sent when a new revision is added to a version directory. |
New Revision Contents (dbfm_revise_body) | Configure the body of the email that is sent when a new revision is added to a version directory. |
Convert to Version Subject (dbfm_convert_subj) | Configure the subject line of the email that is sent when a file is converted into a version. |
Convert to Version Contents (dbfm_convert_body) | Configure the body of the email that is sent when a file is converted into a version. |
Overwrite Subject (dbfm_overwrite_subj) | Configure the subject line of the email that is sent when a file is overwritten. |
Overwrite Contents (dbfm_overwrite_body) | Configure the body of the email that is sent when a file is overwritten. |
Delete Subject (dbfm_delete_subj) | Configure the subject line of the email that is sent when a file is deleted. |
Delete Contents (dbfm_delete_body) | Configure the body of the email that is sent when a file is deleted. |
Additional notifications for when a file or directory is moved could be added in the future if required.