Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
May 9, 2017, 5:01:29 PM (4 years 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.
    20 
    21 == Configuring SMTP Notification ==
     10== Receiving Notification Mails
     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.
     12
     13=== How to use your username to receive notification mails
     14
     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}}}
     28
     29== Configuring SMTP Notification
    2230
    2331'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    2432
    25 === Configuration Options ===
    26 These are the available options for the `[notification]` section in trac.ini.
    27 
    28  * '''`smtp_enabled`''': Enable email notification.
    29  * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
    30  * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
    31  * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    32  * '''`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.
    33  * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    34  * '''`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
    35  * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    36  * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
    37  * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    38  * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    39  * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    40  * '''`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.
    41  * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values:
    42    * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.
    43    * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    44    * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used.
    45  * '''`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.
    46  * '''`email_sender`''': (''since 0.12'') Name of the component implementing `IEmailSender`. This component is used by the notification system to send emails. Trac currently provides the following components:
    47    * `SmtpEmailSender`: connects to an SMTP server (default).
    48    * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
    49 
    50 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    51 
    52 The following options are specific to email delivery through SMTP.
    53  * '''`smtp_server`''': SMTP server used for notification messages.
    54  * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
    55  * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
    56  * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
    57  * '''`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.
    58 
    59 The following option is specific to email delivery through a `sendmail`-compatible executable.
    60  * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
    61 
    62 === Example Configuration (SMTP) ===
    63 {{{
     33=== Configuration Options
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(section=notification)]]
     37
     38=== Example Configuration (SMTP)
     39{{{#!ini
    6440[notification]
    6541smtp_enabled = true
     
    7046}}}
    7147
    72 === Example Configuration (`sendmail`) ===
    73 {{{
     48=== Example Configuration (`sendmail`)
     49{{{#!ini
    7450[notification]
    7551smtp_enabled = true
     
    8157}}}
    8258
    83 === Customizing the e-mail subject ===
     59=== Subscriber Configuration
     60The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
     61
     62[[TracIni(section=notification-subscriber)]]
     63
     64Each user can override these defaults in his ''Notifications'' preferences.
     65
     66For example to unsubscribe from notifications for one's own changes and comments, the rule "Never notify: I update a ticket" should be added above other subscription rules.
     67
     68The subscription rule name on the left side of the `=` can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the `=` must be one of the subscribers listed in the above table.
     69
     70The following attributes of default subscriptions can be configured:
     71* `.distributor` (Default: `email`)
     72  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
     73* `.priority` (Default: `100`)
     74  * Smaller values override larger values.
     75  * If you use `0`, then users will not be able to override this rule.
     76* `.adverb` (Default: `always`)
     77  * `never` can be used to silence other subscription rules with higher values.
     78* `.format` (Default: `text/plain`)
     79  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
     80
     81=== Example Configuration (default subscriptions)
     82{{{#!ini
     83[notification-subscriber]
     84always_notify_owner = TicketOwnerSubscriber
     85always_notify_owner.distributor = email
     86always_notify_owner.priority = 100
     87always_notify_owner.adverb = always
     88always_notify_owner.format = text/plain
     89
     90always_notify_previous_updater = TicketPreviousUpdatersSubscriber
     91
     92never_notify_updater = TicketUpdaterSubscriber
     93never_notify_updater.adverb = never
     94never_notify_updater.priority = 0
     95
     96notify_cc_html = CarbonCopySubscriber
     97notify_cc_html.format = text/html
     98}}}
     99
     100=== Customizing the e-mail subject
    84101The 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:
    85 {{{
    86 $prefix #$ticket.id: $summary
     102{{{#!genshi
     103${prefix} #${ticket.id}: ${summary}
    87104}}}
    88105The following variables are available in the template:
     
    91108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    92109 * `summary`: The ticket summary, with the old value if the summary was edited.
    93  * `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`.
    94 
    95 === Customizing the e-mail content ===
    96 
    97 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:
    98 
    99 {{{
    100 $ticket_body_hdr
    101 $ticket_props
    102 #choose ticket.new
    103   #when True
    104 $ticket.description
    105   #end
    106   #otherwise
    107     #if changes_body
    108 Changes (by $change.author):
    109 
    110 $changes_body
    111     #end
    112     #if changes_descr
    113       #if not changes_body and not change.comment and change.author
    114 Description changed by $change.author:
    115       #end
    116 $changes_descr
     110 * `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}`.
     111
     112=== Customizing the e-mail content
     113
     114The 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:
     115
     116{{{#!genshi
     117${ticket_body_hdr}
     118${ticket_props}
     119{% choose ticket.new %}\
     120{%   when True %}\
     121${ticket.description}
     122{%   end %}\
     123{%   otherwise %}\
     124{%     if changes_body %}\
     125${_('Changes (by %(author)s):', author=change.author)}
     126
     127${changes_body}
     128{%     end %}\
     129{%     if changes_descr %}\
     130{%       if not changes_body and not change.comment and change.author %}\
     131${_('Description changed by %(author)s:', author=change.author)}
     132{%       end %}\
     133${changes_descr}
    117134--
    118     #end
    119     #if change.comment
    120 
    121 Comment${not changes_body and '(by %s)' % change.author or ''}:
    122 
    123 $change.comment
    124     #end
    125   #end
    126 #end
     135{%     end %}\
     136{%     if change.comment %}\
     137
     138${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
     139
     140${change.comment}
     141{%     end %}\
     142{%   end %}\
     143{% end %}\
    127144
    128145--
    129 Ticket URL: <$ticket.link>
    130 $project.name <${project.url or abs_href()}>
    131 $project.descr
    132 }}}
    133 == Sample Email ==
     146${_('Ticket URL: <%(link)s>', link=ticket.link)}
     147${project.name} <${project.url or abs_href()}>
     148${project.descr}
     149}}}
     150
     151== Sample Email
    134152{{{
    135153#42: testing
     
    142160---------------------------+------------------------------------------------
    143161Changes:
    144   * component:  changset view => search system
     162  * component:  changeset view => search system
    145163  * priority:  low => highest
    146164  * owner:  jonas => anonymous
     
    157175}}}
    158176
    159 == Using GMail as the SMTP relay host ==
    160 
    161 Use the following configuration snippet
     177== Customizing e-mail content for MS Outlook
     178
     179MS 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].
     180
     181Replace the following second row in the template:
    162182{{{
     183${ticket_props}
     184}}}
     185
     186with this (requires Python 2.6 or later):
     187{{{
     188--------------------------------------------------------------------------
     189{% with
     190   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     191         [c.strip() for c in
     192          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     193   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     194          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     195${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     196{% end %}\
     197--------------------------------------------------------------------------
     198}}}
     199
     200The 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.
     201{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     202{{{#!html
     203#42: testing<br />
     204--------------------------------------------------------------------------<br />
     205<table cellpadding=0>
     206<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     207<tr><td>Owner:</td><td>anonymous</td></tr>
     208<tr><td>Type:</td><td>defect</td></tr>
     209<tr><td>Status:</td><td>assigned</td></tr>
     210<tr><td>Priority:</td><td>lowest</td></tr>
     211<tr><td>Milestone:</td><td>0.9</td></tr>
     212<tr><td>Component:</td><td>report system</td></tr>
     213<tr><td>Severity:</td><td>major</td></tr>
     214<tr><td>Resolution:</td><td> </td></tr>
     215<tr><td>Keywords:</td><td> </td></tr>
     216</table>
     217--------------------------------------------------------------------------<br />
     218Changes:<br />
     219<br />
     220&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
     221&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     222&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     223&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     225&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     226<br />
     227Comment:<br />
     228I'm interested too!<br />
     229<br />
     230--<br />
     231Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     232My Project &lt;http://myproj.example.com/&gt;<br />
     233}}}
     234}}}
     235
     236**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:
     237{{{
     238   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     239}}}
     240
     241However, the solution is still a workaround to an automatically HTML-formatted e-mail.
     242
     243== Using GMail as the SMTP relay host
     244
     245Use the following configuration snippet:
     246{{{#!ini
    163247[notification]
    164248smtp_enabled = true
     
    171255}}}
    172256
    173 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     257where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    174258
    175259Alternatively, you can use `smtp_port = 25`.[[br]]
    176 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.
    177  
    178 == Filtering notifications for one's own changes ==
    179 In Gmail, use the filter:
    180 
    181 {{{
    182 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    183 }}}
    184 
    185 For Trac .10, use the filter:
    186 {{{
    187 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    188 }}}
    189 
    190 to delete these notifications.
    191 
    192 In Thunderbird, there is no such solution if you use IMAP
    193 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
    194 
    195 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    196 You will however still get an email if you comment a ticket that you own or have reported.
    197 
    198 You can also add this plugin:
    199 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    200 
    201 == Troubleshooting ==
     260You 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.
     261
     262== Troubleshooting
    202263
    203264If 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.
    204265
    205 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.
    206 
    207 === ''Permission denied'' error ===
     266Notification 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.
     267
     268=== ''Permission denied'' error
    208269
    209270Typical error message:
    210 {{{
     271{{{#!sh
    211272  ...
    212273  File ".../smtplib.py", line 303, in connect
     
    215276}}}
    216277
    217 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.
     278This 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.
    218279
    219280Many users get confused when their manual attempts to contact the SMTP server succeed:
    220 {{{
     281{{{#!sh
    221282telnet localhost 25
    222283}}}
    223 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    224 {{{
     284This is because a regular user may connect to the SMTP server, but the web server cannot:
     285{{{#!sh
    225286sudo -u www-data telnet localhost 25
    226287}}}
    227288
    228 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.
     289In 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.
    229290
    230291Relevant ML threads:
     
    232293
    233294For SELinux in Fedora 10:
    234 {{{
     295{{{#!sh
    235296$ setsebool -P httpd_can_sendmail 1
    236297}}}
    237 === ''Suspected spam'' error ===
     298
     299=== ''Suspected spam'' error
    238300
    239301Some SMTP servers may reject the notification email sent by Trac.
    240302
    241 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.
    242 
    243 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.
    244 
    245 === ''501, 5.5.4 Invalid Address'' error ===
    246 
    247 On IIS 6.0 you could get a
    248 {{{
    249 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    250 }}}
    251 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    252 
     303The 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.
     304
     305Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    253306
    254307----
    255 See also: TracTickets, TracIni, TracGuide
     308See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]