Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
Apr 20, 2015 8:51:57 PM (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v2 v3  
    99
    1010== 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.
     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.
    1412
    1513=== How to use your username to receive notification mails ===
    1614
    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.
     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}}}
    2028
    2129== Configuring SMTP Notification ==
     
    2432
    2533=== 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'') E-mail notifications are always sent in 7-bit mode. This option allows to select the MIME encoding scheme. Supported values:
    42    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    43    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    44    * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
    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.
     34These are the available options for the `[notification]` section in trac.ini:
     35
     36[[TracIni(notification)]]
    6137
    6238=== Example Configuration (SMTP) ===
     
    9167 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    9268 * `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`.
     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`.
    9470
    9571=== Customizing the e-mail content ===
    9672
    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:
     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:
    9874
    9975{{{
    10076$ticket_body_hdr
    10177$ticket_props
    102 #choose ticket.new
    103   #when True
     78{% choose ticket.new %}\
     79{%   when True %}\
    10480$ticket.description
    105   #end
    106   #otherwise
    107     #if changes_body
    108 Changes (by $change.author):
     81{%   end %}\
     82{%   otherwise %}\
     83{%     if changes_body %}\
     84${_('Changes (by %(author)s):', author=change.author)}
    10985
    11086$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
     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 %}\
    11692$changes_descr
    11793--
    118     #end
    119     #if change.comment
    120 
    121 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)}
    12298
    12399$change.comment
    124     #end
    125   #end
    126 #end
     100{%     end %}\
     101{%   end %}\
     102{% end %}\
    127103
    128104--
    129 Ticket URL: <$ticket.link>
     105${_('Ticket URL: <%(link)s>', link=ticket.link)}
    130106$project.name <${project.url or abs_href()}>
    131107$project.descr
    132108}}}
     109
    133110== Sample Email ==
    134111{{{
     
    142119---------------------------+------------------------------------------------
    143120Changes:
    144   * component:  changset view => search system
     121  * component:  changeset view => search system
    145122  * priority:  low => highest
    146123  * owner:  jonas => anonymous
     
    157134}}}
    158135
     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
    159202== Using GMail as the SMTP relay host ==
    160203
    161 Use the following configuration snippet
     204Use the following configuration snippet:
    162205{{{
    163206[notification]
     
    171214}}}
    172215
    173 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].
    174217
    175218Alternatively, 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.
     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.
    177220 
    178 == Filtering notifications for one's own changes ==
     221== Filtering notifications for one's own changes and comments ==
    179222In 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:
    186223{{{
    187224from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     
    190227to delete these notifications.
    191228
    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.
     229In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    197230
    198231You can also add this plugin:
    199 http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin
     232http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin, or vote for [trac:#2247] to be fixed.
    200233
    201234== Troubleshooting ==
     
    203236If 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.
    204237
    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.
     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.
    206239
    207240=== ''Permission denied'' error ===
     
    215248}}}
    216249
    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.
     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.
    218251
    219252Many users get confused when their manual attempts to contact the SMTP server succeed:
     
    221254telnet localhost 25
    222255}}}
    223 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:
    224257{{{
    225258sudo -u www-data telnet localhost 25
    226259}}}
    227260
    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.
     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.
    229262
    230263Relevant ML threads:
     
    235268$ setsebool -P httpd_can_sendmail 1
    236269}}}
     270
    237271=== ''Suspected spam'' error ===
    238272
    239273Some SMTP servers may reject the notification email sent by Trac.
    240274
    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 
     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.
    253278
    254279----
    255 See also: TracTickets, TracIni, TracGuide
     280See also: TracTickets, TracIni, TracGuide, [trac:TracDev/NotificationApi]