Edgewall Software

Changes between Version 85 and Version 86 of TracNotification


Ignore:
Timestamp:
Jan 4, 2015, 8:55:35 AM (7 years ago)
Author:
figaro
Comment:

Cosmetic changes (note: final link does not work)

Legend:

Unmodified
Added
Removed
Modified
  • TracNotification

    v85 v86  
    1010
    1111== Receiving Notification Mails ==
    12 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).
    13 
    14 This is useful to keep up-to-date on an issue or enhancement request that interests you.
     12When 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.
    1513
    1614=== How to use your username to receive notification mails ===
    1715
    18 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.
    19 
    20 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.
     16To 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 the ''Preferences'' page.
     17
     18Alternatively, 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.
    2119
    2220When 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`''').
     
    2422=== Ticket attachment notifications
    2523
    26 Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled.
     24Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the `TicketAttachmentNotifier` component must be disabled:
    2725{{{#!ini
    2826[components]
     
    3533
    3634=== Configuration Options ===
    37 These are the available options for the `[notification]` section in trac.ini.
     35These are the available options for the `[notification]` section in trac.ini:
    3836
    3937[[TracIni(notification)]]
     
    7068 * `prefix`: The prefix defined in `smtp_subject_prefix`.
    7169 * `summary`: The ticket summary, with the old value if the summary was edited.
    72  * `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`.
     70 * `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, eg `$ticket.milestone`.
    7371
    7472=== Customizing the e-mail content ===
    7573
    76 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:
     74The 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:
    7775
    7876{{{
     
    110108$project.descr
    111109}}}
     110
    112111== Sample Email ==
    113112{{{
     
    121120---------------------------+------------------------------------------------
    122121Changes:
    123   * component:  changset view => search system
     122  * component:  changeset view => search system
    124123  * priority:  low => highest
    125124  * owner:  jonas => anonymous
     
    136135}}}
    137136
    138 
    139137== Customizing e-mail content for MS Outlook ==
    140138
    141 Out-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].
     139MS Outlook normally presents plain text e-mails with a variable-width font, and as a result 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].
    142140
    143141Replace the following second row in the template:
     
    146144}}}
    147145
    148 with this instead (''requires Python 2.6 or later''):
     146with this (requires Python 2.6 or later):
    149147{{{
    150148--------------------------------------------------------------------------
     
    160158}}}
    161159
    162 The 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.
     160The 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.
    163161{{{#!div style="margin: 1em 1.75em; border:1px dotted"
    164162{{{#!html
     
    180178Changes:<br />
    181179<br />
    182 &nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     180&nbsp;&nbsp;* component: &nbsp;changeset view =&gt; search system<br />
    183181&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
    184182&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     
    196194}}}
    197195
    198 **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:
     196**Important**: Only those ticket fields that are listed in `sel` are part of the HTML mail. If you have defined custom ticket fields which are to be part of the mail, then they have to be added to `sel`. Example:
    199197{{{
    200198   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
    201199}}}
    202200
    203 However, 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...
    204 
     201However, the solution is still a workaround to an automatically HTML-formatted e-mail.
    205202
    206203== Using GMail as the SMTP relay host ==
    207204
    208 Use the following configuration snippet
     205Use the following configuration snippet:
    209206{{{
    210207[notification]
     
    218215}}}
    219216
    220 where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]
     217where ''user'' and ''password'' match an existing GMail account, ie the ones you use to log in on [http://gmail.com].
    221218
    222219Alternatively, you can use `smtp_port = 25`.[[br]]
    223 You should not use `smtp_port = 465`. It will not work and your ticket submission may deadlock. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details.
     220You should not use `smtp_port = 465`. Doing so may deadlock your ticket submission. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [trac:comment:2:ticket:7107 #7107] for details.
    224221 
    225222== Filtering notifications for one's own changes and comments ==
    226223In Gmail, use the filter:
    227 
    228224{{{
    229225from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
     
    232228to delete these notifications.
    233229
    234 In Thunderbird, there is no such solution if you use IMAP
    235 (see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body).
     230In Thunderbird, there is no such solution if you use IMAP, see http://kb.mozillazine.org/Filters_(Thunderbird)#Filtering_the_message_body.
    236231
    237232You can also add this plugin:
     
    242237If you cannot get the notification working, first make sure the log is activated and have a look at the log to find if an error message has been logged. See TracLogging for help about the log feature.
    243238
    244 Notification errors are not reported through the web interface, so the user who submit a change or a new ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace.
     239Notification errors are not reported through the web interface, so the user who submits a change or a new ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace.
    245240
    246241=== ''Permission denied'' error ===
     
    254249}}}
    255250
    256 This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email message to the local SMTP server.
     251This error usually comes from a security settings on the server: many Linux distributions do not allow the web server (Apache, ...) to post email messages to the local SMTP server.
    257252
    258253Many users get confused when their manual attempts to contact the SMTP server succeed:
     
    260255telnet localhost 25
    261256}}}
    262 The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
     257This is because a regular user may connect to the SMTP server, but the web server cannot:
    263258{{{
    264259sudo -u www-data telnet localhost 25
    265260}}}
    266261
    267 In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help browsing the Trac [trac:MailingList MailingList] archive.
     262In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help in the Trac [trac:MailingList MailingList] archive.
    268263
    269264Relevant ML threads:
     
    274269$ setsebool -P httpd_can_sendmail 1
    275270}}}
     271
    276272=== ''Suspected spam'' error ===
    277273
    278274Some SMTP servers may reject the notification email sent by Trac.
    279275
    280 The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' SPAM detection on sensitive email servers. In such an event, it is recommended to change the default encoding to "quoted-printable" using the `mime_encoding` option.
    281 
    282 Quoted 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.
     276The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' spam detection on sensitive email servers. In such an event, change the default encoding to "quoted-printable" using the `mime_encoding` option.
     277
     278Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.
    283279
    284280=== ''501, 5.5.4 Invalid Address'' error ===