|Version 11 (modified by robguttman, 3 years ago) (diff)|
Toggle sending Announcer emails
This plugin provides a link (in the contextual nav) to toggle on and off sending emails for your ticket changes. The purpose is to reduce superfluous emails for changes the author deems low-value.
- Install the plugin (after downloading and unzipping):
cd quietplugin/0.12 sudo python setup.py install
See TracPlugins for more installation details and options. You'll likely need to restart Trac's web server after installation.
- Enable the plugin and disable announcer.distributors.mail.EmailDistributor in trac.ini:
[components] announcer.* = enabled announcer.distributors.mail.EmailDistributor = disabled quiet.* = enabled
You can alternatively use the Trac Web Admin GUI. The above is because the quietplugin provides its own email distributor which effectively wraps the announcer's EmailDistributor with an extra check to see if the user entered quiet mode or not.
- (Optional) Customize the quiet mode labels in trac.ini:
[quiet] enter_label = Enter Quiet Mode leave_label = Leave Quiet Mode
There are a few additional optional configurations - see below.
- Add the QUIET_MODE permission to users or groups as appropriate on the Admin > Permissions page.
If you have any issues, create a new ticket.
Download the zipped source from here.
- During planning, I can now avoid barraging people with emails when I move large batches of tickets from one milestone to another using BatchModify.
- I want to make a minor fix to a ticket's description that doesn't call for yet another email to be sent - enter quiet mode!
- I'm triaging many tickets in a Queue report with new positions using GridModify and I don't want an email sent for each change.
- I'm managing dependencies using the Analyze plugin and don't want to inundate the team with emails of its fixes.
Trigger quiet mode
To help you remember to enter quiet mode for the above use cases (or similar ones), you can create trigger rules on DOM elements that will prompt you to enter or leave quiet mode (if you're not already in that state):
[quiet] 1.selector = #analyzebutton 1.action = enter 2.selector = #batchmod_submit 2.action = enter 2.submit = true 3.selector = #propertyform[action*=ticket] .buttons input[name=submit] 3.action = leave 3.only_if = #comment:first=.+ 3.submit = true
The above example defines three trigger rules explained as follows:
- When the "Analyze.." button is clicked, prompt to enter quiet mode.
- When the "Batch Modify" button is clicked, prompt to enter quiet mode (and prevent the submission - but then they can submit again).
- When a ticket's "Submit changes" button is clicked and there's some text in the comment field, then prompt to enter quiet mode (and prevent the submission - but then they can submit again).
The only_if option can either be just a CSS selector or also include an expected regex value (e.g., the =.+ above). If just a selector, then the selector must exist. If also an expected rege value, then the selected item's jQuery val() must match the expected value.