Changeset - e223c36e5b68
[Not reviewed]
default
0 1 0
Thomas De Schampheleire - 9 years ago 2017-01-27 20:47:10
thomas.de.schampheleire@gmail.com
docs: update email documentation for TurboGears2

Small update to the documentation.
1 file changed with 2 insertions and 3 deletions:
0 comments (0 inline, 0 general)
docs/usage/email.rst
Show inline comments
 
@@ -67,27 +67,26 @@ where ``<type>`` is one of:
 
- ``pull_request``: you are invited as reviewer in a pull request
 
- ``pull_request_comment``: a comment was given on a pull request
 
- ``cs_comment``: a comment was given on a changeset
 
- ``registration``: a new user was registered
 
- ``message``: another type of email
 

	
 

	
 
Error emails
 
------------
 

	
 
When an exception occurs in Kallithea -- and unless interactive debugging is
 
enabled using ``set debug = true`` in the ``[app:main]`` section of the
 
configuration file -- an email with exception details is sent by WebError_'s
 
``ErrorMiddleware`` to the addresses specified in ``email_to`` in the
 
configuration file.
 
configuration file -- an email with exception details is sent by backlash_
 
to the addresses specified in ``email_to`` in the configuration file.
 

	
 
Recipients will see these emails originating from the sender specified in the
 
``error_email_from`` setting in the configuration file. This setting can either
 
contain only an email address, like `kallithea-noreply@example.com`, or both
 
a name and an address in the following format: `Kallithea Errors
 
<kallithea-noreply@example.com>`.
 

	
 
*Note:* The WebError_ package does not respect ``smtp_port`` and assumes the
 
standard SMTP port (25). If you have a remote SMTP server with a different port,
 
you could set up a local forwarding SMTP server on port 25.
 

	
 

	
0 comments (0 inline, 0 general)