Changes between Version 1 and Version 2 of TracNotification

Apr 22, 2012, 12:10:20 PM (9 years ago)



  • TracNotification

    v1 v2  
    4 Trac supports notification about ticket changes via email.
     4Trac supports notification of ticket changes via email.
    66Email 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 [ Trac-tickets] mailing list is set up.
    1010== Receiving Notification Mails ==
    11 When reporting a new ticket or adding a comment, enter a valid email address in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket (depending on how notification is configured).
     11When reporting a new ticket or adding a comment, enter a valid email address or your username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket (depending on how notification is configured).
    1313This is useful to keep up-to-date on an issue or enhancement request that interests you.
     15=== How to use your username to receive notification mails ===
     17To receive notification mails, you can either enter a full email address or your username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page.
     19Alternatively, 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.
     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`''').
    1523== Configuring SMTP Notification ==
     25'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    1727=== Configuration Options ===
    3141 * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    3242 * '''`use_short_addr`''': (''since 0.10'') Enable delivery of notifications to addresses that do not contain a domain (i.e. do not end with ''@<>'').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.
    33  * '''`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:
    34    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    35    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    36    * `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.
    3748 * '''`ticket_subject_template`''': (''since 0.11'') A [ 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.   
    3953Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    4660 * '''`use_tls`''': (''since 0.10'') Toggle to send notifications via a SMTP server using [ TLS], such as GMail.
     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.
    4965=== Example Configuration (SMTP) ===
     75=== Example Configuration (`sendmail`) ===
     78smtp_enabled = true
     79email_sender = SendmailEmailSender
     80sendmail_path = /usr/sbin/sendmail
     81smtp_from =
     82smtp_replyto =
     83smtp_always_cc =,
    6086=== Customizing the e-mail subject ===
    7096 * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/]). Individual ticket fields can be addressed by appending the field name separated by a dot, e.g. `$ticket.milestone`.
     98=== Customizing the e-mail content ===
     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:
     105{% choose %}\
     106{%   when True %}\
     108{%   end %}\
     109{%   otherwise %}\
     110{%     if changes_body %}\
     111${_('Changes (by %(author)s):',}
     114{%     end %}\
     115{%     if changes_descr %}\
     116{%       if not changes_body and not change.comment and %}\
     117${_('Description changed by %(author)s:',}
     118{%       end %}\
     121{%     end %}\
     122{%     if change.comment %}\
     124${changes_body and _('Comment:') or _('Comment (by %(author)s):',}
     127{%     end %}\
     128{%   end %}\
     129{% end %}\
     132${_('Ticket URL: <%(link)s>',}
     133$ <${project.url or abs_href()}>
    72136== Sample Email ==
     163== Customizing e-mail content for MS Outlook ==
     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].
     167Replace the following second row in the template:
     172with this instead:
     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 %}\
     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"
     189#42: testing<br />
     190--------------------------------------------------------------------------<br />
     191<table cellpadding=0>
     198<tr><td>Component:</td><td>report system</td></tr>
     200<tr><td>Resolution:</td><td> </td></tr>
     201<tr><td>Keywords:</td><td> </td></tr>
     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; =&gt;<br />
     210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;,<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;;<br />
     218My Project &lt;;<br />
     222However, it's not as perfect as an HTML formatted e-mail would be, but presented ticket properties are at least readable...
    98225== Using GMail as the SMTP relay host ==
     251For Trac .10, use the filter:
     253from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    124256to delete these notifications.
    164296Relevant ML threads:
    165297 * SELinux:
     299For SELinux in Fedora 10:
     301$ setsebool -P httpd_can_sendmail 1
    167303=== ''Suspected spam'' error ===
    173309Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding.
     311=== ''501, 5.5.4 Invalid Address'' error ===
     313On IIS 6.0 you could get a
     315Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
     317in the trac log. Have a look [ here] for instructions on resolving it.