Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
2017-10-15T03:11:40-08:00 (3 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v1 v2  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    22[[TracGuideToc]]
    33
     
    88Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    99
    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
     12When 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
     14=== How to use your username to receive notification mails
     15
     16To 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.
     17
     18Alternatively, 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.
    2019
    2120When 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`''').
    2221
    23 == Configuring SMTP Notification ==
     22=== Ticket attachment notifications
     23
     24Since 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:
     25{{{#!ini
     26[components]
     27trac.ticket.notification.TicketAttachmentNotifier = disabled
     28}}}
     29
     30== Configuring SMTP Notification
    2431
    2532'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    2633
    27 === Configuration Options ===
    28 These are the available options for the `[notification]` section in trac.ini.
     34=== Configuration Options
     35
     36These are the available options for the `[notification]` section in `trac.ini`:
    2937
    3038[[TracIni(notification)]]
    3139
    32 === Example Configuration (SMTP) ===
    33 {{{
     40=== Example Configuration (SMTP)
     41
     42{{{#!ini
    3443[notification]
    3544smtp_enabled = true
     
    4049}}}
    4150
    42 === Example Configuration (`sendmail`) ===
    43 {{{
     51=== Example Configuration (`sendmail`)
     52
     53{{{#!ini
    4454[notification]
    4555smtp_enabled = true
     
    5161}}}
    5262
    53 === Customizing the e-mail subject ===
     63=== Customizing the e-mail subject
     64
    5465The 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:
    5566{{{
    5667$prefix #$ticket.id: $summary
    5768}}}
     69
    5870The following variables are available in the template:
    5971
     
    6173 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    6274 * `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`.  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:
     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 content
     78
     79The 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:
    6880
    6981{{{
     
    101113$project.descr
    102114}}}
    103 == Sample Email ==
     115
     116== Sample Email
     117
    104118{{{
    105119#42: testing
     
    112126---------------------------+------------------------------------------------
    113127Changes:
    114   * component:  changset view => search system
     128  * component:  changeset view => search system
    115129  * priority:  low => highest
    116130  * owner:  jonas => anonymous
     
    127141}}}
    128142
    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].
     143== Customizing e-mail content for MS Outlook
     144
     145MS 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].
    133146
    134147Replace the following second row in the template:
     
    137150}}}
    138151
    139 with this instead (''requires Python 2.6 or later''):
     152with this (requires Python 2.6 or later):
    140153{{{
    141154--------------------------------------------------------------------------
     
    151164}}}
    152165
    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.
     166The 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.
    154167{{{#!div style="margin: 1em 1.75em; border:1px dotted"
    155168{{{#!html
     
    171184Changes:<br />
    172185<br />
    173 &nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     186&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    174187&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    175188&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     
    187200}}}
    188201
    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:
     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:
    190203{{{
    191204   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    192205}}}
    193206
    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 {{{
     207However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     208
     209== Using GMail as the SMTP relay host
     210
     211Use the following configuration snippet:
     212{{{#!ini
    201213[notification]
    202214smtp_enabled = true
     
    209221}}}
    210222
    211 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     223where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    212224
    213225Alternatively, 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.
     226You 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.
    215227 
    216 == Filtering notifications for one's own changes and comments ==
    217 In Gmail, use the filter:
    218 
     228== Filtering notifications for one's own changes and comments
     229
     230To delete these notifications in Gmail, use the following filter:
    219231{{{
    220232from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    221233}}}
    222234
    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).
     235In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    227236
    228237You can also add this plugin:
    229238http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    230239
    231 == Troubleshooting ==
     240== Troubleshooting
    232241
    233242If 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.
    234243
    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 ===
     244Notification 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.
     245
     246=== ''Permission denied'' error
    238247
    239248Typical error message:
     
    245254}}}
    246255
    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 message to the local SMTP server.
     256This 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.
    248257
    249258Many users get confused when their manual attempts to contact the SMTP server succeed:
    250 {{{
     259{{{#!sh
    251260telnet localhost 25
    252261}}}
    253 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    254 {{{
     262
     263This is because a regular user may connect to the SMTP server, but the web server cannot:
     264{{{#!sh
    255265sudo -u www-data telnet localhost 25
    256266}}}
    257267
    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 browsing the Trac [trac:MailingList MailingList] archive.
    259 
    260 Relevant ML threads:
    261  * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
     268In 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
     270Relevant mailing list thread on SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    262271
    263272For SELinux in Fedora 10:
    264 {{{
    265 $ setsebool -P httpd_can_sendmail 1
    266 }}}
    267 === ''Suspected spam'' error ===
     273{{{#!sh
     274setsebool -P httpd_can_sendmail 1
     275}}}
     276
     277=== ''Suspected spam'' error
    268278
    269279Some SMTP servers may reject the notification email sent by Trac.
    270280
    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 
     281The 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.
     282
     283Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    283284
    284285----
    285 See also: TracTickets, TracIni, TracGuide
     286See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]