Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
Jul 30, 2012 5:29:13 PM (12 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v1 v2  
    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. 
    … …  
    2018 
    2119Alternatively, 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`'''). 
    2222 
    2323== Configuring SMTP Notification == 
    … …  
    4141 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
    4242 * '''`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.  
     43 * '''`ignore_domains`''': Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains). 
     44 * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values: 
     45   * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.  
     46   * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines. 
     47   * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used. 
    4748 * '''`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. 
     49 * '''`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: 
     50   * `SmtpEmailSender`: connects to an SMTP server (default). 
     51   * `SendmailEmailSender`: runs a `sendmail`-compatible executable.    
    4852 
    4953Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
    … …  
    5660 * '''`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. 
    5761 
     62The following option is specific to email delivery through a `sendmail`-compatible executable. 
     63 * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options. 
    5864 
    5965=== Example Configuration (SMTP) === 
    … …  
    6773}}} 
    6874 
     75=== Example Configuration (`sendmail`) === 
     76{{{ 
     77[notification] 
     78smtp_enabled = true 
     79email_sender = SendmailEmailSender 
     80sendmail_path = /usr/sbin/sendmail 
     81smtp_from = notifier@example.com 
     82smtp_replyto = myproj@projects.example.com 
     83smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com 
     84}}} 
    6985 
    7086=== Customizing the e-mail subject === 
    … …  
    8298=== Customizing the e-mail content === 
    8399 
    84 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`.  The default looks like this: 
     100The 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: 
    85101 
    86102{{{ 
    87103$ticket_body_hdr 
    88104$ticket_props 
    89 #choose ticket.new 
    90   #when True 
     105{% choose ticket.new %}\ 
     106{%   when True %}\ 
    91107$ticket.description 
    92   #end 
    93   #otherwise 
    94     #if changes_body 
    95 Changes (by $change.author): 
     108{%   end %}\ 
     109{%   otherwise %}\ 
     110{%     if changes_body %}\ 
     111${_('Changes (by %(author)s):', author=change.author)} 
    96112 
    97113$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 
     114{%     end %}\ 
     115{%     if changes_descr %}\ 
     116{%       if not changes_body and not change.comment and change.author %}\ 
     117${_('Description changed by %(author)s:', author=change.author)} 
     118{%       end %}\ 
    103119$changes_descr 
    104120-- 
    105     #end 
    106     #if change.comment 
    107  
    108 Comment${not changes_body and '(by %s)' % change.author or ''}: 
     121{%     end %}\ 
     122{%     if change.comment %}\ 
     123 
     124${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)} 
    109125 
    110126$change.comment 
    111     #end 
    112   #end 
    113 #end 
     127{%     end %}\ 
     128{%   end %}\ 
     129{% end %}\ 
    114130 
    115131--  
    116 Ticket URL: <$ticket.link> 
     132${_('Ticket URL: <%(link)s>', link=ticket.link)} 
    117133$project.name <${project.url or abs_href()}> 
    118134$project.descr 
    … …  
    144160}}} 
    145161 
     162 
     163== Customizing e-mail content for MS Outlook == 
     164 
     165Out-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]. 
     166 
     167Replace the following second row in the template: 
     168{{{ 
     169$ticket_props 
     170}}} 
     171 
     172with this instead: 
     173{{{ 
     174-------------------------------------------------------------------------- 
     175{% with 
     176   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in 
     177         [c.strip() for c in  
     178          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]]; 
     179   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',  
     180          'Component', 'Severity', 'Resolution', 'Keywords'] %}\ 
     181${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)} 
     182{% end %}\ 
     183-------------------------------------------------------------------------- 
     184}}} 
     185 
     186The 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. 
     187{{{#!div style="margin: 1em 1.75em; border:1px dotted" 
     188{{{#!html 
     189#42: testing<br /> 
     190--------------------------------------------------------------------------<br /> 
     191<table cellpadding=0> 
     192<tr><td>Reporter:</td><td>jonas@example.com</td></tr> 
     193<tr><td>Owner:</td><td>anonymous</td></tr> 
     194<tr><td>Type:</td><td>defect</td></tr> 
     195<tr><td>Status:</td><td>assigned</td></tr> 
     196<tr><td>Priority:</td><td>lowest</td></tr> 
     197<tr><td>Milestone:</td><td>0.9</td></tr> 
     198<tr><td>Component:</td><td>report system</td></tr> 
     199<tr><td>Severity:</td><td>major</td></tr> 
     200<tr><td>Resolution:</td><td> </td></tr> 
     201<tr><td>Keywords:</td><td> </td></tr> 
     202</table> 
     203--------------------------------------------------------------------------<br /> 
     204Changes:<br /> 
     205<br /> 
     206&nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br /> 
     207&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br /> 
     208&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br /> 
     209&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br /> 
     210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br /> 
     211&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br /> 
     212<br /> 
     213Comment:<br /> 
     214I'm interested too!<br /> 
     215<br /> 
     216--<br /> 
     217Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br /> 
     218My Project &lt;http://myproj.example.com/&gt;<br /> 
     219}}} 
     220}}} 
     221 
     222However, it's not as perfect as an HTML formatted e-mail would be, but presented ticket properties are at least readable... 
     223 
     224 
    146225== Using GMail as the SMTP relay host == 
    147226