* subscriber [ : topics ]
Where subscriber can be a WikiName, an email address, or a group name. If subscriber contains any characters that are not legal in an email address, then it must be enclosed in 'single' or "double" quotes. 
Note: The guest user WikiGuest does not have an email address mapped to it, and will never receive email regardless of the configuration of that user.
topics is an optional space-separated list of topics: * in a topic name, where it is treated as a wildcard character. A * will match zero or more other characters - so, for example, Fred* will match all topic names starting with Fred, *Fred will match all topic names ending with Fred, and * will match all topic names.
%STARTPUBLISH% and %STOPPUBLISH% markers within the topic.
* daisy.cutter@flowers.comSubscribe Daisy to all changes to topics that start with
Web.
* daisy.cutter@flowers.com : Web*Subscribe Daisy to changes to topics starting with
Petal, and their immediate children, WeedKillers and children to a depth of 3, and all topics that match start with Pretty and end with Flowers e.g. PrettyPinkFlowers.
* DaisyCutter: Petal* (1) WeedKillers (3) Pretty*FlowersSubscribe StarTrekFan to changes to all topics that start with
Star except those that end in Wars, sInTheirEyes or shipTroopers.
* StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopersSubscribe Daisy to the full content of
NewsLetter whenever it has changed.
* daisy@flowers.com: NewsLetter?Subscribe buttercup to
NewsLetter and its immediate children, even if it hasn't changed.
* buttercup@flowers.com: NewsLetter! (1)Subscribe GardenGroup (which includes Petunia) to all changed topics under
AllNewsLetters to a depth of 3. Then unsubscribe Petunia from the ManureNewsLetter, which she would normally get as a member of GardenGroup:
* GardenGroup: AllNewsLetters? (3) * petunia@flowers.com: - ManureNewsLetterSubscribe
IT:admins (a non-Foswiki group defined by an alternate user mapping) to all changes to Web* topics.
* 'IT:admins' : Web*A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified about changes in that topic once (though they will still receive individual mails for news topics). If a group is listed for notification, the group will be recursively expanded to the email addresses of all members.
Warning: Because an email address is not linked to a user name, there is no way for Foswiki to check access controls for subscribers identified by email addresses. A subscriber identified by an email address alone will only be sent change notifications if the topic they are subscribed to is readable by guest users. You can limit which email addresses can be used in WebNotify, or even block use of emails altogther, using the {MailerContrib}{EmailFilterIn} setting in configure.
Tip: List names in alphabetical order to make it easier to find the names.SEARCH. The number of topics listed by the limit parameter.:
%SEARCH{ "1" web="%BASEWEB%" type="query" nosearch="on"
order="modified" reverse="on" limit="50"
}%
%SEARCH{}%.
SEARCH:
%SEARCH{"1" scope="topic" type="query" nosearch="on" }%
%STATISTICSTOPIC%
cron job
{Log}{Dir} setting in configure Logging and Statistics tab.
events.log Old events are archived as events.<year><month>
working/logs/events.log
| <time> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> |
| 08 Feb 2023 - 15:51 | WikiGuest | view | WebRss | | 66.124.232.02 |
| Script | Action name | Extra info |
|---|---|---|
| attach | attach | when viewing attach screen of previous uploaded attachment: filename |
| changes | changes | |
| edit | edit | when editing non-existing topic: (not exist) |
| login | login | Authentication failure or success |
| manage | rename | when moving topic: moved to Newweb.NewTopic |
| manage | move | when moving attachment: Attachment filename moved to Newweb.NewTopic |
| manage | renameweb | when renaming a web: oldweb moved to newweb |
| rdiff | rdiff | higher and lower revision numbers: 4 3 |
| register | regstart | WikiUserName, e-Mail address, UserName: user attempts to register |
| register | register | E-mail address: user successfully registers |
| register | bulkregister | WikiUserName of new, e-mail address, admin ID |
| 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 |
| save | cmd | special admin parameter used when saving |
| search | search | search string |
| upload | upload | filename |
| view | view | when viewing non-existing topic: (not exist) when viewing previous topic revision: r3 |
| n/a | logout | When authentication information is cleared |
{Log}{Action} EXPERT setting in configure.
Mail tab tool (LocalSite.cfg). The configure tool fully documents these setting.
The notify e-mail uses the default changes.tmpl template, or a skin if activated by a preference setting.
mailnotify also relies on a hidden file in each data/Web directory: .changes and a file with the Web name (one per web) in the working/work_areas/MailerContrib/ directory. Make sure both are writable by your web server process. .changes contains a list of changes; The file in the working/work_areas/MailerContrib/ directorycontains a timestamp of the last time notification was done for the web.Both files are automatically created as needed.
Caution: Older versions of Foswiki, and especially TWiki migrations might configure e-mail in the preference settings topic.Make sure you delete that setting if you are using a SitePreferences topic from a previous release of Foswiki. These settings are no longer used and have been removed.
| Parameter | configure (Current) |
preference settings (Legacy) |
Default | Description |
|---|---|---|---|---|
| Global enable | {EnableEmail} |
n/a | enabled |
Globally enable/disable email support. |
| Extermal mail program | {MailProgram} |
n/a | '/usr/sbin/sendmail -t -oi -oeq' |
E-mail program used when Net:SMTP is unavailable |
| Mail relay host | {SMTP}{MAILHOST} |
SMTPMAILHOST |
not set | Destination SMTP Server used to receive and relay email. Net::SMTP is disabled if this is not set. |
| Mail sending hostname | {SMTP}{SENDERHOST} |
SMTPSENDERHOST |
not set | Hostname used to identify sender. Some SMTP configurations will require this. |
| SMTP Password | {SMTP}{Password} |
not supported | not set |
cron table so that mailnotify is called in an interval of your choice. Please consult man crontab for how to modify the table that schedules program execution at certain intervals. Example:
% crontab -e 0 1 * * * (cd /path/to/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.