wiki:FlexibleReporterNotificationPlugin

Version 1 (modified by CStrac, 6 years ago) (diff)

New hack FlexibleReporterNotificationPlugin, created by CStrac

Control when notifications are sent to the reporter of a ticket

Description

This plugin controls the notification to the reporter. It allows reporter to be notified only for certain configurable states. By default Trac provides only two options either always notify reporter or never notify reporter. These two extremes are not always useful.

I created this Hack to suit our requirement. In our case we didn't want to send out notification emails to reporters for every change,we just wanted them to be notified when they create a new ticket,when the ticket is closed and when the ticket is reopened.

It is a simple extension of Trac's notification module.

I am publishing this because I feel that if we needed this someone else also might need it.

More update on our trac environment can be found at http://blogs.circlesource.com/

Bugs/Feature Requests

Existing bugs and feature requests for FlexibleReporterNotificationPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out FlexibleReporterNotificationPlugin from here using Subversion, or browse the source with Trac.

Example

Install the plugin in the plugins directory of your Trac implementation.

Edit the trac.ini file and put the following line under [notification]

always_notify_reporter = true

reporter_states = new,closed,reopened

The line above specifies the states in which reporter should be notified. In the above example the reporter will be notified only when the ticket is in one of the [new,closed or reopened] states.

Note:-

1)always_notify_reporter should be set to true else no notification will be sent to reporter.

2)Do not leave reporter_states blank.

Recent Changes

[14309] by rjollos on 2014-12-08 20:36:30
0.1: Removed duplicate author in setup.py and fixed indentation.
[13703] by rjollos on 2014-02-20 08:57:23
Added 3-Clause BSD license.
[13701] by rjollos on 2014-02-20 08:36:41
Complete rework of plugin, using ideas from #11210 in the patch by chris-at. Fixes #7554, Refs #8821, #11210.

Note that only one instance of the reporter in to_recipients is removed. So for instance, if the reporter is also the owner and always_notify_owner is True, then the reporter will still receive a notification.

This has been lightly tested, so please report back if you find any issues.

Author/Contributors

Author: CStrac
Contributors: