Changes between Version 2 and Version 3 of TracNotification

Nov 18, 2014 10:44:13 PM (5 years ago)



  • TracNotification

    v2 v3  
    1919Alternatively, 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`''').
    2123== Configuring SMTP Notification ==
    2628These are the available options for the `[notification]` section in trac.ini.
    28  * '''`smtp_enabled`''': Enable email notification.
    29  * '''`smtp_from`''': Email address to use for ''Sender''-headers in notification emails.
    30  * '''`smtp_from_name`''': Sender name to use for ''Sender''-headers in notification emails.
    31  * '''`smtp_replyto`''': Email address to use for ''Reply-To''-headers in notification emails.
    32  * '''`smtp_default_domain`''': (''since 0.10'') Append the specified domain to addresses that do not contain one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found from the user settings.
    33  * '''`smtp_always_cc`''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
    34  * '''`smtp_always_bcc`''': (''since 0.10'') List of email addresses to always send notifications to, but keeps addresses not visible from other recipients of the notification email
    35  * '''`smtp_subject_prefix`''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
    36  * '''`always_notify_reporter`''':  Always send notifications to any address in the reporter field (default: false).
    37  * '''`always_notify_owner`''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
    38  * '''`always_notify_updater`''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
    39  * '''`use_public_cc`''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
    40  * '''`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.
    41  * '''`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:
    42    * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    43    * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
    44    * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered.
    45  * '''`ticket_subject_template`''': (''since 0.11'') A [ 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.
    50 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
    52 The following options are specific to email delivery through SMTP.
    53  * '''`smtp_server`''': SMTP server used for notification messages.
    54  * '''`smtp_port`''': (''since 0.9'') Port used to contact the SMTP server.
    55  * '''`smtp_user`''': (''since 0.9'') User name for authentication SMTP account.
    56  * '''`smtp_password`''': (''since 0.9'') Password for authentication SMTP account.
    57  * '''`use_tls`''': (''since 0.10'') Toggle to send notifications via a SMTP server using [ TLS], such as GMail.
    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.
    6232=== Example Configuration (SMTP) ===
    102 #choose
    103   #when True
     72{% choose %}\
     73{%   when True %}\
    105   #end
    106   #otherwise
    107     #if changes_body
    108 Changes (by $
     75{%   end %}\
     76{%   otherwise %}\
     77{%     if changes_body %}\
     78${_('Changes (by %(author)s):',}
    111     #end
    112     #if changes_descr
    113       #if not changes_body and not change.comment and
    114 Description changed by $
    115       #end
     81{%     end %}\
     82{%     if changes_descr %}\
     83{%       if not changes_body and not change.comment and %}\
     84${_('Description changed by %(author)s:',}
     85{%       end %}\
    118     #end
    119     #if change.comment
    121 Comment${not changes_body and '(by %s)' % or ''}:
     88{%     end %}\
     89{%     if change.comment %}\
     91${changes_body and _('Comment:') or _('Comment (by %(author)s):',}
    124     #end
    125   #end
    126 #end
     94{%     end %}\
     95{%   end %}\
     96{% end %}\
    129 Ticket URL: <$>
     99${_('Ticket URL: <%(link)s>',}
    130100$ <${project.url or abs_href()}>
     130== Customizing e-mail content for MS Outlook ==
     132Out-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].
     134Replace the following second row in the template:
     139with this instead (''requires Python 2.6 or later''):
     142{% with
     143   pv = [(a[0].strip(), a[1].strip()) for a in [b.split(':') for b in
     144         [c.strip() for c in
     145          ticket_props.replace('|', '\n').splitlines()[1:-1]] if ':' in b]];
     146   sel = ['Reporter', 'Owner', 'Type', 'Status', 'Priority', 'Milestone',
     147          'Component', 'Severity', 'Resolution', 'Keywords'] %}\
     148${'\n'.join('%s\t%s' % (format(p[0]+':', ' <12'), p[1]) for p in pv if p[0] in sel)}
     149{% end %}\
     153The 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.
     154{{{#!div style="margin: 1em 1.75em; border:1px dotted"
     156#42: testing<br />
     157--------------------------------------------------------------------------<br />
     158<table cellpadding=0>
     165<tr><td>Component:</td><td>report system</td></tr>
     167<tr><td>Resolution:</td><td> </td></tr>
     168<tr><td>Keywords:</td><td> </td></tr>
     170--------------------------------------------------------------------------<br />
     171Changes:<br />
     172<br />
     173&nbsp;&nbsp;* component: &nbsp;changset view =&gt; search system<br />
     174&nbsp;&nbsp;* priority: &nbsp;low =&gt; highest<br />
     175&nbsp;&nbsp;* owner: &nbsp;jonas =&gt; anonymous<br />
     176&nbsp;&nbsp;* cc: &nbsp; =&gt;<br />
     177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;,<br />
     178&nbsp;&nbsp;* status: &nbsp;new =&gt; assigned<br />
     179<br />
     180Comment:<br />
     181I'm interested too!<br />
     182<br />
     183--<br />
     184Ticket URL: &lt;;<br />
     185My Project &lt;;<br />
     189**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:
     191   sel = ['Reporter', ..., 'Keywords', 'Custom1', 'Custom2']
     194However, 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...
    159197== Using GMail as the SMTP relay host ==
    175213Alternatively, you can use `smtp_port = 25`.[[br]]
    176 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 [comment:ticket:7107:2 #7107] for details.
     214You 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.
    178 == Filtering notifications for one's own changes ==
     216== Filtering notifications for one's own changes and comments ==
    179217In Gmail, use the filter:
    181 {{{
    182 from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
    183 }}}
    185 For Trac .10, use the filter:
    187220from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
    195 The best you can do is to set "always_notify_updater" in conf/trac.ini to false.
    196 You will however still get an email if you comment a ticket that you own or have reported.
    198228You can also add this plugin:
     229, or vote for [trac:#2247] to be fixed.
    201231== Troubleshooting ==