Changes between Version 4 and Version 5 of TracNotification


Ignore:
Timestamp:
Aug 3, 2021, 7:27:01 PM (7 weeks 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 of ticket changes via email.
    55
    66Email notification is useful to keep users up-to-date on tickets of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list.
     
    99
    1010== Receiving Notification Mails
    11 When reporting a new ticket or adding a comment, enter a valid email address or your Trac 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 or your Trac username in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac may send you an email when changes are made to the ticket, depending on how your notification preferences are configured.
     12
     13Permission groups can also be entered in the CC field,
     14to notify all members of the group.
    1215
    1316=== How to use your username to receive notification mails
    1417
    15 To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your [/prefs preferences]. 
     18To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your [/prefs preferences].
    1619
    1720Alternatively, 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.
     
    2932== Configuring SMTP Notification
    3033
    31 '''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated. 
     34'''Important:''' The [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured for links in the notification message to be correctly generated.
    3235
    3336=== Configuration Options
     
    98101}}}
    99102
    100 === Customizing the e-mail subject
    101 The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is:
     103=== Customizing the email subject
     104The email subject can be customized with the `ticket_subject_template` option, which contains a [https://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is:
    102105{{{#!genshi
    103106${prefix} #${ticket.id}: ${summary}
     
    105108The following variables are available in the template:
    106109
    107  * `env`: The project environment object (see [trac:source:/trunk/trac/env.py env.py]).
     110 * `changes`: The ticket changes (prepared by [trac:source:/branches/1.4-stable/trac/ticket/model.py Ticket.get_change]).
     111 * `env`: The project environment (see [trac:source:/branches/1.4-stable/trac/env.py env.py]).
    108112 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    109113 * `summary`: The ticket summary, with the old value if the summary was edited.
    110  * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be accessed by appending the field name separated by a dot, eg `${ticket.milestone}`.
    111 
    112 === Customizing the e-mail content
    113 
    114 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 is:
    115 
    116 {{{#!genshi
     114 * `ticket`: The ticket model object (see [trac:source:/branches/1.4-stable/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `${ticket.milestone}`.
     115
     116=== Customizing the email content #CustomizingContent
     117
     118The notification email 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 is:
     119
     120{{{#!jinja
    117121${ticket_body_hdr}
    118122${ticket_props}
     
    140144#   endif
    141145# endif
    142 --
     146${'-- '}
    143147${_('Ticket URL: <%(link)s>', link=ticket.link)}
    144148${project.name} <${project.url or abs_href()}>
     
    152156#42: testing
    153157---------------------------+------------------------------------------------
    154        Id:  42             |      Status:  assigned               
     158       Id:  42             |      Status:  assigned
    155159Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
    156  Severity:  major          |   Milestone:  0.9                     
    157  Priority:  lowest         |     Version:  0.6                     
    158     Owner:  anonymous      |    Reporter:  jonas@example.com               
     160 Severity:  major          |   Milestone:  0.9
     161 Priority:  lowest         |     Version:  0.6
     162    Owner:  anonymous      |    Reporter:  jonas@example.com
    159163---------------------------+------------------------------------------------
    160164Changes:
     
    188192}}}
    189193
    190 where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
     194where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [https://gmail.com].
    191195
    192196Alternatively, you can use `smtp_port = 25`.[[br]]