Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Trac Plugin to allow email notification of changes on wiki pages

Project Description

Trac WikiNotification is a plugin that allows users(even anonymous, as long as email is set) to select the wiki pages that they wish to be notified(by email) when a change occurs on it.

Note: The user updating the wiki page won’t be notified about his own changes.

Enabling the Plugin

It’s as simple as:

[components]
wikinotification.* = enabled

smtp_enabled has to be enabled in notification configuration section.

Available Configuration Options

These are the options available to include on your trac.ini under wiki-notification. You can configure them through the web admin interface, too.

Config Setting Default Value Explanation
redirect_time 5 (in seconds) The default seconds a redirect should take when watching/un-watching a wiki page. This value is also definable per user, ie, user is able to configure this, of course for himself.
smtp_always_bcc empty Comma separated list of email address(es) to always send notifications to, addresses do not appear publicly (Bcc:).
smtp_always_cc empty Comma separated list of email address(es) to always send notifications to, addresses can be seen by all recipients (Cc:).
from_email trac.wiki@localhost Sender address to use in notification emails.
from_name None Sender name to use in notification emails. Defaults to project name.
use_public_cc False Recipients can see email addresses of other CC’ed recipients. If this option is disabled(the default), recipients are put on BCC.
attach_diff False Send changes diff as an attachment instead of on the email text body.
subject_template $prefix $pagename $action A Genshi text template snippet used to get the notification subject.
banned_addresses empty Comma separated list of email addresses to never send notifications to.

If you want to override these settings then you can include it like the following example:

[wiki-notification]
redirect_time = 5
smtp_always_bcc = someone@somedomain, another.one@somedomain
smtp_always_cc = someone.else@somedomain
from_email = trac.wiki@localhost
from_name = Custom Name
use_public_cc = false
attach_diff = true
subject_template = Foo $prefix $pagename $action
banned_addresses = banned.user1@somedomain, banned.user2@somedomain

Download and Installation

Run the following to install this plugin:

> sudo pip install TracWikiNotification

Aditional Notes(from user input)

  • pip is run from the command line (on Linux) not from within Python.

  • After installing any plugin for Trac you’ll need to restart Apache to see it (not all changes to trac.ini require a restart but adding a plugin does).

  • Make sure to add the new plugin to trac.ini :

    [components]
    wikinotification.* = enabled
    
  • Also should be noted that the trac.ini configuration for the wiki notification should look something like:

    [wiki-notification]
    smtp_always_cc = someone@somedomain
    from_email = trac.wiki@localhost
    
  • Another note: a user will never get a notice of his/her own wiki modification (which is a little tricky when testing the plugin :))

  • Please note that older versions of the plugin may set a subject_template config value, similar to subject_template = $prefix $page.name $action. This will result in ‘UndefinedError: “page” not defined’. Use $pagename instead of $page.name.

Tweaking/Customizing The Notification Email Template

You can, if you wish, tweak the notification email template sent to your users.

Copy the wiki_notification_email_template.txt file to your trac environment templates/ sub-directory and tweak it to your needs.

Make sure you read the Genshi Text Templates documentation to see if you don’t break any of the logic in that template.

Release History

Release History

This version
History Node

0.4.3

History Node

0.4.2

History Node

0.4.1

History Node

0.4

History Node

0.3

History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

History Node

0.1.0rc4

History Node

0.1.0rc3

History Node

0.1.0rc2

History Node

0.1.0rc1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
TracWikiNotification-0.4.3-py2-none-any.whl (22.0 kB) Copy SHA256 Checksum SHA256 py2 Wheel Jun 11, 2017
TracWikiNotification-0.4.3.tar.gz (14.2 kB) Copy SHA256 Checksum SHA256 Source Jun 11, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting