Changes between Version 2 and Version 3 of TracNotification
- Timestamp:
- Apr 16, 2016, 7:07:21 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v2 v3 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 12 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 13 13 === How to use your username to receive notification mails ===14 === How to use your username to receive notification mails 14 15 15 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. … … 27 28 }}} 28 29 29 == Configuring SMTP Notification ==30 == Configuring SMTP Notification 30 31 31 32 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini]. 32 33 33 === Configuration Options === 34 These are the available options for the `[notification]` section in trac.ini: 34 === Configuration Options 35 36 These are the available options for the `[notification]` section in `trac.ini`: 35 37 36 38 [[TracIni(notification)]] 37 39 38 === Example Configuration (SMTP) === 39 {{{ 40 === Example Configuration (SMTP) 41 42 {{{#!ini 40 43 [notification] 41 44 smtp_enabled = true … … 46 49 }}} 47 50 48 === Example Configuration (`sendmail`) === 49 {{{ 51 === Example Configuration (`sendmail`) 52 53 {{{#!ini 50 54 [notification] 51 55 smtp_enabled = true … … 57 61 }}} 58 62 59 === Customizing the e-mail subject === 63 === Customizing the e-mail subject 64 60 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: 61 66 {{{ 62 67 $prefix #$ticket.id: $summary 63 68 }}} 69 64 70 The following variables are available in the template: 65 71 … … 69 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`. 70 76 71 === Customizing the e-mail content ===77 === Customizing the e-mail content 72 78 73 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: … … 108 114 }}} 109 115 110 == Sample Email == 116 == Sample Email 117 111 118 {{{ 112 119 #42: testing … … 134 141 }}} 135 142 136 == Customizing e-mail content for MS Outlook ==143 == Customizing e-mail content for MS Outlook 137 144 138 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]. … … 200 207 However, the solution is still a workaround to an automatically HTML-formatted e-mail. 201 208 202 == Using GMail as the SMTP relay host ==209 == Using GMail as the SMTP relay host 203 210 204 211 Use the following configuration snippet: 205 {{{ 212 {{{#!ini 206 213 [notification] 207 214 smtp_enabled = true … … 219 226 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 227 221 == Filtering notifications for one's own changes and comments == 222 In Gmail, use the filter: 228 == Filtering notifications for one's own changes and comments 229 230 To delete these notifications in Gmail, use the following filter: 223 231 {{{ 224 232 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 225 233 }}} 226 227 to delete these notifications.228 234 229 235 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body. … … 232 238 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed. 233 239 234 == Troubleshooting ==240 == Troubleshooting 235 241 236 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. … … 238 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. 239 245 240 === ''Permission denied'' error ===246 === ''Permission denied'' error 241 247 242 248 Typical error message: … … 251 257 252 258 Many users get confused when their manual attempts to contact the SMTP server succeed: 253 {{{ 259 {{{#!sh 254 260 telnet localhost 25 255 261 }}} 262 256 263 This is because a regular user may connect to the SMTP server, but the web server cannot: 257 {{{ 264 {{{#!sh 258 265 sudo -u www-data telnet localhost 25 259 266 }}} … … 261 268 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. 262 269 263 Relevant ML threads: 264 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 270 Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 265 271 266 272 For SELinux in Fedora 10: 267 {{{ 268 $setsebool -P httpd_can_sendmail 1269 }}} 270 271 === ''Suspected spam'' error ===273 {{{#!sh 274 setsebool -P httpd_can_sendmail 1 275 }}} 276 277 === ''Suspected spam'' error 272 278 273 279 Some SMTP servers may reject the notification email sent by Trac.
