Difference: MailerContrib (7 vs. 8)
Revision 82010-05-27 - TWikiContributor
| Line: 1 to 1 | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Mailer Contrib | |||||||||||||||||||
| Deleted: | |||||||||||||||||||
| < < | 
Allows users to "subscribe" to regularly scheduled e-mails containing either:
| ||||||||||||||||||
| Added: | |||||||||||||||||||
| > > | Send e-mail notification of changes to topics in TWiki webs | ||||||||||||||||||
| Added: | |||||||||||||||||||
| > > | Introduction | ||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < | WARNING: TWiki-4 only. If you want to use this extension with an earlier version of TWiki, please use revision 17 of the zip  . | ||||||||||||||||||
| > > | The Mailer Contrib allows users to "subscribe" to regularly scheduled e-mails containing either: | ||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < | |||||||||||||||||||
| > > |
| ||||||||||||||||||
tools/mailnotify | |||||||||||||||||||
| Line: 32 to 30 | |||||||||||||||||||
| The script collates the changes emails so that each subscriber only receives one changes notification for all changes in all webs in the TWiki. Furthermore, users can elect to receive just summaries of changes, or the entire content of topics that have changed. Each web can optionally contain a topic called WebNotify. | |||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < | <-- Included by WebChangesAlert --> | ||||||||||||||||||
| > > | <-- Included by WebChangesAlert --> | ||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < | Users subscribe to email notifications using their WikiName or an alternative email address, and can specify the webs/topics they wish to track, Whole groups of users can also be subscribed for notification. | ||||||||||||||||||
| > > | Users subscribe to email notifications using their WikiName or an alternative email address, and can specify the webs/topics they wish to track, Whole groups of users can also be subscribed for notification. | ||||||||||||||||||
The general format of a subscription is:
three spaces * subscriber [ : topics ] | |||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < | Where subscriber can be a WikiName, an E-mail address, or a | ||||||||||||||||||
| > > | Where subscriber can be a WikiName, an E-mail 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. | |||||||||||||||||||
| Line: 92 to 90 | |||||||||||||||||||
| If a group is listed for notification, the group will be recursively expanded to the e-mail addresses of all members. | |||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < | __ Warning: Because an email address is not linked to a user name, there is no way for TWiki 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 what email addresses can be used in %NOTIFYTOPIC%, or even block use of emails altogther, using the {MailerContrib}{EmailFilterIn} setting in =configure. | ||||||||||||||||||
| > > | Warning: Because an email address is not linked to a user name, there is no way for TWiki 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 what email addresses can be used in %NOTIFYTOPIC%, 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. | |||||||||||||||||||
| Line: 152 to 153 | |||||||||||||||||||
| will generate newsletters from all webs every week on midnight Saturday. | |||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < | Note: Multiple instances of mailnotify script are not allowed to be executed simutaneously. If you need to run the script multiple times with different options, make sure the cron jobs are scheduled so a previous run has finished before the next starts. You can also write a small script that runs mailnotify in sequence as described in TWiki:Support.DuplicateNotificationsFromMailerCon. | ||||||||||||||||||
| > > | Note: Multiple instances of mailnotify script are not allowed to be executed simultaneously. If you need to run the script multiple times with different options, make sure the cron jobs are scheduled so a previous run has finished before the next starts. You can also write a small script that runs mailnotify in sequence as described in TWiki:Support.DuplicateNotificationsFromMailerCon. | ||||||||||||||||||
| Added: | |||||||||||||||||||
| > > | |||||||||||||||||||
Developer Notes | |||||||||||||||||||
| Added: | |||||||||||||||||||
| > > | |||||||||||||||||||
The changes mails sent to subscribers are based on a TWiki template called mailnotify. This template must contain the following definitions. | |||||||||||||||||||
| Added: | |||||||||||||||||||
| > > | |||||||||||||||||||
| |||||||||||||||||||
| Line: 167 to 171 | |||||||||||||||||||
| |||||||||||||||||||
| Added: | |||||||||||||||||||
| > > | |||||||||||||||||||
The default template sends multipart mails containing both HTML and plaintext versions. You can easily provide a custom version of this template using a local skin.
Newsletters are sent after formatting using the standard view template, using whatever skin is selected in the topic being mailed.
Contrib Info | |||||||||||||||||||
| Deleted: | |||||||||||||||||||
| < < | Another great TWiki extension from the  WikiRing - working together to improve your wiki experience! | ||||||||||||||||||
Many thanks to the following sponsors for supporting this work:
| |||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < |
| ||||||||||||||||||
| > > |
| ||||||||||||||||||
| |||||||||||||||||||
| Line: 230 to 237 | |||||||||||||||||||
| |||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < |
| ||||||||||||||||||
| > > |
| ||||||||||||||||||
| |||||||||||||||||||
| Changed: | |||||||||||||||||||
| < < |
| ||||||||||||||||||
| > > | Related Topics: TWikiPreferences | ||||||||||||||||||
View topic | History: r19 < r18 < r17 < r16 | More topic actions...
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.MailerContrib.