Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
Mar 18, 2017, 3:45:33 PM (3 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v4 v5  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    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.
     
    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 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 == Configuring SMTP Notification ==
    16 
    17 === 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 
    46 {{{
     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.
     19
     20When 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`''').
     21
     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
     31
     32'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
     33
     34=== Configuration Options
     35
     36These are the available options for the `[notification]` section in `trac.ini`:
     37
     38[[TracIni(notification)]]
     39
     40=== Example Configuration (SMTP)
     41
     42{{{#!ini
    4743[notification]
    4844smtp_enabled = true
     
    5349}}}
    5450
    55 == Sample Email ==
     51=== Example Configuration (`sendmail`)
     52
     53{{{#!ini
     54[notification]
     55smtp_enabled = true
     56email_sender = SendmailEmailSender
     57sendmail_path = /usr/sbin/sendmail
     58smtp_from = notifier@example.com
     59smtp_replyto = myproj@projects.example.com
     60smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     61}}}
     62
     63=== Customizing the e-mail subject
     64
     65The 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:
     66{{{
     67$prefix #$ticket.id: $summary
     68}}}
     69
     70The following variables are available in the template:
     71
     72 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     73 * `prefix`: The prefix defined in `smtp_subject_prefix`.
     74 * `summary`: The ticket summary, with the old value if the summary was edited.
     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:
     80
     81{{{
     82$ticket_body_hdr
     83$ticket_props
     84{% choose ticket.new %}\
     85{%   when True %}\
     86$ticket.description
     87{%   end %}\
     88{%   otherwise %}\
     89{%     if changes_body %}\
     90${_('Changes (by %(author)s):', author=change.author)}
     91
     92$changes_body
     93{%     end %}\
     94{%     if changes_descr %}\
     95{%       if not changes_body and not change.comment and change.author %}\
     96${_('Description changed by %(author)s:', author=change.author)}
     97{%       end %}\
     98$changes_descr
     99--
     100{%     end %}\
     101{%     if change.comment %}\
     102
     103${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     104
     105$change.comment
     106{%     end %}\
     107{%   end %}\
     108{% end %}\
     109
     110--
     111${_('Ticket URL: <%(link)s>', link=ticket.link)}
     112$project.name <${project.url or abs_href()}>
     113$project.descr
     114}}}
     115
     116== Sample Email
     117
    56118{{{
    57119#42: testing
     
    64126---------------------------+------------------------------------------------
    65127Changes:
    66   * component:  changset view => search system
     128  * component:  changeset view => search system
    67129  * priority:  low => highest
    68130  * owner:  jonas => anonymous
     
    79141}}}
    80142
    81 == Using GMail as the SMTP relay host ==
    82 
    83 Use the following configuration snippet
    84 {{{
     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].
     146
     147Replace the following second row in the template:
     148{{{
     149$ticket_props
     150}}}
     151
     152with this (requires Python 2.6 or later):
     153{{{
     154--------------------------------------------------------------------------
     155{% with
     156   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     157         [c.strip() for c in
     158          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     159   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     160          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     161${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     162{% end %}\
     163--------------------------------------------------------------------------
     164}}}
     165
     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.
     167{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     168{{{#!html
     169#42: testing<br />
     170--------------------------------------------------------------------------<br />
     171<table cellpadding=0>
     172<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     173<tr><td>Owner:</td><td>anonymous</td></tr>
     174<tr><td>Type:</td><td>defect</td></tr>
     175<tr><td>Status:</td><td>assigned</td></tr>
     176<tr><td>Priority:</td><td>lowest</td></tr>
     177<tr><td>Milestone:</td><td>0.9</td></tr>
     178<tr><td>Component:</td><td>report system</td></tr>
     179<tr><td>Severity:</td><td>major</td></tr>
     180<tr><td>Resolution:</td><td> </td></tr>
     181<tr><td>Keywords:</td><td> </td></tr>
     182</table>
     183--------------------------------------------------------------------------<br />
     184Changes:<br />
     185<br />
     186&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     187&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     188&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     189&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     191&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     192<br />
     193Comment:<br />
     194I'm interested too!<br />
     195<br />
     196--<br />
     197Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     198My Project &lt;http://myproj.example.com/&gt;<br />
     199}}}
     200}}}
     201
     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:
     203{{{
     204   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     205}}}
     206
     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
    85213[notification]
    86214smtp_enabled = true
     
    93221}}}
    94222
    95 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].
    96224
    97225Alternatively, 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.
     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.
    99227 
    100 == Filtering notifications for one's own changes ==
    101 In Gmail, use the filter:
    102 
    103 {{{
    104 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    105 }}}
    106 
    107 to delete these notifications.
    108 
    109 == Troubleshooting ==
     228== Filtering notifications for one's own changes and comments
     229
     230To delete these notifications in Gmail, use the following filter:
     231{{{
     232from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     233}}}
     234
     235In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
     236
     237You can also add this plugin:
     238http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
     239
     240== Troubleshooting
    110241
    111242If 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.
    112243
    113 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.
    114 
    115 === ''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
    116247
    117248Typical error message:
     
    123254}}}
    124255
    125 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.
    126257
    127258Many users get confused when their manual attempts to contact the SMTP server succeed:
    128 {{{
     259{{{#!sh
    129260telnet localhost 25
    130261}}}
    131 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    132 {{{
     262
     263This is because a regular user may connect to the SMTP server, but the web server cannot:
     264{{{#!sh
    133265sudo -u www-data telnet localhost 25
    134266}}}
    135267
    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.
    137 
    138 Relevant ML threads:
    139  * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    140  
    141 === ''Suspected spam'' error ===
     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
     271
     272For SELinux in Fedora 10:
     273{{{#!sh
     274setsebool -P httpd_can_sendmail 1
     275}}}
     276
     277=== ''Suspected spam'' error
    142278
    143279Some SMTP servers may reject the notification email sent by Trac.
    144280
    145 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.
    146 
    147 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.
     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.
    148284
    149285----
    150 See also: TracTickets, TracIni, TracGuide
     286See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]