Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
May 5, 2015, 2:14:48 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v4 v5  
    22[[TracGuideToc]]
    33
    4 [[PageOutline]]
    5 
    6 Trac supports notification about ticket changes via email.
     4Trac supports notification of ticket changes via email.
    75
    86Email 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.
     
    119
    1210== Receiving Notification Mails ==
    13 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).
    14 
    15 This is useful to keep up-to-date on an issue or enhancement request that interests you.
     11When 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.
    1612
    1713=== How to use your username to receive notification mails ===
    1814
    19 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.
    20 
    21 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.
     15To 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
     17Alternatively, 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.
     18
     19When 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`''').
     20
     21=== Ticket attachment notifications
     22
     23Since 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]
     26trac.ticket.notification.TicketAttachmentNotifier = disabled
     27}}}
    2228
    2329== Configuring SMTP Notification ==
     
    2632
    2733=== Configuration Options ===
    28 These are the available options for the `[notification]` section in trac.ini.
    29 
    30  * '''`smtp_enabled`''': Enable email notification.
    31  * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
    32  * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
    33  * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    34  * '''`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.
    35  * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    36  * '''`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
    37  * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    38  * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
    39  * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    40  * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    41  * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    42  * '''`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.
    43  * '''`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:
    44    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    45    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    46    * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
    47  * '''`ticket_subject_template`''': (''since 0.11'') A [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet used to get the notification subject.
    48 
    49 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    50 
    51 The following options are specific to email delivery through SMTP.
    52  * '''`smtp_server`''': SMTP server used for notification messages.
    53  * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
    54  * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
    55  * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
    56  * '''`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.
    57 
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(notification)]]
    5837
    5938=== Example Configuration (SMTP) ===
     
    6746}}}
    6847
     48=== Example Configuration (`sendmail`) ===
     49{{{
     50[notification]
     51smtp_enabled = true
     52email_sender = SendmailEmailSender
     53sendmail_path = /usr/sbin/sendmail
     54smtp_from = notifier@example.com
     55smtp_replyto = myproj@projects.example.com
     56smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
     57}}}
    6958
    7059=== Customizing the e-mail subject ===
     
    7867 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    7968 * `summary`: The ticket summary, with the old value if the summary was edited.
    80  * `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`.
    8170
    8271=== Customizing the e-mail content ===
    8372
    84 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. The default looks like this:
     73The 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:
    8574
    8675{{{
    8776$ticket_body_hdr
    8877$ticket_props
    89 #choose ticket.new
    90   #when True
     78{% choose ticket.new %}\
     79{%   when True %}\
    9180$ticket.description
    92   #end
    93   #otherwise
    94     #if changes_body
    95 Changes (by $change.author):
     81{%   end %}\
     82{%   otherwise %}\
     83{%     if changes_body %}\
     84${_('Changes (by %(author)s):', author=change.author)}
    9685
    9786$changes_body
    98     #end
    99     #if changes_descr
    100       #if not changes_body and not change.comment and change.author
    101 Description changed by $change.author:
    102       #end
     87{%     end %}\
     88{%     if changes_descr %}\
     89{%       if not changes_body and not change.comment and change.author %}\
     90${_('Description changed by %(author)s:', author=change.author)}
     91{%       end %}\
    10392$changes_descr
    10493--
    105     #end
    106     #if change.comment
    107 
    108 Comment${not changes_body and '(by %s)' % change.author or ''}:
     94{%     end %}\
     95{%     if change.comment %}\
     96
     97${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
    10998
    11099$change.comment
    111     #end
    112   #end
    113 #end
     100{%     end %}\
     101{%   end %}\
     102{% end %}\
    114103
    115104--
    116 Ticket URL: <$ticket.link>
     105${_('Ticket URL: <%(link)s>', link=ticket.link)}
    117106$project.name <${project.url or abs_href()}>
    118107$project.descr
    119108}}}
     109
    120110== Sample Email ==
    121111{{{
     
    129119---------------------------+------------------------------------------------
    130120Changes:
    131   * component:  changset view => search system
     121  * component:  changeset view => search system
    132122  * priority:  low => highest
    133123  * owner:  jonas => anonymous
     
    144134}}}
    145135
     136== Customizing e-mail content for MS Outlook ==
     137
     138MS 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].
     139
     140Replace the following second row in the template:
     141{{{
     142$ticket_props
     143}}}
     144
     145with this (requires Python 2.6 or later):
     146{{{
     147--------------------------------------------------------------------------
     148{% with
     149   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     150         [c.strip() for c in
     151          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     152   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     153          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     154${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     155{% end %}\
     156--------------------------------------------------------------------------
     157}}}
     158
     159The 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.
     160{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     161{{{#!html
     162#42: testing<br />
     163--------------------------------------------------------------------------<br />
     164<table cellpadding=0>
     165<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     166<tr><td>Owner:</td><td>anonymous</td></tr>
     167<tr><td>Type:</td><td>defect</td></tr>
     168<tr><td>Status:</td><td>assigned</td></tr>
     169<tr><td>Priority:</td><td>lowest</td></tr>
     170<tr><td>Milestone:</td><td>0.9</td></tr>
     171<tr><td>Component:</td><td>report system</td></tr>
     172<tr><td>Severity:</td><td>major</td></tr>
     173<tr><td>Resolution:</td><td> </td></tr>
     174<tr><td>Keywords:</td><td> </td></tr>
     175</table>
     176--------------------------------------------------------------------------<br />
     177Changes:<br />
     178<br />
     179&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     180&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     181&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     182&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     184&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     185<br />
     186Comment:<br />
     187I'm interested too!<br />
     188<br />
     189--<br />
     190Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     191My Project &lt;http://myproj.example.com/&gt;<br />
     192}}}
     193}}}
     194
     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:
     196{{{
     197   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     198}}}
     199
     200However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     201
    146202== Using GMail as the SMTP relay host ==
    147203
    148 Use the following configuration snippet
     204Use the following configuration snippet:
    149205{{{
    150206[notification]
     
    158214}}}
    159215
    160 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     216where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    161217
    162218Alternatively, you can use `smtp_port = 25`.[[br]]
    163 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.
     219You 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.
    164220 
    165 == Filtering notifications for one's own changes ==
     221== Filtering notifications for one's own changes and comments ==
    166222In Gmail, use the filter:
    167 
    168 {{{
    169 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    170 }}}
    171 
    172 For Trac .10, use the filter:
    173223{{{
    174224from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     
    177227to delete these notifications.
    178228
    179 In Thunderbird, there is no such solution if you use IMAP
    180 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    181 
    182 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    183 You will however still get an email if you comment a ticket that you own or have reported.
     229In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    184230
    185231You can also add this plugin:
    186 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
     232http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    187233
    188234== Troubleshooting ==
     
    190236If 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.
    191237
    192 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.
     238Notification 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.
    193239
    194240=== ''Permission denied'' error ===
     
    202248}}}
    203249
    204 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.
     250This 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.
    205251
    206252Many users get confused when their manual attempts to contact the SMTP server succeed:
     
    208254telnet localhost 25
    209255}}}
    210 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
     256This is because a regular user may connect to the SMTP server, but the web server cannot:
    211257{{{
    212258sudo -u www-data telnet localhost 25
    213259}}}
    214260
    215 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.
     261In 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.
    216262
    217263Relevant ML threads:
     
    222268$ setsebool -P httpd_can_sendmail 1
    223269}}}
     270
    224271=== ''Suspected spam'' error ===
    225272
    226273Some SMTP servers may reject the notification email sent by Trac.
    227274
    228 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.
    229 
    230 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.
    231 
    232 === ''501, 5.5.4 Invalid Address'' error ===
    233 
    234 On IIS 6.0 you could get a
    235 {{{
    236 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    237 }}}
    238 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    239 
     275The 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
     277Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    240278
    241279----
    242 See also: TracTickets, TracIni, TracGuide
     280See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]