Changes between Version 2 and Version 3 of TracNotification


Ignore:
Timestamp:
Jun 8, 2011, 7:42:05 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v2 v3  
    22[[TracGuideToc]]
    33
     4[[PageOutline]]
     5
    46Trac supports notification about ticket changes via email.
    57
     
    911
    1012== 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).
     13When 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).
    1214
    1315This is useful to keep up-to-date on an issue or enhancement request that interests you.
    1416
     17=== How to use your username to receive notification mails ===
     18
     19To 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.
     20
     21Alternatively, 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
    1523== Configuring SMTP Notification ==
     24
     25'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    1626
    1727=== Configuration Options ===
     
    7080 * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, e.g. `$ticket.milestone`.
    7181
     82=== Customizing the e-mail content ===
     83
     84The 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:
     85
     86{{{
     87$ticket_body_hdr
     88$ticket_props
     89#choose ticket.new
     90  #when True
     91$ticket.description
     92  #end
     93  #otherwise
     94    #if changes_body
     95Changes (by $change.author):
     96
     97$changes_body
     98    #end
     99    #if changes_descr
     100      #if not changes_body and not change.comment and change.author
     101Description changed by $change.author:
     102      #end
     103$changes_descr
     104--
     105    #end
     106    #if change.comment
     107
     108Comment${not changes_body and '(by %s)' % change.author or ''}:
     109
     110$change.comment
     111    #end
     112  #end
     113#end
     114
     115--
     116Ticket URL: <$ticket.link>
     117$project.name <${project.url or abs_href()}>
     118$project.descr
     119}}}
    72120== Sample Email ==
    73121{{{
     
    122170}}}
    123171
     172For Trac .10, use the filter:
     173{{{
     174from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     175}}}
     176
    124177to delete these notifications.
    125178
     
    164217Relevant ML threads:
    165218 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    166  
     219
     220For SELinux in Fedora 10:
     221{{{
     222$ setsebool -P httpd_can_sendmail 1
     223}}}
    167224=== ''Suspected spam'' error ===
    168225
     
    172229
    173230Quoted 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.
     231
     232=== ''501, 5.5.4 Invalid Address'' error ===
     233
     234On IIS 6.0 you could get a
     235{{{
     236Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
     237}}}
     238in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
     239
    174240
    175241----