Changes between Version 3 and Version 4 of TracNotification
- Timestamp:
- 05/10/20 17:25:06 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v3 v4 4 4 Trac supports notification of ticket changes via email. 5 5 6 Email notification is useful to keep users up-to-date on tickets of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list.7 8 Disabled by default, notification can be activated and configured in [ TracIni trac.ini].6 Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list. For example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list is set up. 7 8 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini]. 9 9 10 10 == Receiving Notification Mails 11 When reporting a new ticket or adding a comment, enter a valid email address or your Trac username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket, depending on how notification is configured. 11 When reporting a new ticket or adding a comment, enter a valid email address or your Trac username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac may send you an email when changes are made to the ticket, depending on how your notification preferences are configured. 12 13 Permission groups can also be entered in the CC field, 14 to notify all members of the group. 12 15 13 16 === How to use your username to receive notification mails 14 17 15 To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your [/prefs preferences].18 To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page. 16 19 17 20 Alternatively, a default domain name ('''`smtp_default_domain`''') can be set in the TracIni file, see [#ConfigurationOptions Configuration Options] below. In this case, the default domain will be appended to the username, which can be useful for an "Intranet" kind of installation. … … 29 32 == Configuring SMTP Notification 30 33 31 '''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.34 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini]. 32 35 33 36 === Configuration Options … … 58 61 59 62 === Subscriber Configuration 60 The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.63 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini: 61 64 62 65 [[TracIni(section=notification-subscriber)]] 63 66 64 Each user can override these defaults in their''Notifications'' preferences.67 Each user can override these defaults in his ''Notifications'' preferences. 65 68 66 69 For example to unsubscribe from notifications for one's own changes and comments, the rule "Never notify: I update a ticket" should be added above other subscription rules. 67 70 68 The subscription rule name on the left side of the `=` can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the `=` must be one of the subscribers listed in the above table.69 70 The following attributes of default subscriptions can be configured:71 * `.distributor` (Default: `email`)72 * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.73 * `.priority` (Default: `100`)74 * Smaller values override larger values.75 * If you use `0`, then users will not be able to override this rule.76 * `.adverb` (Default: `always`)77 * `never` can be used to silence other subscription rules with higher values.78 * `.format` (Default: `text/plain`)79 * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.80 81 === Example Configuration (default subscriptions)82 {{{#!ini83 [notification-subscriber]84 always_notify_owner = TicketOwnerSubscriber85 always_notify_owner.distributor = email86 always_notify_owner.priority = 10087 always_notify_owner.adverb = always88 always_notify_owner.format = text/plain89 90 always_notify_previous_updater = TicketPreviousUpdatersSubscriber91 92 never_notify_updater = TicketUpdaterSubscriber93 never_notify_updater.adverb = never94 never_notify_updater.priority = 095 96 notify_cc_html = CarbonCopySubscriber97 notify_cc_html.format = text/html98 }}}99 100 71 === Customizing the e-mail subject 101 The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshitext template] snippet. The default value is:72 The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html text template] snippet. The default value is: 102 73 {{{#!genshi 103 74 ${prefix} #${ticket.id}: ${summary} … … 105 76 The following variables are available in the template: 106 77 107 * `env`: The project environment object (see [trac:source:/trunk/trac/env.py env.py]). 78 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]). 79 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]). 108 80 * `prefix`: The prefix defined in `smtp_subject_prefix`. 109 81 * `summary`: The ticket summary, with the old value if the summary was edited. 110 * `ticket`: The ticket model object (see [trac:source:/ trunk/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.82 * `ticket`: The ticket model object (see [trac:source:/branches/1.4-stable/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `$ticket.milestone`. 111 83 112 84 === Customizing the e-mail content 113 85 114 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default is:86 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default looks like this: 115 87 116 88 {{{#!genshi 117 ${ticket_body_hdr} 118 ${ticket_props} 119 # if ticket.new: 120 ${ticket.description} 121 # else: 122 # if changes_body: 89 $ticket_body_hdr 90 $ticket_props 91 {% choose ticket.new %}\ 92 {% when True %}\ 93 $ticket.description 94 {% end %}\ 95 {% otherwise %}\ 96 {% if changes_body %}\ 123 97 ${_('Changes (by %(author)s):', author=change.author)} 124 98 125 $ {changes_body}126 # endif 127 # if changes_descr: 128 # if not changes_body and not change.comment and change.author: 99 $changes_body 100 {% end %}\ 101 {% if changes_descr %}\ 102 {% if not changes_body and not change.comment and change.author %}\ 129 103 ${_('Description changed by %(author)s:', author=change.author)} 130 # endif 131 $ {changes_descr}104 {% end %}\ 105 $changes_descr 132 106 -- 133 # endif 134 # if change.comment: 135 136 ${_('Comment:') if changes_body else 137 _('Comment (by %(author)s):', author=change.author)} 138 139 ${change.comment} 140 # endif 141 # endif 142 -- 107 {% end %}\ 108 {% if change.comment %}\ 109 110 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)} 111 112 $change.comment 113 {% end %}\ 114 {% end %}\ 115 {% end %}\ 116 117 -- 143 118 ${_('Ticket URL: <%(link)s>', link=ticket.link)} 144 ${project.name} <${project.url or abs_href()}> 145 ${project.descr} 146 }}} 147 148 See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes. 119 $project.name <${project.url or abs_href()}> 120 $project.descr 121 }}} 149 122 150 123 == Sample Email … … 174 147 }}} 175 148 149 == Customizing e-mail content for MS Outlook 150 151 MS Outlook normally presents plain text e-mails with a variable-width font, and as a result the ticket properties table will most certainly look like a mess in MS Outlook. This can be fixed with some customization of the [#Customizingthee-mailcontent e-mail template]. 152 153 Replace the following second row in the template: 154 {{{ 155 $ticket_props 156 }}} 157 158 with this (requires Python 2.6 or later): 159 {{{ 160 -------------------------------------------------------------------------- 161 {% with 162 pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in 163 [c.strip() for c in 164 ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]]; 165 sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone', 166 'Component', 'Severity', 'Resolution', 'Keywords'] %}\ 167 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)} 168 {% end %}\ 169 -------------------------------------------------------------------------- 170 }}} 171 172 The table of ticket properties is replaced with a list of a selection of the properties. A tab character separates the name and value in such a way that most people should find this more pleasing than the default table when using MS Outlook. 173 {{{#!div style="margin: 1em 1.75em; border:1px dotted" 174 {{{#!html 175 #42: testing<br /> 176 --------------------------------------------------------------------------<br /> 177 <table cellpadding=0> 178 <tr><td>Reporter:</td><td>jonas@example.com</td></tr> 179 <tr><td>Owner:</td><td>anonymous</td></tr> 180 <tr><td>Type:</td><td>defect</td></tr> 181 <tr><td>Status:</td><td>assigned</td></tr> 182 <tr><td>Priority:</td><td>lowest</td></tr> 183 <tr><td>Milestone:</td><td>0.9</td></tr> 184 <tr><td>Component:</td><td>report system</td></tr> 185 <tr><td>Severity:</td><td>major</td></tr> 186 <tr><td>Resolution:</td><td> </td></tr> 187 <tr><td>Keywords:</td><td> </td></tr> 188 </table> 189 --------------------------------------------------------------------------<br /> 190 Changes:<br /> 191 <br /> 192 * component: changeset view => search system<br /> 193 * priority: low => highest<br /> 194 * owner: jonas => anonymous<br /> 195 * cc: daniel@example.com =><br /> 196 daniel@example.com, jonas@example.com<br /> 197 * status: new => assigned<br /> 198 <br /> 199 Comment:<br /> 200 I'm interested too!<br /> 201 <br /> 202 --<br /> 203 Ticket URL: <http://example.com/trac/ticket/42><br /> 204 My Project <http://myproj.example.com/><br /> 205 }}} 206 }}} 207 208 **Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which are to be part of the mail, then they have to be added to `sel`. Example: 209 {{{ 210 sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2'] 211 }}} 212 213 However, the solution is still a workaround to an automatically HTML-formatted e-mail. 214 176 215 == Using GMail as the SMTP relay host 177 216 … … 195 234 == Troubleshooting 196 235 197 If notifications are not working, inspect the [TracLogging log] for error messages.198 199 Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback.236 If you cannot get the notification working, first make sure the log is activated and have a look at the log to find if an error message has been logged. See TracLogging for help about the log feature. 237 238 Notification errors are not reported through the web interface, so the user who submits a change or a new ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace. 200 239 201 240 === ''Permission denied'' error