Difference: MailerContrib (7 vs. 8)

Revision 82010-05-26 - TWikiContributor

Line: 1 to 1
 

Mailer Contrib

Deleted:
<
<

Allows users to "subscribe" to regularly scheduled e-mails containing either:

  • A report on changes to all topics that have changed within a particular TWiki web.
  • A report on changes to a specific topic or set of topics the user can define flexibly.
  • The entire content of a specific topic or set of topics. This is referred to as "news mode."
  • The companion plugin (TWiki:Plugins.SubscribePlugin) lets you trivially add a "Subscribe to changes" button to topics
 
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:
<
<
>
>
  • A report on changes to all topics that have changed within a particular TWiki web.
  • A report on changes to a specific topic or set of topics the user can define flexibly.
  • The entire content of a specific topic or set of topics. This is referred to as "news mode."
  • The companion plugin (TWiki:Plugins.SubscribePlugin) lets you trivially add a "Subscribe to changes" button to topics
 

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:
<
<
__ALERT! 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.
>
>
ALERT! 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 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:
<
<
ALERT! 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.
>
>
ALERT! 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:
>
>
 
HTML:before Section of a HTML mail before the changes
HTML:middle Repeated in a HTML mail for each change
HTML:after Section of a HTML mail after the changes
Line: 173 to 178
 

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:

Author: TWiki:Main/CrawfordCurrie (http://c-dot.co.uk)
Changed:
<
<
Copyright ©: 2004, Wind River Systems; 2006, http://WikiRing.com
License: GPL
Version: 17629 (14 Oct 2008)
Change History:  
14 Oct 2008 TWikibug:Item6066: fixed issue for user mappings where cuid = login
>
>
Copyright: © 2004, Wind River Systems;
© 2008, http://WikiRing.com
© 2004-2010 TWiki:TWiki/TWikiContributor
License: GPL (GNU General Public License)
Version: 18799 (2010-05-29)
Change History:
<-- specify latest version first -->
 
2010-05-26: TWikibug:Item6474 - Fix for mailnotify failing due to non-existing _alert method
2010-05-21: TWikibug:Item6433 - more doc fixes
2010-04-25: TWikibug:Item6433 - doc fixes, no code changes
15 Oct 2008 TWikibug:Item: generalised code to enable TWiki:Codev.SubscribePlugin to delegate parsing to MailerContrib - TWiki:Main.SvenDowideit
14 Oct 2008 TWikibug:Item6066: fixed issue for user mappings where cuid = login - TWiki:Main.SvenDowideit
 
27 Aug 2008 TWikibug:Item5949: fixed problem with unsubscribe that should result in an empty subscription
03 Aug 2008 TWiki 4.2.1 release version
27 Jul 2008 TWikibug:Item5776: TWiki:Main.KennethLavrsen added note to warn against running multiple instances of mailnotify at the same time.
Line: 230 to 237
 
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
Changed:
<
<
Home: TWiki:Plugins/MailerContrib
Feedback: TWiki:Plugins/MailerContribDev
>
>
Home: http://TWiki.org/cgi-bin/view/Plugins/MailerContrib
Feedback: http://TWiki.org/cgi-bin/view/Plugins/MailerContribDev
 
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/MailerContribAppraisal
Changed:
<
<
META FILEATTACHMENT attr="h" comment="" name="wikiringlogo20x20.png" version="1"
META FILEATTACHMENT attr="h" comment="" name="logo.gif" version="1"
>
>
Related Topics: TWikiPreferences
 
This site is powered by the TWiki collaboration platformCopyright © 1999-2019 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.