Changes between Version 27 and Version 28 of WorkflowNotificationPlugin


Ignore:
Timestamp:
Mar 26, 2022, 8:36:59 AM (3 months ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • WorkflowNotificationPlugin

    v27 v28  
    77This plugin enables flexible configuration of email notifications tied to ticket workflow changes.
    88
    9 Administrators can configure any number of distinct email notifications to be sent out when a workflow operation occurs on a ticket. Each email notification is specifically attached to one or more workflow operations, so (for example) separate emails can be sent out when a ticket is accepted, reassigned, resolved, reopened, or marked "in QA".
     9Administrators can configure any number of email notifications to be sent out when a workflow operation occurs on a ticket. Each email notification is specifically attached to one or more workflow operations, so for example separate emails can be sent out when a ticket is accepted, reassigned, resolved, reopened, or marked "in QA".
    1010
    1111Each email notification's subject, body, and recipients are fully configurable by administrators, as Genshi templates which have access to the ticket's data, the comment (if any) that was left on the ticket, and the author of the change. Therefore notifications can be very flexible: some notifications can be sent to the ticket's reporter, others to its owner or CC list, others to the current updater, and others to hard-coded lists of users.
     
    1313The notification emails sent by this plugin respect Trac's `ALWAYS_CC` and `ALWAYS_BCC` settings.
    1414
    15 The notification emails sent by this plugin are independent of Trac's `ALWAYS_NOTIFY_UPDATER`, `ALWAYS_NOTIFY_OWNER` and `ALWAYS_NOTIFY_REPORTER`
    16 settings. Trac's built-in email notifications will be sent according to those settings, independent of this plugin's emails.
     15The notification emails sent by this plugin are independent of Trac's `ALWAYS_NOTIFY_UPDATER`, `ALWAYS_NOTIFY_OWNER` and `ALWAYS_NOTIFY_REPORTER` settings. Trac's built-in email notifications will be sent according to those settings, independent of this plugin's emails.
    1716
    1817== Bugs/Feature Requests
     
    5554Now you just need to configure some notifications, see below for details and examples.
    5655
    57 == Example
    58 
    59 === Configuration
    60 
    61 Configure one or more notification emails attached to workflow events using a `ticket-workflow-notifications` section in `trac.ini`.  See the [trac:wiki:TracDev/DataModels#Ticket Trac documentation] for information on the available attributes of the `Ticket` object.
     56== Configuration
     57
     58=== General configuration
     59
     60Configure one or more notification emails attached to workflow events using a `ticket-workflow-notifications` section in `trac.ini`. See the [trac:wiki:TracDev/DataModels#Ticket Trac documentation] for information on the available attributes of the `Ticket` object.
    6261
    6362Within this section, each entry is a notification email that may be sent out for a ticket. Here is an example:
     
    117116=== Notifications for new tickets
    118117
    119 Most notifications are configured to refer to one or more workflow actions, like accept, leave, reassign, resolve, etc.
     118Most notifications are configured to refer to one or more workflow actions, like `accept`, `leave`, `reassign`, `resolve`, etc.
    120119
    121120You can also configure notifications to be triggered when a ticket is newly created. To do this, use the special workflow action `@created` like so:
     
    182181
    183182Meanwhile, if there are any newlines whatsoever in your `.subject` configuration, the plugin will replace them with spaces. This ensures that your email will have a valid subject (email subjects cannot contain newlines).
    184 
    185183
    186184=== Emailing all commenters on a ticket
     
    201199}}}
    202200
    203 Or you can email everyone who has ever participated on the ticket at all:
     201Or you can email everyone who has ever participated on the ticket:
    204202{{{#!ini
    205203[ticket-workflow-notifications]
     
    221219
    222220Check the project's Github page for recent changes: https://github.com/trac-hacks/trac-WorkflowNotificationPlugin
    223                                                    
    224221
    225222== Author/Contributors