Changes between Version 6 and Version 7 of TracNotification
- Timestamp:
- Apr 24, 2015, 5:15:04 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracNotification
v6 v7 9 9 10 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. 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. 14 12 15 13 === How to use your username to receive notification mails === 16 14 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.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 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 23 29 == Configuring SMTP Notification == 24 30 … … 26 32 27 33 === Configuration Options === 28 These are the available options for the `[notification]` section in trac.ini .34 These are the available options for the `[notification]` section in trac.ini: 29 35 30 36 [[TracIni(notification)]] … … 61 67 * `prefix`: The prefix defined in `smtp_subject_prefix`. 62 68 * `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`.69 * `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`. 64 70 65 71 === Customizing the e-mail content === 66 72 67 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. 73 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: 68 74 69 75 {{{ … … 101 107 $project.descr 102 108 }}} 109 103 110 == Sample Email == 104 111 {{{ … … 112 119 ---------------------------+------------------------------------------------ 113 120 Changes: 114 * component: chang set view => search system121 * component: changeset view => search system 115 122 * priority: low => highest 116 123 * owner: jonas => anonymous … … 127 134 }}} 128 135 129 130 136 == Customizing e-mail content for MS Outlook == 131 137 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].138 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 139 134 140 Replace the following second row in the template: … … 137 143 }}} 138 144 139 with this instead (''requires Python 2.6 or later''):145 with this (requires Python 2.6 or later): 140 146 {{{ 141 147 -------------------------------------------------------------------------- … … 151 157 }}} 152 158 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.159 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 160 {{{#!div style="margin: 1em 1.75em; border:1px dotted" 155 161 {{{#!html … … 171 177 Changes:<br /> 172 178 <br /> 173 * component: chang set view => search system<br />179 * component: changeset view => search system<br /> 174 180 * priority: low => highest<br /> 175 181 * owner: jonas => anonymous<br /> … … 187 193 }}} 188 194 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:195 **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 196 {{{ 191 197 sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2'] 192 198 }}} 193 199 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 200 However, the solution is still a workaround to an automatically HTML-formatted e-mail. 196 201 197 202 == Using GMail as the SMTP relay host == 198 203 199 Use the following configuration snippet 204 Use the following configuration snippet: 200 205 {{{ 201 206 [notification] … … 209 214 }}} 210 215 211 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]216 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com]. 212 217 213 218 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.219 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. 215 220 216 221 == Filtering notifications for one's own changes and comments == 217 222 In Gmail, use the filter: 218 219 223 {{{ 220 224 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") … … 223 227 to delete these notifications. 224 228 225 In Thunderbird, there is no such solution if you use IMAP 226 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 229 In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body. 227 230 228 231 You can also add this plugin: … … 233 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. 234 237 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.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. 236 239 237 240 === ''Permission denied'' error === … … 245 248 }}} 246 249 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.250 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 251 249 252 Many users get confused when their manual attempts to contact the SMTP server succeed: … … 251 254 telnet localhost 25 252 255 }}} 253 Th e trouble is thata regular user may connect to the SMTP server, but the web server cannot:256 This is because a regular user may connect to the SMTP server, but the web server cannot: 254 257 {{{ 255 258 sudo -u www-data telnet localhost 25 256 259 }}} 257 260 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.261 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 262 260 263 Relevant ML threads: … … 265 268 $ setsebool -P httpd_can_sendmail 1 266 269 }}} 270 267 271 === ''Suspected spam'' error === 268 272 269 273 Some SMTP servers may reject the notification email sent by Trac. 270 274 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 275 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. 276 277 Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding. 283 278 284 279 ---- 285 See also: TracTickets, TracIni, TracGuide 280 See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]
