Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Added: | ||||||||
> > | MailerContribAdd-on to the TWiki kernel that supports e-mail notification of changes. | |||||||
Changed: | ||||||||
< < | This module is an add-on to the TWiki kernel that supports e-mail notification of changes. | |||||||
> > | ||||||||
WARNING: TWiki-4 only. If you want to use this extension with an earlier version of TWiki, please see here | ||||||||
Changed: | ||||||||
< < | Summary of Contents | |||||||
> > | Summary of Contents | |||||||
The main part of the mailer module is a script, tools/mailnotify . This script is designed to be run from 'cron' (or an equivalent offline job scheduler), and processes the contents of the standard WebNotify topic. As well as providing the usual notification service, it also provides per-topic notification services. The script may be run from the command line or a cron job.
<-- Included by WebChangesAlert --> | ||||||||
Line: 53 to 56 | ||||||||
Note mailnotify ignores permissions in webs. It is entirely possible for a user to get added to a WebNotify topic in a web, when they are not authorised to view the topics in that web. This could result in them having limited access to sensitive information (the topic summaries). | ||||||||
Changed: | ||||||||
< < | | |||||||
> > | | |||||||
The second part of the module is a code library that provides the services for other applications to modify WebNotify through a clean, well documented interface. This allows (for example) plugin developers to add a "Register me for notification" button to their pages. The main interface is the WebNotify package described below. | ||||||||
Changed: | ||||||||
< < | Installation Instructions | |||||||
> > | Installation Instructions | |||||||
This Contrib is pre-installed as part of the TWiki release package, and should only have to be re-installed if an upgrade is required.
| ||||||||
Changed: | ||||||||
< < | Setting up your cron job | |||||||
> > | Setting up your cron job | |||||||
You need to set up a cron (or equivalent) job to run mailnotify . | ||||||||
Changed: | ||||||||
< < | Usage: perl -I
| |||||||
> > | Usage: perl -I <bin> mailnotify [-q] [ web1 web2 ... webN ]
<bin> is the path to the TWiki bin directory (usually ../bin ), so that the script can find the rest of TWiki. | |||||||
perl -I /usr/local/twiki/bin mailnotify -q Public Private will generate notifications for the Public and Private webs. | ||||||||
Changed: | ||||||||
< < | Settings
| |||||||
> > | Settings | |||||||
| ||||||||
Added: | ||||||||
> > |
| |||||||
Changed: | ||||||||
< < | Contrib Info | |||||||
> > | Contrib Info | |||||||
| ||||||||
Line: 114 to 117 | ||||||||
| ||||||||
Added: | ||||||||
> > |
| |||||||
Deleted: | ||||||||
< < | Related Topics: TWikiPreferences | |||||||
Deleted: | ||||||||
< < | -- TWiki:Main/CrawfordCurrie |
Line: 1 to 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Added: | |||||||||||||||||||||||||||||||||||||||||||||||||||
> > | |||||||||||||||||||||||||||||||||||||||||||||||||||
This module is an add-on to the TWiki kernel that supports e-mail notification of changes. | |||||||||||||||||||||||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||||||||||||||||||||||
> > | WARNING: TWiki-4 only. If you want to use this extension with an earlier version of TWiki, please see here | ||||||||||||||||||||||||||||||||||||||||||||||||||
Summary of Contents | |||||||||||||||||||||||||||||||||||||||||||||||||||
Line: 71 to 81 | |||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Line: 1 to 1 | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Added: | |||||||||||||||||||||||||||||
> > | This module is an add-on to the TWiki kernel that supports e-mail notification of changes.
Summary of Contents
The main part of the mailer module is a script, |
-q | Don't print progress information |
web1 web2 ... webN | List of webs to process, separated by spaces or commas. Default is to process all legal TWiki webs. Wildcards (*) are supported. |
perl -I /usr/local/twiki/bin mailnotify -q Public Private
will generate notifications for the Public and Private webs.
Author: | TWiki:Main/CrawfordCurrie (http://c-dot.co.uk) |
Copyright ©: | 2004, Wind River Systems |
License: | GPL |
Change History: | <-- versions below in reverse order --> |
4 March 2005 | 1.010 Dakar release ready. |
12 Oct 2004 | 1.004 Added support for anti-subscriptions. Doc fixes from TWiki:Main.PeterThoeny. Bug fixes to permissions code. Back-off and retry if the mailer can't be reached (should really be in Net::sendEmail) |
6 Oct 2004 | 1.003 Excluded _ webs from processing, added bin/remove_obsolete_locks for full reverse-compatibility |
1 Oct 2004 | 1.002 PeterThoeny provided additional documentation |
27 Sep 2004 | 1.001 runnable as CGI script, minor bugfixes, removed dependency on DBCacheContrib |
8 Sep 2004 | 1.000 Initial version |
Home: | TWiki:Plugins/MailerContrib |
Feedback: | TWiki:Plugins/MailerContribDev |