Edgewall Software

Changes between Version 5 and Version 6 of 0.12/TracNotification


Ignore:
Timestamp:
Jul 16, 2012, 9:16:12 PM (10 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracNotification

    v5 v6  
    1 ** Note: this page was used to prepare the 0.12 version of wiki:/TracNotification, see now directly that toplevel page **
     1** Note: this page documents the 0.12 version of Trac, see [[0.11/TracNotification]] if you need the previous version **
    22= Email Notification of Ticket Changes =
    33[[TracGuideToc]]
     4[[TranslatedPages]]
    45
    56Trac supports notification of ticket changes via email.
     
    1920
    2021Alternatively, 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.
     22
     23When 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`''').
    2124
    2225== Configuring SMTP Notification ==
     
    4043 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    4144 * '''`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.
    42  * '''`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:
    43    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    44    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    45    * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
     45 * '''`ignore_domains`''': Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).
     46 * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values:
     47   * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.
     48   * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
     49   * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used.
    4650 * '''`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.
    4751 * '''`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:
    4852   * `SmtpEmailSender`: connects to an SMTP server (default).
    49    * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
     53   * `SendmailEmailSender`: runs a `sendmail`-compatible executable.   
    5054
    5155Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
     
    96100=== Customizing the e-mail content ===
    97101
    98 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:
     102The 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:
    99103
    100104{{{
     
    158162}}}
    159163
     164
     165== Customizing e-mail content for MS Outlook ==
     166
     167Out-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].
     168
     169Replace the following second row in the template:
     170{{{
     171$ticket_props
     172}}}
     173
     174with this instead (''requires Python 2.6 or later''):
     175{{{
     176--------------------------------------------------------------------------
     177{% with
     178   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     179         [c.strip() for c in
     180          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     181   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     182          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     183${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     184{% end %}\
     185--------------------------------------------------------------------------
     186}}}
     187
     188The 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.
     189{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     190{{{#!html
     191#42: testing<br />
     192--------------------------------------------------------------------------<br />
     193<table cellpadding=0>
     194<tr><td>Reporter:</td><td>jonas@example.com</td></tr>
     195<tr><td>Owner:</td><td>anonymous</td></tr>
     196<tr><td>Type:</td><td>defect</td></tr>
     197<tr><td>Status:</td><td>assigned</td></tr>
     198<tr><td>Priority:</td><td>lowest</td></tr>
     199<tr><td>Milestone:</td><td>0.9</td></tr>
     200<tr><td>Component:</td><td>report system</td></tr>
     201<tr><td>Severity:</td><td>major</td></tr>
     202<tr><td>Resolution:</td><td> </td></tr>
     203<tr><td>Keywords:</td><td> </td></tr>
     204</table>
     205--------------------------------------------------------------------------<br />
     206Changes:<br />
     207<br />
     208&nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     209&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     210&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     211&nbsp;&nbsp;* cc: &nbsp;daniel@example.com =&gt;<br />
     212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;daniel@example.com, jonas@example.com<br />
     213&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     214<br />
     215Comment:<br />
     216I'm interested too!<br />
     217<br />
     218--<br />
     219Ticket URL: &lt;http://example.com/trac/ticket/42&gt;<br />
     220My Project &lt;http://myproj.example.com/&gt;<br />
     221}}}
     222}}}
     223
     224**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:
     225{{{
     226   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     227}}}
     228
     229However, 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...
     230
     231
    160232== Using GMail as the SMTP relay host ==
    161233
     
    254326
    255327----
    256 See also: TracTickets, TracIni, TracGuide
     328See also: TracTickets, TracIni, TracGuide, TracDev/NotificationApi