Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
Aug 5, 2014, 3:58:25 PM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNotification

    v2 v3  
    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
     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`''').
    2022
    2123== Configuring SMTP Notification ==
    … …  
    2931 * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
    3032 * '''`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.
    3134 * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    3235 * '''`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.
    … …  
    3942 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    4043 * '''`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.
     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.
    4549 * '''`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.
    4650 * '''`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:
    … …  
    9599=== Customizing the e-mail content ===
    96100
    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:
     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:
    98102
    99103{{{
    100104$ticket_body_hdr
    101105$ticket_props
    102 #choose ticket.new
    103   #when True
     106{% choose ticket.new %}\
     107{%   when True %}\
    104108$ticket.description
    105   #end
    106   #otherwise
    107     #if changes_body
    108 Changes (by $change.author):
     109{%   end %}\
     110{%   otherwise %}\
     111{%     if changes_body %}\
     112${_('Changes (by %(author)s):', author=change.author)}
    109113
    110114$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
     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 %}\
    116120$changes_descr
    117121--
    118     #end
    119     #if change.comment
    120 
    121 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)}
    122126
    123127$change.comment
    124     #end
    125   #end
    126 #end
     128{%     end %}\
     129{%   end %}\
     130{% end %}\
    127131
    128132--
    129 Ticket URL: <$ticket.link>
     133${_('Ticket URL: <%(link)s>', link=ticket.link)}
    130134$project.name <${project.url or abs_href()}>
    131135$project.descr
    … …  
    157161}}}
    158162
     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
    159231== Using GMail as the SMTP relay host ==
    160232