Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
12/24/13 20:27:23 (10 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 == 
    … …  
    3131 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails. 
    3232 * '''`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. 
    3334 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails. 
    3435 * '''`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. 
    … …  
    4142 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
    4243 * '''`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.  
     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. 
    4749 * '''`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. 
    4853 
    4954Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
    … …  
    5661 * '''`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. 
    5762 
     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. 
    5865 
    5966=== Example Configuration (SMTP) === 
    … …  
    6774}}} 
    6875 
     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}}} 
    6986 
    7087=== Customizing the e-mail subject === 
    … …  
    8299=== Customizing the e-mail content === 
    83100 
    84 The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. The default looks like this: 
     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: 
    85102 
    86103{{{ 
    87104$ticket_body_hdr 
    88105$ticket_props 
    89 #choose ticket.new 
    90   #when True 
     106{% choose ticket.new %}\ 
     107{%   when True %}\ 
    91108$ticket.description 
    92   #end 
    93   #otherwise 
    94     #if changes_body 
    95 Changes (by $change.author): 
     109{%   end %}\ 
     110{%   otherwise %}\ 
     111{%     if changes_body %}\ 
     112${_('Changes (by %(author)s):', author=change.author)} 
    96113 
    97114$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 
     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 %}\ 
    103120$changes_descr 
    104121-- 
    105     #end 
    106     #if change.comment 
    107  
    108 Comment${not changes_body and '(by %s)' % change.author or ''}: 
     122{%     end %}\ 
     123{%     if change.comment %}\ 
     124 
     125${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)} 
    109126 
    110127$change.comment 
    111     #end 
    112   #end 
    113 #end 
     128{%     end %}\ 
     129{%   end %}\ 
     130{% end %}\ 
    114131 
    115132--  
    116 Ticket URL: <$ticket.link> 
     133${_('Ticket URL: <%(link)s>', link=ticket.link)} 
    117134$project.name <${project.url or abs_href()}> 
    118135$project.descr 
    … …  
    144161}}} 
    145162 
     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 
    146231== Using GMail as the SMTP relay host == 
    147232