mailnotify
is called by a background process at regular intervals. The script sends an automated e-mail to subscribed users if topics were changed in a web since the script was last run.
%NOTIFYTOPIC%
%USERSWEB%
instead of Main
, but this is not necessary even if you have renamed the main web by configuring {MainWebName}
in configure.
SEARCH
. The number of topics listed by the limit
parameter.:
%SEARCH{ ".*" web="TWiki" type="regex" nosearch="on" order="modified"
reverse="on" limit="50" }%
%SEARCH{}%
.
SEARCH
:
%SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" }%
%STATISTICSTOPIC%
twiki/bin/statistics
script from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs.
nobody
on many systems. Example crontab entry: 0 0 * * * (cd /path/to/twiki/bin; ./statistics >/dev/null 2>&1)
nobody
: Run the utility twiki/tools/geturl.pl
in your cron job and specify the URL of the twiki/bin/statistics
script as a parameter. Example: 0 0 * * * (cd /path/to/twiki/tools; ./geturl.pl mydomain.com /urlpath/to/twiki/bin/statistics >/dev/null 2>&1)
geturl.pl
will do a TWiki CGI request as the TWikiGuest user, so if you use this workaround, the WebStatistics topics you are updating will have to be writable by TWikiGuest.
./statistics -logdate 200605 -webs TWiki,Sandbox
twiki/bin/statistics
script can also be executed as a CGI script, just enter the URL in your browser. Examples: /twiki/bin/statistics
/twiki/bin/statistics/Main
/twiki/bin/statistics/Main?logdate=201912
/twiki/bin/statistics?logdate=201912;webs=ProjectX,ProjectY,ProjectZ
log<year><month>.txt
twiki/logs/log201912.txt
| <time> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> |
| 10 Dec 2019 - 17:32 | TWikiGuest | view | WebRss | | 66.124.232.02 |
Script | Action name | Extra info![]() |
---|---|---|
register | bulkregister | WikiUserName of new, e-mail address, admin ID |
register | regstart | WikiUserName, e-Mail address, LoginName: user attempts to register |
changes | changes | |
viewfile | viewfile | Attachment name and revision: File.txt, r3 |
register | register | E-mail address: user successfully registers |
upload | upload | filename |
rdiff | rdiff | higher and lower revision numbers: 4 3 |
login, logon, attach, edit, register, rest, view, vewfile | sudologin , sudologout | Login name of administrator user who is logging in or out |
manage | changepasswd | Login name of user who's password is changed |
resetpasswd | resetpasswd | Login name of user who's password is reset |
search | search | search string |
save | cmd | special admin parameter used when saving |
edit | edit | when editing non-existing topic: (not exist) |
rename | move | when moving attachment: Attachment filename moved to Newweb.NewTopic |
rename | rename | when moving topic: moved to Newweb.NewTopic |
rename | renameweb | when renaming a web: moved to Newweb |
save | save | when replacing existing revision: repRev 3 when user checks the minor changes box: dontNotify when user changes attributes to an exising attachment: filename.ext |
attach | attach | when viewing attach screen of previous uploaded attachment: filename |
view | view | when viewing non-existing topic: (not exist) when viewing previous topic revision: r3 |
Net::SMTP
module if it is installed on your system. Set this with the SMTPMAILHOST
variable in TWikiPreferences.
The notify e-mail uses the default changes.tmpl
template, or a skin if activated in the TWikiPreferences.
mailnotify also relies on two hidden files in each twiki/data/Web
directory: .changes
and .mailnotify.
Make sure both are writable by your web server process. .changes
contains a list of changes; go ahead and make this empty. .mailnotify
contains a timestamp of the last time notification was done.
You can use an external mail program, such as sendmail
, if the Net::SMTP
module is not installed. Set the program path in {MailProgram}
in configure.
SMTPMAILHOST
in TWikiPreferences to an empty value.
SMTPSENDERHOST
variable to define the mail sender host (some SMTP installations require this).
cron
table so that mailnotify
is called in an interval of your choice. Please consult man crontab
of how to modify the table that schedules program execution at certain intervals. Example:
% crontab -e 0 1 * * * (cd /path/to/twiki/bin; ./mailnotify -q)The above line will run mailnotify nightly at 01:00. The
-q
switch suppresses all normal output.
For ISP installations: Many ISPs don't allow hosted accounts direct cron access, as it's often used for things that can heavily load the server. Workaround scripts are available.
On Windows: You can use a scheduled task if you have administrative privileges. TWiki:Codev/CronTabWin is a free scheduler for Windows.