$Foswiki::cfg{ReplaceIfEditedAgainWithin}
(default 3600 seconds / 1 hour), will be recorded as minor.
mailnotify
process runs in the interm between a recorded change, and a subsequent minor change, then the 2nd minor change will not trigger a new notification.
*
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.
{MailerContrib}{EmailFilterIn}
setting in configure
.!
or ?
specifiers the entire topic text is mailed out as HTML. The newsletter template is used to generate the content in this email, using whichever skin is selected in the topic being mailed.
In addition, the %STARTPUBLISH%
and %STOPPUBLISH%
markers used by Foswiki:Extensions.PublishPlugin to delimit the text to be published are respected in news mode.
configure
setting {MailerContrib}{RespectUserPrefs}
and defaults to LANGUAGE
.
cd /path/to/foswiki perl tools/extension_installer <NameOfExtension> installIf you have any problems, or if the extension isn't available in
configure
, then you can still install manually from the command-line. See https://foswiki.org/Support/ManuallyInstallingExtensions for more help.
mailnotify
script from the command line, with no parameters. In this case it will print out what it would have done to STDOUT
.
{MailerContrib}{EmailFilterIn}
setting in configure
. This allows you to limit the domains to which emails can be sent, or even block email addresses altogether.
configure
and save at least once after installing for the first time.cron
(or an equivalent off-line job scheduler), from the command-line, or from a web page.
tools/mailnotify
script.
The script is used as follows:perl -I bin mailnotify [-q] [-nonews] [-nochanges] [ web1 web2 ... webN ]
bin | path to the Foswiki bin directory, so that the script can find the rest of Foswiki |
-q |
Don't print progress information |
-nonews |
Skip the "news mode" (do not process subscriptions that include "!" or "?" following the topic) |
-nochanges |
Only run the news mode. (only process subscriptions that include "!" or "?" following the topic) |
-noreset |
Don't reset the timestamp after this run. The next run will repeat the same changes notified in this run |
-nomail |
Don't actually send mail, just show what would be done. Be sure to include -noreset or the timestamp will be reset even though no mail was sent. |
web1 web2 ... webN |
List of webs to process, separated by spaces or commas. The default is to process all webs. Wildcards (*) are supported. |
cron
(or equivalent) job to run the tools/mailnotify
script.
Setting up cron can be done in many ways. Below is an ultra-short overview which may be sufficient.
nobody
, =www-data
or =www=. A B C D E command to be executed
/etc/crontab
file, the syntax is A B C D E username command-to-be-executed
/usr/local/foswiki
, this cron entry:
0 0 * * * cd /usr/local/foswiki && perl -I bin tools/mailnotify -q Public Privatewill generate change notifications for the
Public
and Private
webs every night at midnight.
0 0 * * * cd /usr/local/foswiki && perl -I bin tools/mailnotify -q -Sandboxwill generate change notifications for all webs, except the
Sandbox
web.
0 0 * * 0 cd /usr/local/foswiki && perl -I bin tools/mailnotify -nochangeswill generate newsletters from all webs every week on midnight Saturday but will not process the non-newsletter subscriptions.
0 0 * * * cd /usr/local/foswiki && perl -I bin tools/mailnotify -nonewswill generate change notifications for all webs every night at midnight but will not process the newsletter subscriptions. To learn more about cron and crontab, Google for
crontab
.
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 Foswiki:Support.DuplicateNotificationsFromMailerCon.
Note: Even if you run separate -nonews
and -nochanges
cron jobs, the subscriptions using the "?" feature will only show the topics that changed since last time the mailnotify
script was run even if it was run with -nonews
. Separate newsletter jobs work best with the unconditional "!" mode.%SCRIPTURL{rest}%/MailerContribPlugin/notify
. The URL parameters webs
, nonews
, nochanges
, and excludewebs
correspond to the different command-line parameters.
nonews=1 |
Skip the "news mode" (do not process subscriptions that include "!" or "?" following the topic) |
nochanges=1 |
Only run the news mode. (only process subscriptions that include "!" or "?" following the topic) |
noreset=1 |
Don't reset the timestamp after this run. The next run will repeat the same changes notified in this run |
nomail=1 |
Don't actually send mail, just show what would be done. Be sure to include -noreset or the timestamp will be reset even though no mail was sent. |
webs=web1 web2 ... webN |
List of webs to process, separated by spaces or commas. The default is to process all webs. Wildcards (*) are supported. |
excludewebs=web1 web2 ... webN |
List of webs to exclude, separated by spaces or commas. The default is to process all webs. Wildcards (*) are supported. |
mailnotify
. This template must contain the following definitions.
HTML:before |
Section of an HTML email before the changes |
HTML:middle |
Repeated in an HTML email for each change |
HTML:after |
Section of an HTML email after the changes |
HTML:diff |
Topic diffs in HTML format |
PLAIN:before |
Section of a plain text email before the changes |
PLAIN:middle |
Repeated in a plain text email for each changes |
PLAIN:after |
Section of a plain text email after the changes |
PLAIN:diff |
Topic diffs in plain text format |
MailNotifyBody |
All the above are embedded in this. %HTML_TEXT% expands to the HTML obtained by expanding the HTML:* templates, %PLAIN_TEXT% from the PLAIN:* templates. The definitions may contain %DIFF_TEXT%. |
mailnotify.tmpl
file, or you will regret it later when it gets overwritten when you upgrade Foswiki. Instead, you should either use a skin setting to choose the template file, or use the web part of the template search path rules.
It is recommended to use the skin method, as it is easier to control, and requires less hacking around. Especially if you need to use the same tailoring for many (or all) webs.templates/mailnotify.tmpl
called templates/mailnotify.skiname.tmpl
. For example, templates/mailnotify.pattern.tmpl
, and modify this copy to your need. If you use the NatSkin simply use templates/mailnotify.nat.tmpl
instead
* Set SKIN = notifyskin,pattern
where the notifyskin is the dummy skin name and the pattern in this example is the real skin.
templates/mailnotify.notifyskin.tmpl
with your tailorings
* Set SKIN = notifywebname,pattern
where the notifywebname is the dummy skin name for this web and the pattern in this example is the real skin.
templates/mailnotify.notifywebname.tmpl
with your tailorings
templates
with the same names as the webs and place a templates/mailnotify.tmpl
in these subdirectories with your tailorings
view
template, using whichever skin is selected in the topic being mailed.
templates/mailnotify.customnotify.tmpl
which only contains these two lines
%TMPL:INCLUDE{"mailnotify"}% %TMPL:INCLUDE{"WebNotifyCustom"}%In the webs where you want the topic defined email format, we add the setting
* Set SKIN = customnotify,pattern(assuming pattern is the normal skin) And we create a topic in the web called WebNotifyCustomTemplate which contains the entire mailnotify template you want to use. Simply copy the content from
templates/mailnotify.tmpl
to this template and do the tailoring.
Copyright ©: | 2004, Wind River Systems; 2009-2014 Foswiki Contributors |
Change History: |
work_area
results in mega-spam.2.84 (8 Feb 2017) | Foswiki 2.1.3 Minor file permissions changes |
2.83 (15 Nov 2016) | Foswikitask:Item13936: Allow From: address of emails to be separately configured Foswikitask:Item14216: mailnotify fails with "Wide character in print" |
2.82 (14 Jun 2015) | Foswiki 2.0. Foswikitask:Item13423: Perl 5.22 deprecations Foswikitask:Item13378: Foswikitask:Item13387: utf-8 foswiki core Foswikitask:Item13323: use /usr/bin/env perl in scripts Foswikitask:Item13345: CGI deprecations. Foswikitask:Item13287: Regular expression updates Foswikitask:Item13125: CGI Changes Various documentation and copyright updates. |
2.81 (16 Jun 2014) | Foswiki:Tasks/Item12839: Fully specify the REST security parameters. Foswiki:Tasks/Item12943: notify REST handler crashes with invalid array ref. |
2.80 (28 Apr 2014) | Foswiki:Tasks/Item8425: support relative links better. Foswiki:Tasks/Item11507: support changing LANGUAGE via user preferences |
2.70 (27 Mar 2014) | Foswiki:Tasks/Item12717: fix inconsistencies in template expansion of mailnotify |
2.60 (25 Mar 2014) | Foswiki:Tasks/Item12786: fix flooding with unintended mails Foswiki:Tasks/Item12823: mark cron-generated mails as per RFC 3834, Foswiki:Tasks/Item12583: Convert to simple decimal version. |
2.5.5 (27 Aug 2013) | Foswiki:Tasks/Item12525: fix removal of subscriptions |
2.5.4 (25 Mar 2013) | Foswiki:Tasks/Item12447: correct support for character encodings |
2.5.3 (11 Sep 2012) | Foswiki:Tasks/Item12072: undocument non-existent -user parameter and update faulty examples |
Foswiki:Tasks/Item11138: Empty subscription without trailing space after colon is treated as wildcard for all topics | |
2.5.2 (2 Dec 2011) | Foswiki 1.1.4 Release: Foswiki:Tasks/Item11138: Foswiki:Tasks/Item11131: Document behavior with group subscriptions, Resolve issue with trailing spaces impacting subscriptions |
2.5.1 (25 Jul 2011) | Foswiki:Tasks/Item10980: fix case where interaction with SubscribePlugin could potentially break cached CGI (fcgid/mod_perl) |
2.5.0 (5 Apr 2011) | Foswiki:Tasks/Item9459: add DIFF template for improved change presentation |
2.4.4 (5 Apr 2011) | Foswiki:Tasks/Item10545: Fix overriding rules |
2.4.3 (30 Sep 2010) | Foswikitask:Item6011: document -user parameter and update examples in order to make fully functional on versions of Foswiki through 1.0.10; other documentation cleanup -- Foswiki:Main.WillNorris |
2.4.2 (31 Jul 2010) | Foswikitask:Item9415: Documentation updates |
2.4.1 (9 Jul 2010) | Foswikitask:Item9261: split of the plugin more completely to make configuration cleaner. No functional changes. |
2.4.0 (18 Dec 2009) | Foswikitask:Item2511: make a new tiny plugin module, to reduce load time for when the mailer isn't used in a request |
2.3.0 (8 Dec 2009) | Foswikitask:Item8316: Added REST handler, Foswikitask:Item2473: Foswikitask:Item2480: doc & dead code tidy-ups |
2.2.1 (4 Dec 2009) | Foswikitask:Item8354: Martin Rowe fixed a problem with STARTPUBLISH in newsletters corrupting the template |
2.2.0 (17 Oct 2009) | Foswikitask:Item1302: Removed the documentation of the -news mode which was actually never really implemented. Instead added two new -nonews and -nochanges modes which enables running mailnotify in newsletter mode with another schedule than the changes mode. If you upgrade and used the -news option with mailnotify things will work like you are used to as the -news option made no difference (old bug). |
2.1.0 (15 Oct 2009) | Foswikitask:Item2260: Make the feature that allows defining the email template based in either skin or web path. And improve the documentation so people can learn how to tailor the emails that the WebNotify feature sends. Foswikitask:Item1603: use quotes to protect topic names with odd characters in them |
2.0.2 (20 Sep 2009) | Small documentation update for Foswiki 1.0.7 release (RELEASE and adding parent) |
2.0.1 (23 Apr 2009) | Foswikitask:Item1501: Minor bug in logfile output fixed |
2.0.0 (03 Dec 2008) | Re-released for the Foswiki project |
8 Sep 2004 | 1.000 Initial (tm)wiki version |
Author | Crawford Currie |
Version | 2.85 |
Release | 8 Jan 2018 |
Repository | https://github.com/foswiki/distro |
Copyright | Foswiki Contributors, All Rights Reserved |
License | GPL |
Home | http://foswiki.org/Extensions/MailerContrib |
Support | http://foswiki.org/Support/MailerContrib |