tracnotification
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | tracnotification [2015/06/09 15:23] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Email Notification of Ticket Changes ====== | ||
+ | [[: | ||
+ | |||
+ | Trac supports notification about ticket changes via email. | ||
+ | |||
+ | Email notification is useful to keep users up-to-date on tickets/ | ||
+ | |||
+ | Disabled by default, notification can be activated and configured in [[: | ||
+ | |||
+ | ===== Receiving Notification Mails ===== | ||
+ | When reporting a new ticket or adding a comment, enter a valid email address in the // | ||
+ | |||
+ | This is useful to keep up-to-date on an issue or enhancement request that interests you. | ||
+ | |||
+ | ===== Configuring SMTP Notification ===== | ||
+ | |||
+ | ==== Configuration Options ==== | ||
+ | These are the available options for the // | ||
+ | * **smtp_enabled**: | ||
+ | * **smtp_server**: | ||
+ | * **smtp_user**: | ||
+ | * **smtp_password**: | ||
+ | * **smtp_from**: | ||
+ | * **smtp_replyto**: | ||
+ | * **smtp_default_domain**: | ||
+ | * **smtp_always_cc**: | ||
+ | * **smtp_always_bcc**: | ||
+ | * **always_notify_reporter**: | ||
+ | * **always_notify_owner**: | ||
+ | * **always_notify_updater**: | ||
+ | * **use_public_cc**: | ||
+ | * **use_short_addr**: | ||
+ | * **mime_encoding**: | ||
+ | * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/ | ||
+ | * `qp` or `quoted-printable`: | ||
+ | * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered. | ||
+ | |||
+ | Either **smtp_from** or **smtp_replyto** (or both) //must// be set, otherwise Trac refuses to send notification mails. | ||
+ | |||
+ | ==== Example Configuration ==== | ||
+ | |||
+ | < | ||
+ | [[: | ||
+ | smtp_enabled = true | ||
+ | smtp_server = mail.example.com | ||
+ | smtp_from = notifier@example.com | ||
+ | smtp_replyto = myproj@projects.example.com | ||
+ | smtp_always_cc = ticketmaster@example.com, | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== Sample Email ===== | ||
+ | < | ||
+ | #42: testing | ||
+ | ---------------------------+------------------------------------------------ | ||
+ | | ||
+ | Component: | ||
+ | | ||
+ | | ||
+ | Owner: | ||
+ | ---------------------------+------------------------------------------------ | ||
+ | Changes: | ||
+ | * component: | ||
+ | * priority: | ||
+ | * owner: | ||
+ | * cc: daniel@example.com => | ||
+ | | ||
+ | * status: | ||
+ | |||
+ | Comment: | ||
+ | I'm interested too! | ||
+ | |||
+ | -- | ||
+ | Ticket URL: < | ||
+ | My Project < | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== Troubleshooting ===== | ||
+ | |||
+ | If 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. | ||
+ | |||
+ | 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. | ||
+ | |||
+ | ==== // | ||
+ | |||
+ | Typical error message: | ||
+ | < | ||
+ | ... | ||
+ | File " | ||
+ | raise socket.error, | ||
+ | error: (13, ' | ||
+ | </ | ||
+ | |||
+ | |||
+ | 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. | ||
+ | |||
+ | Many users get confused when their manual attempts to contact the SMTP server succeed: | ||
+ | < | ||
+ | telnet localhost 25 | ||
+ | </ | ||
+ | |||
+ | The trouble is that a regular user may connect to the SMTP server, but the web server cannot: | ||
+ | < | ||
+ | sudo -u www-data telnet localhost 25 | ||
+ | </ | ||
+ | |||
+ | |||
+ | In such a case, you need to configure your server so that the web server is authorize 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 MailingList archive. | ||
+ | |||
+ | Relevant ML threads: | ||
+ | * SELinux: http:// | ||
+ | |||
+ | ==== //Suspected spam// error ==== | ||
+ | |||
+ | Some SMTP servers may reject the notification email sent by Trac. | ||
+ | |||
+ | 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 enconding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding. | ||
+ | |||
+ | ---- | ||
+ | See also: TracTickets, | ||
tracnotification.txt · Last modified: 2015/06/09 15:23 by 127.0.0.1