Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
Apr 13, 2010, 3:53:03 AM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v4 v5  
    22[[TracGuideToc]]
    33
    4 Trac supports notification of ticket changes via email.
     4Trac supports notification about ticket changes via email.
    55
    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 [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list is set up.
     
    99
    1010== Receiving Notification Mails ==
    11 When 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).
     11When 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).
    1212
    1313This is useful to keep up-to-date on an issue or enhancement request that interests you.
    1414
    15 === How to use your username to receive notification mails ===
    16 
    17 To 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.
    18 
    19 Alternatively, 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 
    2115== Configuring SMTP Notification ==
    22 
    23 '''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini].
    2416
    2517=== Configuration Options ===
     
    4436   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
    4537 * '''`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.
    46  * '''`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:
    47    * `SmtpEmailSender`: connects to an SMTP server (default).
    48    * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
    4938
    5039Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
     
    5746 * '''`use_tls`''': (''since 0.10'') Toggle to send notifications via a SMTP server using [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS], such as GMail.
    5847
    59 The following option is specific to email delivery through a `sendmail`-compatible executable.
    60  * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
    6148
    6249=== Example Configuration (SMTP) ===
     
    7057}}}
    7158
    72 === Example Configuration (`sendmail`) ===
    73 {{{
    74 [notification]
    75 smtp_enabled = true
    76 email_sender = SendmailEmailSender
    77 sendmail_path = /usr/sbin/sendmail
    78 smtp_from = notifier@example.com
    79 smtp_replyto = myproj@projects.example.com
    80 smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
    81 }}}
    8259
    8360=== Customizing the e-mail subject ===
     
    9370 * `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`.
    9471
    95 === Customizing the e-mail content ===
    96 
    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:
    98 
    99 {{{
    100 $ticket_body_hdr
    101 $ticket_props
    102 #choose ticket.new
    103   #when True
    104 $ticket.description
    105   #end
    106   #otherwise
    107     #if changes_body
    108 Changes (by $change.author):
    109 
    110 $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
    116 $changes_descr
    117 --
    118     #end
    119     #if change.comment
    120 
    121 Comment${not changes_body and '(by %s)' % change.author or ''}:
    122 
    123 $change.comment
    124     #end
    125   #end
    126 #end
    127 
    128 --
    129 Ticket URL: <$ticket.link>
    130 $project.name <${project.url or abs_href()}>
    131 $project.descr
    132 }}}
    13372== Sample Email ==
    13473{{{
     
    183122}}}
    184123
    185 For Trac .10, use the filter:
    186 {{{
    187 from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    188 }}}
    189 
    190124to delete these notifications.
    191125
     
    230164Relevant ML threads:
    231165 * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
    232 
    233 For SELinux in Fedora 10:
    234 {{{
    235 $ setsebool -P httpd_can_sendmail 1
    236 }}}
     166 
    237167=== ''Suspected spam'' error ===
    238168
     
    243173Quoted 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.
    244174
    245 === ''501, 5.5.4 Invalid Address'' error ===
    246 
    247 On IIS 6.0 you could get a
    248 {{{
    249 Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
    250 }}}
    251 in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
    252 
    253 
    254175----
    255176See also: TracTickets, TracIni, TracGuide

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png