Changes between Version 1 and Version 2 of TracNotification


Ignore:
Timestamp:
Mar 7, 2011 4:32:52 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v1 v2  
    1818 
    1919Alternatively, 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  
    21 When 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`'''). 
    2220 
    2321== Configuring SMTP Notification == 
    … …  
    4139 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy). 
    4240 * '''`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  * '''`ignore_domains`''': Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains). 
    4441 * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values: 
    4542   * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.  
    … …  
    4946 * '''`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: 
    5047   * `SmtpEmailSender`: connects to an SMTP server (default). 
    51    * `SendmailEmailSender`: runs a `sendmail`-compatible executable.    
     48   * `SendmailEmailSender`: runs a `sendmail`-compatible executable. 
    5249 
    5350Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails. 
    … …  
    103100$ticket_body_hdr 
    104101$ticket_props 
    105 {% choose ticket.new %}\ 
    106 {%   when True %}\ 
     102#choose ticket.new 
     103  #when True 
    107104$ticket.description 
    108 {%   end %}\ 
    109 {%   otherwise %}\ 
    110 {%     if changes_body %}\ 
    111 ${_('Changes (by %(author)s):', author=change.author)} 
     105  #end 
     106  #otherwise 
     107    #if changes_body 
     108Changes (by $change.author): 
    112109 
    113110$changes_body 
    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 %}\ 
     111    #end 
     112    #if changes_descr 
     113      #if not changes_body and not change.comment and change.author 
     114Description changed by $change.author: 
     115      #end 
    119116$changes_descr 
    120117-- 
    121 {%     end %}\ 
    122 {%     if change.comment %}\ 
    123  
    124 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)} 
     118    #end 
     119    #if change.comment 
     120 
     121Comment${not changes_body and '(by %s)' % change.author or ''}: 
    125122 
    126123$change.comment 
    127 {%     end %}\ 
    128 {%   end %}\ 
    129 {% end %}\ 
     124    #end 
     125  #end 
     126#end 
    130127 
    131128--  
    132 ${_('Ticket URL: <%(link)s>', link=ticket.link)} 
     129Ticket URL: <$ticket.link> 
    133130$project.name <${project.url or abs_href()}> 
    134131$project.descr 
    … …  
    160157}}} 
    161158 
    162  
    163 == Customizing e-mail content for MS Outlook == 
    164  
    165 Out-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  
    167 Replace the following second row in the template: 
    168 {{{ 
    169 $ticket_props 
    170 }}} 
    171  
    172 with 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  
    186 The 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 /> 
    204 Changes:<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 /> 
    213 Comment:<br /> 
    214 I'm interested too!<br /> 
    215 <br /> 
    216 --<br /> 
    217 Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br /> 
    218 My Project &lt;http://myproj.example.com/&gt;<br /> 
    219 }}} 
    220 }}} 
    221  
    222 However, it's not as perfect as an HTML formatted e-mail would be, but presented ticket properties are at least readable... 
    223  
    224  
    225159== Using GMail as the SMTP relay host == 
    226160