Changes between Version 3 and Version 4 of TracNotification
- Timestamp:
- 23 Mar 2021, 19:30:37 (4 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 /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].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]. 9 9 10 10 == Receiving Notification Mails 11 12 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. 13 12 14 13 === How to use your username to receive notification mails 15 14 16 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.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]. 17 16 18 17 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. … … 30 29 == Configuring SMTP Notification 31 30 32 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].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. 33 32 34 33 === Configuration Options 35 36 These are the available options for the `[notification]` section in `trac.ini`: 37 38 [[TracIni(notification)]] 34 These are the available options for the `[notification]` section in trac.ini: 35 36 [[TracIni(section=notification)]] 39 37 40 38 === Example Configuration (SMTP) 41 42 39 {{{#!ini 43 40 [notification] … … 50 47 51 48 === Example Configuration (`sendmail`) 52 53 49 {{{#!ini 54 50 [notification] … … 61 57 }}} 62 58 63 === Customizing the e-mail subject 64 65 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 Genshi text template] snippet. The default value is: 66 {{{ 67 $prefix #$ticket.id: $summary 68 }}} 69 59 === Subscriber Configuration 60 The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section. 61 62 [[TracIni(section=notification-subscriber)]] 63 64 Each user can override these defaults in their ''Notifications'' preferences. 65 66 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 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 {{{#!ini 83 [notification-subscriber] 84 always_notify_owner = TicketOwnerSubscriber 85 always_notify_owner.distributor = email 86 always_notify_owner.priority = 100 87 always_notify_owner.adverb = always 88 always_notify_owner.format = text/plain 89 90 always_notify_previous_updater = TicketPreviousUpdatersSubscriber 91 92 never_notify_updater = TicketUpdaterSubscriber 93 never_notify_updater.adverb = never 94 never_notify_updater.priority = 0 95 96 notify_cc_html = CarbonCopySubscriber 97 notify_cc_html.format = text/html 98 }}} 99 100 === Customizing the email subject 101 The email subject can be customized with the `ticket_subject_template` option, which contains a [https://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is: 102 {{{#!genshi 103 ${prefix} #${ticket.id}: ${summary} 104 }}} 70 105 The following variables are available in the template: 71 106 72 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).107 * `env`: The project environment object (see [trac:source:branches/1.2-stable/trac/env.py env.py]). 73 108 * `prefix`: The prefix defined in `smtp_subject_prefix`. 74 109 * `summary`: The ticket summary, with the old value if the summary was edited. 75 * `ticket`: The ticket model object (see [trac:source: /trunk/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `$ticket.milestone`.76 77 === Customizing the e -mail content78 79 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:80 81 {{{ 110 * `ticket`: The ticket model object (see [trac:source:branches/1.2-stable/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`. 111 112 === Customizing the email content 113 114 The notification email 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: 115 116 {{{#!genshi 82 117 $ticket_body_hdr 83 118 $ticket_props … … 101 136 {% if change.comment %}\ 102 137 103 ${ changes_body and _('Comment:') or_('Comment (by %(author)s):', author=change.author)}138 ${_('Comment:') if changes_body else _('Comment (by %(author)s):', author=change.author)} 104 139 105 140 $change.comment … … 108 143 {% end %}\ 109 144 110 -- 145 ${'-- '} 111 146 ${_('Ticket URL: <%(link)s>', link=ticket.link)} 112 147 $project.name <${project.url or abs_href()}> … … 114 149 }}} 115 150 151 See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes. 152 116 153 == Sample Email 117 118 154 {{{ 119 155 #42: testing … … 141 177 }}} 142 178 143 == Customizing e-mail content for MS Outlook144 145 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].146 147 Replace the following second row in the template:148 {{{149 $ticket_props150 }}}151 152 with this (requires Python 2.6 or later):153 {{{154 --------------------------------------------------------------------------155 {% with156 pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in157 [c.strip() for c in158 ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];159 sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',160 'Component', 'Severity', 'Resolution', 'Keywords'] %}\161 ${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}162 {% end %}\163 --------------------------------------------------------------------------164 }}}165 166 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.167 {{{#!div style="margin: 1em 1.75em; border:1px dotted"168 {{{#!html169 #42: testing<br />170 --------------------------------------------------------------------------<br />171 <table cellpadding=0>172 <tr><td>Reporter:</td><td>jonas@example.com</td></tr>173 <tr><td>Owner:</td><td>anonymous</td></tr>174 <tr><td>Type:</td><td>defect</td></tr>175 <tr><td>Status:</td><td>assigned</td></tr>176 <tr><td>Priority:</td><td>lowest</td></tr>177 <tr><td>Milestone:</td><td>0.9</td></tr>178 <tr><td>Component:</td><td>report system</td></tr>179 <tr><td>Severity:</td><td>major</td></tr>180 <tr><td>Resolution:</td><td> </td></tr>181 <tr><td>Keywords:</td><td> </td></tr>182 </table>183 --------------------------------------------------------------------------<br />184 Changes:<br />185 <br />186 * component: changeset view => search system<br />187 * priority: low => highest<br />188 * owner: jonas => anonymous<br />189 * cc: daniel@example.com =><br />190 daniel@example.com, jonas@example.com<br />191 * status: new => assigned<br />192 <br />193 Comment:<br />194 I'm interested too!<br />195 <br />196 --<br />197 Ticket URL: <http://example.com/trac/ticket/42><br />198 My Project <http://myproj.example.com/><br />199 }}}200 }}}201 202 **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:203 {{{204 sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']205 }}}206 207 However, the solution is still a workaround to an automatically HTML-formatted e-mail.208 209 179 == Using GMail as the SMTP relay host 210 180 … … 221 191 }}} 222 192 223 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http ://gmail.com].193 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com]. 224 194 225 195 Alternatively, you can use `smtp_port = 25`.[[br]] 226 196 You should not use `smtp_port = 465`. Doing so may deadlock your ticket submission. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details. 227 228 == Filtering notifications for one's own changes and comments229 230 To delete these notifications in Gmail, use the following filter:231 {{{232 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")233 }}}234 235 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.236 237 You can also add this plugin:238 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.239 197 240 198 == Troubleshooting 241 199 242 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.243 244 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 If notifications are not working, inspect the [TracLogging log] for error messages. 201 202 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. 245 203 246 204 === ''Permission denied'' error 247 205 248 206 Typical error message: 249 {{{ 207 {{{#!sh 250 208 ... 251 209 File ".../smtplib.py", line 303, in connect … … 260 218 telnet localhost 25 261 219 }}} 262 263 220 This is because a regular user may connect to the SMTP server, but the web server cannot: 264 221 {{{#!sh … … 268 225 In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help in the Trac [trac:MailingList MailingList] archive. 269 226 270 Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 227 Relevant ML threads: 228 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 271 229 272 230 For SELinux in Fedora 10: 273 231 {{{#!sh 274 setsebool -P httpd_can_sendmail 1232 $ setsebool -P httpd_can_sendmail 1 275 233 }}} 276 234
