Changes between Version 1 and Version 2 of TracNotification
- Timestamp:
- Dec 3, 2016, 9:48:27 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v1 v2 1 = Email Notification of Ticket Changes =1 = Email Notification of Ticket Changes 2 2 [[TracGuideToc]] 3 3 … … 8 8 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini]. 9 9 10 == Receiving Notification Mails ==10 == Receiving Notification Mails 11 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. 12 12 13 === How to use your username to receive notification mails ===13 === How to use your username to receive notification mails 14 14 15 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 the ''Preferences'' page. … … 27 27 }}} 28 28 29 == Configuring SMTP Notification ==29 == Configuring SMTP Notification 30 30 31 31 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini]. 32 32 33 === Configuration Options ===33 === Configuration Options 34 34 These are the available options for the `[notification]` section in trac.ini: 35 35 36 36 [[TracIni(notification)]] 37 37 38 === Example Configuration (SMTP) ===39 {{{ 38 === Example Configuration (SMTP) 39 {{{#!ini 40 40 [notification] 41 41 smtp_enabled = true … … 46 46 }}} 47 47 48 === Example Configuration (`sendmail`) ===49 {{{ 48 === Example Configuration (`sendmail`) 49 {{{#!ini 50 50 [notification] 51 51 smtp_enabled = true … … 57 57 }}} 58 58 59 === Customizing the e-mail subject === 59 === Subscriber Configuration 60 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini: 61 62 [[TracIni(notification-subscriber)]] 63 64 Each user can override these defaults in his ''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 === Customizing the e-mail subject 60 69 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: 61 {{{ 70 {{{#!genshi 62 71 $prefix #$ticket.id: $summary 63 72 }}} … … 69 78 * `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`. 70 79 71 === Customizing the e-mail content ===80 === Customizing the e-mail content 72 81 73 82 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: 74 83 75 {{{ 84 {{{#!genshi 76 85 $ticket_body_hdr 77 86 $ticket_props … … 108 117 }}} 109 118 110 == Sample Email ==119 == Sample Email 111 120 {{{ 112 121 #42: testing … … 134 143 }}} 135 144 136 == Customizing e-mail content for MS Outlook ==145 == Customizing e-mail content for MS Outlook 137 146 138 147 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]. … … 200 209 However, the solution is still a workaround to an automatically HTML-formatted e-mail. 201 210 202 == Using GMail as the SMTP relay host ==211 == Using GMail as the SMTP relay host 203 212 204 213 Use the following configuration snippet: 205 {{{ 214 {{{#!ini 206 215 [notification] 207 216 smtp_enabled = true … … 218 227 Alternatively, you can use `smtp_port = 25`.[[br]] 219 228 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. 220 221 == Filtering notifications for one's own changes and comments == 222 In Gmail, use the filter: 223 {{{ 224 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 225 }}} 226 227 to delete these notifications. 228 229 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body. 230 231 You can also add this plugin: 232 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed. 233 234 == Troubleshooting == 229 230 == Troubleshooting 235 231 236 232 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. … … 238 234 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. 239 235 240 === ''Permission denied'' error ===236 === ''Permission denied'' error 241 237 242 238 Typical error message: 243 {{{ 239 {{{#!sh 244 240 ... 245 241 File ".../smtplib.py", line 303, in connect … … 251 247 252 248 Many users get confused when their manual attempts to contact the SMTP server succeed: 253 {{{ 249 {{{#!sh 254 250 telnet localhost 25 255 251 }}} 256 252 This is because a regular user may connect to the SMTP server, but the web server cannot: 257 {{{ 253 {{{#!sh 258 254 sudo -u www-data telnet localhost 25 259 255 }}} … … 265 261 266 262 For SELinux in Fedora 10: 267 {{{ 263 {{{#!sh 268 264 $ setsebool -P httpd_can_sendmail 1 269 265 }}} 270 266 271 === ''Suspected spam'' error ===267 === ''Suspected spam'' error 272 268 273 269 Some SMTP servers may reject the notification email sent by Trac.
