Changes between Version 2 and Version 3 of TracNotification

Timestamp:

11/12/2010 04:58:59 PM (16 years ago)

Author:

trac

Comment:

--

TracNotification

@@ -2 +2 @@
 [[TracGuideToc]]
 
-Trac supports notification about ticket changes via email. 
+Trac supports notification of ticket changes via email. 
 
 Email 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.
@@ -9 +9 @@
 
 == Receiving Notification Mails ==
-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).
+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).
 
 This is useful to keep up-to-date on an issue or enhancement request that interests you.
 
+=== How to use your username to receive notification mails ===
+
+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. 
+
+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.
+
 == Configuring SMTP Notification ==
+
+'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini]. 
 
 === Configuration Options ===
@@ -31 +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).
  * '''`use_short_addr`''': (''since 0.10'') Enable delivery of notifications to addresses that do not contain a domain (i.e. do not end with ''@<domain.com>'').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. 
- * '''`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:
-   * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
-   * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
-   * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered. 
+ * '''`mime_encoding`''': (''since 0.10'') This option allows selecting the MIME encoding scheme. Supported values:
+   * `none`: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise. 
+   * `base64`: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
+   * `qp` or `quoted-printable`: best for european languages (more compact than base64) if 8bit encoding cannot be used.
  * '''`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.
+ * '''`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:
+   * `SmtpEmailSender`: connects to an SMTP server (default).
+   * `SendmailEmailSender`: runs a `sendmail`-compatible executable.
 
 Either '''`smtp_from`''' or '''`smtp_replyto`''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.
@@ -46 +57 @@
  * '''`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.
 
+The following option is specific to email delivery through a `sendmail`-compatible executable.
+ * '''`sendmail_path`''': (''since 0.12'') Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options.
 
 === Example Configuration (SMTP) ===
@@ -57 +70 @@
 }}}
 
+=== Example Configuration (`sendmail`) ===
+{{{
+[notification]
+smtp_enabled = true
+email_sender = SendmailEmailSender
+sendmail_path = /usr/sbin/sendmail
+smtp_from = notifier@example.com
+smtp_replyto = myproj@projects.example.com
+smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
+}}}
 
 === Customizing the e-mail subject ===
@@ -70 +93 @@
  * `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`.
 
+=== Customizing the e-mail content ===
+
+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:
+
+{{{
+$ticket_body_hdr
+$ticket_props
+#choose ticket.new
+  #when True
+$ticket.description
+  #end
+  #otherwise
+    #if changes_body
+Changes (by $change.author):
+
+$changes_body
+    #end
+    #if changes_descr
+      #if not changes_body and not change.comment and change.author
+Description changed by $change.author:
+      #end
+$changes_descr
+--
+    #end
+    #if change.comment
+
+Comment${not changes_body and '(by %s)' % change.author or ''}:
+
+$change.comment
+    #end
+  #end
+#end
+
+-- 
+Ticket URL: <$ticket.link>
+$project.name <${project.url or abs_href()}>
+$project.descr
+}}}
 == Sample Email ==
 {{{
@@ -122 +183 @@
 }}}
 
+For Trac .10, use the filter:
+{{{
+from:(<smtp_from>) (("Reporter: <username>" -Changes -Comment) OR "Changes (by <username>)" OR "Comment (by <username>)")
+}}}
+
 to delete these notifications.
 
@@ -164 +230 @@
 Relevant ML threads:
  * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
- 
+
+For SELinux in Fedora 10:
+{{{
+$ setsebool -P httpd_can_sendmail 1
+}}}
 === ''Suspected spam'' error ===
 
@@ -172 +242 @@
 
 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.
+
+=== ''501, 5.5.4 Invalid Address'' error ===
+
+On IIS 6.0 you could get a 
+{{{
+Failure sending notification on change to ticket #1: SMTPHeloError: (501, '5.5.4 Invalid Address')
+}}}
+in the trac log. Have a look [http://support.microsoft.com/kb/291828 here] for instructions on resolving it.
+
 
 ----