Changes between Version 3 and Version 4 of TracNotification


Ignore:
Timestamp:
Oct 14, 2012 11:10:29 AM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v3 v4  
    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. 
     
    99 
    1010== 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). 
     11When 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). 
    1212 
    1313This is useful to keep up-to-date on an issue or enhancement request that interests you. 
    1414 
     15=== How to use your username to receive notification mails === 
     16 
     17To 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 
     19Alternatively, 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 
     21When 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`'''). 
     22 
    1523== Configuring SMTP Notification == 
    1624 
     25'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].  
     26 
    1727=== 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  
     28These 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_from_author`''': (''since 1.0'') Use the author of a change (the reporter of a new ticket, or the author of a comment) as the `From:` header value in notification e-mails (default: false). If the author hasn't set an e-mail address, `smtp_from` and `smtp_from_name` are used instead. 
     34 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails. 
     35 * '''`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. 
     36 * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.'' 
     37 * '''`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  
     38 * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default. 
     39 * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false). 
     40 * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false). 
     41 * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true). 
     42 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
     43 * '''`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.  
     44 * '''`ignore_domains`''': Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains). 
     45 * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values: 
     46   * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.  
     47   * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
     48   * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used. 
     49 * '''`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. 
     50 * '''`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: 
     51   * `SmtpEmailSender`: connects to an SMTP server (default). 
     52   * `SendmailEmailSender`: runs a `sendmail`-compatible executable. 
     53 
     54Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
     55 
     56The following options are specific to email delivery through SMTP. 
     57 * '''`smtp_server`''': SMTP server used for notification messages. 
     58 * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server. 
     59 * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account. 
     60 * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account. 
     61 * '''`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. 
     62 
     63The following option is specific to email delivery through a `sendmail`-compatible executable. 
     64 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options. 
     65 
     66=== Example Configuration (SMTP) === 
    4667{{{ 
    4768[notification] 
     
    5374}}} 
    5475 
     76=== Example Configuration (`sendmail`) === 
     77{{{ 
     78[notification] 
     79smtp_enabled = true 
     80email_sender = SendmailEmailSender 
     81sendmail_path = /usr/sbin/sendmail 
     82smtp_from = notifier@example.com 
     83smtp_replyto = myproj@projects.example.com 
     84smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     85}}} 
     86 
     87=== Customizing the e-mail subject === 
     88The 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: 
     89{{{ 
     90$prefix #$ticket.id: $summary 
     91}}} 
     92The following variables are available in the template: 
     93 
     94 * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]). 
     95 * `prefix`: The prefix defined in `smtp_subject_prefix`. 
     96 * `summary`: The ticket summary, with the old value if the summary was edited. 
     97 * `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`. 
     98 
     99=== Customizing the e-mail content === 
     100 
     101The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/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: 
     102 
     103{{{ 
     104$ticket_body_hdr 
     105$ticket_props 
     106{% choose ticket.new %}\ 
     107{%   when True %}\ 
     108$ticket.description 
     109{%   end %}\ 
     110{%   otherwise %}\ 
     111{%     if changes_body %}\ 
     112${_('Changes (by %(author)s):', author=change.author)} 
     113 
     114$changes_body 
     115{%     end %}\ 
     116{%     if changes_descr %}\ 
     117{%       if not changes_body and not change.comment and change.author %}\ 
     118${_('Description changed by %(author)s:', author=change.author)} 
     119{%       end %}\ 
     120$changes_descr 
     121-- 
     122{%     end %}\ 
     123{%     if change.comment %}\ 
     124 
     125${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)} 
     126 
     127$change.comment 
     128{%     end %}\ 
     129{%   end %}\ 
     130{% end %}\ 
     131 
     132--  
     133${_('Ticket URL: <%(link)s>', link=ticket.link)} 
     134$project.name <${project.url or abs_href()}> 
     135$project.descr 
     136}}} 
    55137== Sample Email == 
    56138{{{ 
     
    79161}}} 
    80162 
     163 
     164== Customizing e-mail content for MS Outlook == 
     165 
     166Out-of-the-box, MS Outlook normally presents plain text e-mails with a variable-width font; 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]. 
     167 
     168Replace the following second row in the template: 
     169{{{ 
     170$ticket_props 
     171}}} 
     172 
     173with this instead (''requires Python 2.6 or later''): 
     174{{{ 
     175-------------------------------------------------------------------------- 
     176{% with 
     177   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in 
     178         [c.strip() for c in  
     179          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]]; 
     180   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',  
     181          'Component', 'Severity', 'Resolution', 'Keywords'] %}\ 
     182${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)} 
     183{% end %}\ 
     184-------------------------------------------------------------------------- 
     185}}} 
     186 
     187The 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. 
     188{{{#!div style="margin: 1em 1.75em; border:1px dotted" 
     189{{{#!html 
     190#42: testing<br /> 
     191--------------------------------------------------------------------------<br /> 
     192<table cellpadding=0> 
     193<tr><td>Reporter:</td><td>jonas@example.com</td></tr> 
     194<tr><td>Owner:</td><td>anonymous</td></tr> 
     195<tr><td>Type:</td><td>defect</td></tr> 
     196<tr><td>Status:</td><td>assigned</td></tr> 
     197<tr><td>Priority:</td><td>lowest</td></tr> 
     198<tr><td>Milestone:</td><td>0.9</td></tr> 
     199<tr><td>Component:</td><td>report system</td></tr> 
     200<tr><td>Severity:</td><td>major</td></tr> 
     201<tr><td>Resolution:</td><td> </td></tr> 
     202<tr><td>Keywords:</td><td> </td></tr> 
     203</table> 
     204--------------------------------------------------------------------------<br /> 
     205Changes:<br /> 
     206<br /> 
     207&nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br /> 
     208&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br /> 
     209&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br /> 
     210&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br /> 
     211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br /> 
     212&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br /> 
     213<br /> 
     214Comment:<br /> 
     215I'm interested too!<br /> 
     216<br /> 
     217--<br /> 
     218Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br /> 
     219My Project &lt;http://myproj.example.com/&gt;<br /> 
     220}}} 
     221}}} 
     222 
     223**Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which shall be part of the mail they have to be added to `sel`, example: 
     224{{{ 
     225   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2'] 
     226}}} 
     227 
     228However, it's not as perfect as an automatically HTML-formatted e-mail would be, but presented ticket properties are at least readable by default in MS Outlook... 
     229 
     230 
    81231== Using GMail as the SMTP relay host == 
    82232 
     
    105255}}} 
    106256 
     257For Trac .10, use the filter: 
     258{{{ 
     259from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)") 
     260}}} 
     261 
    107262to delete these notifications. 
     263 
     264In Thunderbird, there is no such solution if you use IMAP 
     265(see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body). 
     266 
     267The best you can do is to set "always_notify_updater" in conf/trac.ini to false. 
     268You will however still get an email if you comment a ticket that you own or have reported. 
     269 
     270You can also add this plugin: 
     271http://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin 
    108272 
    109273== Troubleshooting == 
     
    134298}}} 
    135299 
    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. 
     300In 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. 
    137301 
    138302Relevant ML threads: 
    139303 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518 
    140   
     304 
     305For SELinux in Fedora 10: 
     306{{{ 
     307$ setsebool -P httpd_can_sendmail 1 
     308}}} 
    141309=== ''Suspected spam'' error === 
    142310 
     
    146314 
    147315Quoted 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. 
     316 
     317=== ''501, 5.5.4 Invalid Address'' error === 
     318 
     319On IIS 6.0 you could get a  
     320{{{ 
     321Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address') 
     322}}} 
     323in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it. 
     324 
    148325 
    149326----