Legend:

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.

7

8

Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].

9

10

== Receiving Notification Mails ==

11

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).

12

13

This is useful to keep up-to-date on an issue or enhancement request that interests you.

14

15

== Configuring SMTP Notification ==

16

17

=== Configuration Options ===

18

These are the available options for the ''[notification]'' section in trac.ini.

* '''smtp_from''': Email address to use for ''Sender''-headers in notification emails.

25

* '''smtp_from_name''': Sender name to use for ''Sender''-headers in notification emails.

26

* '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.

27

* '''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.

* '''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.

where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]

96

97

Alternatively, you can use `smtp_port = 25`.[[br]]

98

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.

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.

112

113

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.

114

115

=== ''Permission denied'' error ===

116

117

Typical error message:

118

{{{

119

...

120

File ".../smtplib.py", line 303, in connect

121

raise socket.error, msg

122

error: (13, 'Permission denied')

123

}}}

124

125

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.

126

127

Many users get confused when their manual attempts to contact the SMTP server succeed:

128

{{{

129

telnet localhost 25

130

}}}

131

The trouble is that a regular user may connect to the SMTP server, but the web server cannot:

132

{{{

133

sudo -u www-data telnet localhost 25

134

}}}

135

136

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.

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.

146

147

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.