Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
11/14/18 14:30:36 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v2 v3  
    1 = Email Notification of Ticket Changes =
     1= Email Notification of Ticket Changes
    22[[TracGuideToc]]
    33
    4 [[PageOutline]]
    5 
    6 Trac supports notification about ticket changes via email.
    7 
    8 Email 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.
    9 
    10 Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
    11 
    12 == 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.
    16 
    17 === How to use your username to receive notification mails ===
    18 
    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.
    22 
    23 == Configuring SMTP Notification ==
    24 
    25 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    26 
    27 === 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 
    58 
    59 === Example Configuration (SMTP) ===
    60 {{{
     4Trac supports notification of ticket changes via email.
     5
     6Email notification is useful to keep users up-to-date on tickets of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list.
     7
     8Disabled by default, notification can be activated and configured in [TracIni trac.ini].
     9
     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 your [/prefs preferences].
     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
     30
     31'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
     32
     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
    6140[notification]
    6241smtp_enabled = true
     
    6746}}}
    6847
    69 
    70 === Customizing the e-mail subject ===
     48=== Example Configuration (`sendmail`)
     49{{{#!ini
     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}}}
     58
     59=== Subscriber Configuration
     60The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
     61
     62[[TracIni(section=notification-subscriber)]]
     63
     64Each user can override these defaults in their ''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
    71101The 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:
    72 {{{
    73 $prefix #$ticket.id: $summary
     102{{{#!genshi
     103${prefix} #${ticket.id}: ${summary}
    74104}}}
    75105The following variables are available in the template:
    76106
    77  * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
     107 * `env`: The project environment object (see [trac:source:branches/1.2-stable/trac/env.py env.py]).
    78108 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    79109 * `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`.
    81 
    82 === Customizing the e-mail content ===
    83 
    84 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  The default looks like this:
    85 
    86 {{{
     110 * `ticket`: The ticket model object (see [trac:source:branches/1.2-stable/trac/ticket/model.py model.py]). Individual ticket fields can be accessed 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 is:
     115
     116{{{#!genshi
    87117$ticket_body_hdr
    88118$ticket_props
    89 #choose ticket.new
    90   #when True
     119{% choose ticket.new %}\
     120{%   when True %}\
    91121$ticket.description
    92   #end
    93   #otherwise
    94     #if changes_body
    95 Changes (by $change.author):
     122{%   end %}\
     123{%   otherwise %}\
     124{%     if changes_body %}\
     125${_('Changes (by %(author)s):', author=change.author)}
    96126
    97127$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
     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 %}\
    103133$changes_descr
    104134--
    105     #end
    106     #if change.comment
    107 
    108 Comment${not changes_body and '(by %s)' % change.author or ''}:
     135{%     end %}\
     136{%     if change.comment %}\
     137
     138${_('Comment:') if changes_body else _('Comment (by %(author)s):', author=change.author)}
    109139
    110140$change.comment
    111     #end
    112   #end
    113 #end
    114 
    115 --
    116 Ticket URL: <$ticket.link>
     141{%     end %}\
     142{%   end %}\
     143{% end %}\
     144
     145${'-- '}
     146${_('Ticket URL: <%(link)s>', link=ticket.link)}
    117147$project.name <${project.url or abs_href()}>
    118148$project.descr
    119149}}}
    120 == Sample Email ==
     150
     151See the [trac:CookBook/Notification/Templates cookbook] for additional template customization recipes.
     152
     153== Sample Email
    121154{{{
    122155#42: testing
     
    129162---------------------------+------------------------------------------------
    130163Changes:
    131   * component:  changset view => search system
     164  * component:  changeset view => search system
    132165  * priority:  low => highest
    133166  * owner:  jonas => anonymous
     
    144177}}}
    145178
    146 == Using GMail as the SMTP relay host ==
    147 
    148 Use the following configuration snippet
    149 {{{
     179== Using GMail as the SMTP relay host
     180
     181Use the following configuration snippet:
     182{{{#!ini
    150183[notification]
    151184smtp_enabled = true
     
    158191}}}
    159192
    160 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     193where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    161194
    162195Alternatively, 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.
    164  
    165 == Filtering notifications for one's own changes ==
    166 In 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:
    173 {{{
    174 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    175 }}}
    176 
    177 to delete these notifications.
    178 
    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.
    184 
    185 You can also add this plugin:
    186 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
    187 
    188 == Troubleshooting ==
    189 
    190 If 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.
    191 
    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.
    193 
    194 === ''Permission denied'' error ===
     196You 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.
     197
     198== Troubleshooting
     199
     200If notifications are not working, inspect the [TracLogging log] for error messages.
     201
     202Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback.
     203
     204=== ''Permission denied'' error
    195205
    196206Typical error message:
    197 {{{
     207{{{#!sh
    198208  ...
    199209  File ".../smtplib.py", line 303, in connect
     
    202212}}}
    203213
    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.
     214This 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.
    205215
    206216Many users get confused when their manual attempts to contact the SMTP server succeed:
    207 {{{
     217{{{#!sh
    208218telnet localhost 25
    209219}}}
    210 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
    211 {{{
     220This is because a regular user may connect to the SMTP server, but the web server cannot:
     221{{{#!sh
    212222sudo -u www-data telnet localhost 25
    213223}}}
    214224
    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.
     225In 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.
    216226
    217227Relevant ML threads:
     
    219229
    220230For SELinux in Fedora 10:
    221 {{{
     231{{{#!sh
    222232$ setsebool -P httpd_can_sendmail 1
    223233}}}
    224 === ''Suspected spam'' error ===
     234
     235=== ''Suspected spam'' error
    225236
    226237Some SMTP servers may reject the notification email sent by Trac.
    227238
    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 
     239The 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.
     240
     241Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    240242
    241243----
    242 See also: TracTickets, TracIni, TracGuide
     244See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]