Changes between Version 6 and Version 7 of TracNotification


Ignore:
Timestamp:
Mar 21, 2016, 6:54:06 PM (20 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v6 v7  
    22[[TracGuideToc]]
    33
    4 Trac supports notification about ticket changes via email.
     4Trac supports notification of ticket changes via email.
    55
    66Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list. For example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list is set up.
     
    99
    1010== Receiving Notification Mails ==
    11 When reporting a new ticket or adding a comment, enter a valid email address 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).
     11When 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).
    1212
    1313This is useful to keep up-to-date on an issue or enhancement request that interests you.
    1414
     15=== How to use your username to receive notification mails ===
     16
     17To 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
     19Alternatively, 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
     21When 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
    1523== Configuring SMTP Notification ==
    1624
     25'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     26
    1727=== Configuration Options ===
    18 These are the available options for the ''[notification]'' section in trac.ini.
    19  * '''smtp_enabled''': Enable email notification.
    20  * '''smtp_server''': SMTP server used for notification messages.
    21  * '''smtp_port''': (''since 0.9'') Port used to contact the SMTP server.
    22  * '''smtp_user''': (''since 0.9'') User name for authentication SMTP account.
    23  * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account.
    24  * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails.
    25  * '''smtp_from_name''': Sender name to use for ''Sender''-headers in notification emails.
    26  * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.
    27  * '''smtp_default_domain''': (''since 0.10'') Append the specified domain to addresses that do not contain one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found from the user settings.
    28  * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    29  * '''smtp_always_bcc''': (''since 0.10'') List of email addresses to always send notifications to, but keeps addresses not visible from other recipients of the notification email
    30  * '''smtp_subject_prefix''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    31  * '''always_notify_reporter''':  Always send notifications to any address in the reporter field (default: false).
    32  * '''always_notify_owner''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    33  * '''always_notify_updater''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    34  * '''use_public_cc''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    35  * '''use_short_addr''': (''since 0.10'') Enable delivery of notifications to addresses that do not contain a domain (i.e. do not end with ''@<domain.com>'').This option is useful for intranets, where the SMTP server can handle local addresses and map the username/login to a local mailbox. See also `smtp_default_domain`. Do not use this option with a public SMTP server.
    36  * '''use_tls''': (''since 0.10'') Toggle to send notifications via a SMTP server using [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS], such as GMail.
    37  * '''mime_encoding''': (''since 0.10'') E-mail notifications are always sent in 7-bit mode. This option allows to select the MIME encoding scheme. Supported values:
    38    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    39    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    40    * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
    41 
    42 Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    43 
    44 === Example Configuration ===
    45 
     28These are the available options for the `[notification]` section in trac.ini.
     29
     30[[TracIni(notification)]]
     31
     32=== Example Configuration (SMTP) ===
    4633{{{
    4734[notification]
     
    5340}}}
    5441
     42=== Example Configuration (`sendmail`) ===
     43{{{
     44[notification]
     45smtp_enabled = true
     46email_sender = SendmailEmailSender
     47sendmail_path = /usr/sbin/sendmail
     48smtp_from = notifier@example.com
     49smtp_replyto = myproj@projects.example.com
     50smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     51}}}
     52
     53=== Customizing the e-mail subject ===
     54The 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{{{
     56$prefix #$ticket.id: $summary
     57}}}
     58The following variables are available in the template:
     59
     60 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     61 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     62 * `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
     67The 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
     69{{{
     70$ticket_body_hdr
     71$ticket_props
     72{% choose ticket.new %}\
     73{%   when True %}\
     74$ticket.description
     75{%   end %}\
     76{%   otherwise %}\
     77{%     if changes_body %}\
     78${_('Changes (by %(author)s):', author=change.author)}
     79
     80$changes_body
     81{%     end %}\
     82{%     if changes_descr %}\
     83{%       if not changes_body and not change.comment and change.author %}\
     84${_('Description changed by %(author)s:', author=change.author)}
     85{%       end %}\
     86$changes_descr
     87--
     88{%     end %}\
     89{%     if change.comment %}\
     90
     91${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     92
     93$change.comment
     94{%     end %}\
     95{%   end %}\
     96{% end %}\
     97
     98--
     99${_('Ticket URL: <%(link)s>', link=ticket.link)}
     100$project.name <${project.url or abs_href()}>
     101$project.descr
     102}}}
    55103== Sample Email ==
    56104{{{
     
    79127}}}
    80128
     129
     130== Customizing e-mail content for MS Outlook ==
     131
     132Out-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].
     133
     134Replace the following second row in the template:
     135{{{
     136$ticket_props
     137}}}
     138
     139with this instead (''requires Python 2.6 or later''):
     140{{{
     141--------------------------------------------------------------------------
     142{% with
     143   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     144         [c.strip() for c in
     145          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     146   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     147          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     148${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     149{% end %}\
     150--------------------------------------------------------------------------
     151}}}
     152
     153The 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{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     155{{{#!html
     156#42: testing<br />
     157--------------------------------------------------------------------------<br />
     158<table cellpadding=0>
     159<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     160<tr><td>Owner:</td><td>anonymous</td></tr>
     161<tr><td>Type:</td><td>defect</td></tr>
     162<tr><td>Status:</td><td>assigned</td></tr>
     163<tr><td>Priority:</td><td>lowest</td></tr>
     164<tr><td>Milestone:</td><td>0.9</td></tr>
     165<tr><td>Component:</td><td>report system</td></tr>
     166<tr><td>Severity:</td><td>major</td></tr>
     167<tr><td>Resolution:</td><td> </td></tr>
     168<tr><td>Keywords:</td><td> </td></tr>
     169</table>
     170--------------------------------------------------------------------------<br />
     171Changes:<br />
     172<br />
     173&nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     174&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     175&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     176&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     178&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     179<br />
     180Comment:<br />
     181I'm interested too!<br />
     182<br />
     183--<br />
     184Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     185My Project &lt;http://myproj.example.com/&gt;<br />
     186}}}
     187}}}
     188
     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:
     190{{{
     191   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     192}}}
     193
     194However, 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
    81197== Using GMail as the SMTP relay host ==
    82198
     
    96212
    97213Alternatively, you can use `smtp_port = 25`.[[br]]
    98 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 [comment:ticket:7107:2 #7107] for details.
     214You 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.
    99215 
    100 == Filtering notifications for one's own changes ==
     216== Filtering notifications for one's own changes and comments ==
    101217In Gmail, use the filter:
    102218
    103219{{{
    104 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
     220from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    105221}}}
    106222
    107223to delete these notifications.
     224
     225In Thunderbird, there is no such solution if you use IMAP
     226(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     227
     228You can also add this plugin:
     229http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    108230
    109231== Troubleshooting ==
     
    134256}}}
    135257
    136 In such a case, you need to configure your server so that the web server is authorize 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 MailingList archive.
     258In 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.
    137259
    138260Relevant ML threads:
    139261 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    140  
     262
     263For SELinux in Fedora 10:
     264{{{
     265$ setsebool -P httpd_can_sendmail 1
     266}}}
    141267=== ''Suspected spam'' error ===
    142268
     
    146272
    147273Quoted 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
     277On IIS 6.0 you could get a
     278{{{
     279Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
     280}}}
     281in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
     282
    148283
    149284----