Kwiki::Notify::Mail - send an email when a page is updated
Version 0.04
$ cd /path/to/kwiki $ kwiki -add Kwiki::Notify::Mail $ cat config/notify_mail.yaml >> config.yaml $ edit config.yaml
This module requires MIME::Lite to send email.
This module allows you to notify yourself by email when some one updates a page. You can specify the To:, From: and Subject: headers, but the email message body is not currently configurable.
A sample email looks like:
Content-Disposition: inline Content-Length: 52 Content-Transfer-Encoding: binary Content-Type: text/plain MIME-Version: 1.0 X-Mailer: MIME::Lite 3.01 (F2.72; B3.01; Q3.01) Date: Sun, 29 Aug 2004 22:00:31 UT To: geo_bush@casablanca.gov From: nobody@countykerry.ir Subject: Kwiki page update Kwiki page LotsOfWikiWords edited by AnonymousGnome
Specify the mail address you are sending to. Email will be sent to these addresses for all page updates.
Specify the mail topic or ConfigPage that is used to decide who to send mail to. The ConfigPage is of the format
WikiPage: email@domain.com
WikiPage may be given as a regular expression, and multiple email addresses may be given. For example:
HomePage: me@my.domain.com
.*: bigmailbox@my.domain.com
Doc.*: docs@my.domain.com me@my.domain.com
If you are also using the notify_mail_to directive, any email will also be sent to that address.
Note: Addresses are separated by spaces. If your message transfer agent expects addresses separated by commas, then use a comma. However in this case you can't also use the notify_mail_to directive, because it will be added to the email From: line with a space.
Specify the address this is apparently from.
Specify a subject line for the mail message. You can make use of sprintf()-type formatting codes (%s is the only one that is relevant). If you put one or more %s in the configuration directive it will print out the site title, page name and whom it was edited by. You may also put $1, $2 and/or $3 in the subject line. They will be replaced with the site title, the page name and whom it was edited by respectively.
Examples:
notify_mail_subject: Kwiki was updated
gives you the Subject: line
Subject: Kwiki was updated
If your site title (defined in site_title in config.yaml) was 'ProjectDiscussion', then
notify_mail_subject: My wiki %s was updated
gives you the Subject: line
Subject: My wiki ProjectDiscussion was updated
Next you can add the page name with a second %s. If the updated page happened to be 'NextWeeksAgenda', the configuration directive
notify_mail_subject: My wiki %s page %s was updated
gives you the Subject: line
Subject: My wiki ProjectDiscussion page NextWeeksAgenda was updated
Finally, a third %s gives you the name of the person who edited the page:
notify_mail_subject: My wiki %s page %s was updated by %s Subject: My wiki ProjectDiscussion page NextWeeksAgenda was updated by PointyHairedBoss
The important thing to remember is that when using %s, you can't change the order of argument substitution. To do that, you need something like this:
notify_mail_subject: $3 has updated $2 on $1
gives you the Subject: line
Subject: PointyHairedBoss has updated NextWeeksAgenda on ProjectDiscussion
The default value is
notify_mail_subject: %s wiki page %s updated by %s
which should be fine for most people.
When set, saves the mail message to /tmp/kwiki_notify_mail.txt instead of sending it.
James Peregrino, <jperegrino@post.harvard.edu>
The folks at irc::/irc.freenode.net/kwiki, especially alevin and statico. The style of this module has been adapted from statico's Kwiki::Notify::IRC.
Brian Somers <brian@FreeBSD.org> provided the code and documentation for the notify_mail_topic feature.
The debug file is saved to /tmp and should be user configurable. This module was not tested under Windows and certainly /tmp doesn't exist there.
Please report any bugs or feature requests to bug-kwiki-notify-mail@rt.cpan.org, or through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
Copyright 2004 James Peregrino, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
