Changes between Version 3 and Version 4 of TracNotification
- Timestamp:
- Aug 13, 2018, 11:36:48 AM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v3 v4 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 == 11 When reporting a new ticket or adding a comment, enter a valid email address or your 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 This is useful to keep up-to-date on an issue or enhancement request that interests you. 14 15 === How to use your username to receive notification mails === 16 17 To receive notification mails, you can either enter a full email address or your username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page. 18 19 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. 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. 12 13 === How to use your username to receive notification mails 14 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. 16 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. 20 18 21 19 When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form ('''`username@EXAMPLE.LOCAL`'''). To avoid this being interpreted as an email address, add the Kerberos domain to ('''`ignore_domains`'''). 22 20 23 == Configuring SMTP Notification == 21 === Ticket attachment notifications 22 23 Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled: 24 {{{#!ini 25 [components] 26 trac.ticket.notification.TicketAttachmentNotifier = disabled 27 }}} 28 29 == Configuring SMTP Notification 24 30 25 31 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini]. 26 32 27 === Configuration Options ===28 These are the available options for the `[notification]` section in trac.ini .33 === Configuration Options 34 These are the available options for the `[notification]` section in trac.ini: 29 35 30 36 [[TracIni(notification)]] 31 37 32 === Example Configuration (SMTP) ===33 {{{ 38 === Example Configuration (SMTP) 39 {{{#!ini 34 40 [notification] 35 41 smtp_enabled = true … … 40 46 }}} 41 47 42 === Example Configuration (`sendmail`) ===43 {{{ 48 === Example Configuration (`sendmail`) 49 {{{#!ini 44 50 [notification] 45 51 smtp_enabled = true … … 51 57 }}} 52 58 53 === 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 54 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: 55 {{{ 70 {{{#!genshi 56 71 $prefix #$ticket.id: $summary 57 72 }}} … … 61 76 * `prefix`: The prefix defined in `smtp_subject_prefix`. 62 77 * `summary`: The ticket summary, with the old value if the summary was edited. 63 * `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, e .g.`$ticket.milestone`.64 65 === Customizing the e-mail content ===66 67 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. 68 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`. 79 80 === Customizing the e-mail content 81 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: 83 84 {{{#!genshi 70 85 $ticket_body_hdr 71 86 $ticket_props … … 101 116 $project.descr 102 117 }}} 103 == Sample Email == 118 119 == Sample Email 104 120 {{{ 105 121 #42: testing … … 112 128 ---------------------------+------------------------------------------------ 113 129 Changes: 114 * component: chang set view => search system130 * component: changeset view => search system 115 131 * priority: low => highest 116 132 * owner: jonas => anonymous … … 127 143 }}} 128 144 129 130 == Customizing e-mail content for MS Outlook == 131 132 Out-of-the-box, MS Outlook normally presents plain text e-mails with a variable-width font; 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]. 145 == Customizing e-mail content for MS Outlook 146 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]. 133 148 134 149 Replace the following second row in the template: … … 137 152 }}} 138 153 139 with this instead (''requires Python 2.6 or later''):154 with this (requires Python 2.6 or later): 140 155 {{{ 141 156 -------------------------------------------------------------------------- … … 151 166 }}} 152 167 153 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.168 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. 154 169 {{{#!div style="margin: 1em 1.75em; border:1px dotted" 155 170 {{{#!html … … 171 186 Changes:<br /> 172 187 <br /> 173 * component: chang set view => search system<br />188 * component: changeset view => search system<br /> 174 189 * priority: low => highest<br /> 175 190 * owner: jonas => anonymous<br /> … … 187 202 }}} 188 203 189 **Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which shall be part of the mail they have to be added to `sel`, example:204 **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: 190 205 {{{ 191 206 sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2'] 192 207 }}} 193 208 194 However, it's not as perfect as an automatically HTML-formatted e-mail would be, but presented ticket properties are at least readable by default in MS Outlook... 195 196 197 == Using GMail as the SMTP relay host == 198 199 Use the following configuration snippet 200 {{{ 209 However, the solution is still a workaround to an automatically HTML-formatted e-mail. 210 211 == Using GMail as the SMTP relay host 212 213 Use the following configuration snippet: 214 {{{#!ini 201 215 [notification] 202 216 smtp_enabled = true … … 209 223 }}} 210 224 211 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]225 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com]. 212 226 213 227 Alternatively, you can use `smtp_port = 25`.[[br]] 214 You should not use `smtp_port = 465`. It will not work and your ticket submission may deadlock. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details. 215 216 == Filtering notifications for one's own changes and comments == 217 In Gmail, use the filter: 218 219 {{{ 220 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 221 }}} 222 223 to delete these notifications. 224 225 In Thunderbird, there is no such solution if you use IMAP 226 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 227 228 You can also add this plugin: 229 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed. 230 231 == Troubleshooting == 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. 229 230 == Troubleshooting 232 231 233 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. 234 233 235 Notification errors are not reported through the web interface, so the user who submit 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.236 237 === ''Permission denied'' error ===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. 235 236 === ''Permission denied'' error 238 237 239 238 Typical error message: 240 {{{ 239 {{{#!sh 241 240 ... 242 241 File ".../smtplib.py", line 303, in connect … … 245 244 }}} 246 245 247 This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email messageto the local SMTP server.246 This error usually comes from a security settings on the server: many Linux distributions do not allow the web server (Apache, ...) to post email messages to the local SMTP server. 248 247 249 248 Many users get confused when their manual attempts to contact the SMTP server succeed: 250 {{{ 249 {{{#!sh 251 250 telnet localhost 25 252 251 }}} 253 Th e trouble is thata regular user may connect to the SMTP server, but the web server cannot:254 {{{ 252 This is because a regular user may connect to the SMTP server, but the web server cannot: 253 {{{#!sh 255 254 sudo -u www-data telnet localhost 25 256 255 }}} 257 256 258 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 browsingthe Trac [trac:MailingList MailingList] archive.257 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. 259 258 260 259 Relevant ML threads: … … 262 261 263 262 For SELinux in Fedora 10: 264 {{{ 263 {{{#!sh 265 264 $ setsebool -P httpd_can_sendmail 1 266 265 }}} 267 === ''Suspected spam'' error === 266 267 === ''Suspected spam'' error 268 268 269 269 Some SMTP servers may reject the notification email sent by Trac. 270 270 271 The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' SPAM detection on sensitive email servers. In such an event, it is recommended to change the default encoding to "quoted-printable" using the `mime_encoding` option. 272 273 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding. 274 275 === ''501, 5.5.4 Invalid Address'' error === 276 277 On IIS 6.0 you could get a 278 {{{ 279 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address') 280 }}} 281 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it. 282 271 The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' spam detection on sensitive email servers. In such an event, change the default encoding to "quoted-printable" using the `mime_encoding` option. 272 273 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding. 283 274 284 275 ---- 285 See also: TracTickets, TracIni, TracGuide 276 See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]