diff development.ini @ 5366:ce72c36f7a0e

e-mail: add documentation about configuration settings Document e-mail related configuration settings in the documentation (overview) and the .ini file itself (technical details and example settings).
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Thu, 16 Jul 2015 17:40:35 +0200
parents ef64905223f5
children 4610a39d3be9
line wrap: on
line diff
--- a/development.ini	Thu Jul 16 17:40:35 2015 +0200
+++ b/development.ini	Thu Jul 16 17:40:35 2015 +0200
@@ -16,30 +16,55 @@
 pdebug = false
 
 ################################################################################
-## Uncomment and replace with the address which should receive                ##
-## any error reports after application crash                                  ##
-## Additionally those settings will be used by Kallithea mailing system       ##
+## E-mail settings                                                            ##
+##                                                                            ##
+## Refer to the documentation ("E-mail settings") for more details.           ##
+##                                                                            ##
+## It is recommended to use a valid sender address that passes access         ##
+## validation and spam filtering in mail servers.                             ##
 ################################################################################
+
+## 'From' header for application e-mails. You can optionally add a name.
+## Default:
 #app_email_from = Kallithea
+## Examples:
 #app_email_from = Kallithea <kallithea-noreply@example.com>
 #app_email_from = kallithea-noreply@example.com
+
+## Subject prefix for application e-mails.
+## A space between this prefix and the real subject is automatically added.
+## Default:
 #email_prefix =
+## Example:
 #email_prefix = [Kallithea]
 
-#email_to = admin@localhost
+## Recipients for error e-mails and fallback recipients of application mails.
+## Multiple addresses can be specified, space-separated.
+## Only addresses are allowed, do not add any name part.
+## Default:
+#email_to =
+## Examples:
 #email_to = admin@example.com
 #email_to = admin@example.com another_admin@example.com
+
+## 'From' header for error e-mails. You can optionally add a name.
+## Default:
 #error_email_from = pylons@yourapp.com
+## Examples:
 #error_email_from = Kallithea Errors <kallithea-noreply@example.com>
 #error_email_from = paste_error@example.com
 
+## SMTP server settings
+## Only smtp_server is mandatory. All other settings take the specified default
+## values.
 #smtp_server = mail.server.com
 #smtp_username =
 #smtp_password =
 #smtp_port = 25
 #smtp_use_tls = false
 #smtp_use_ssl = false
-## Specify available auth parameters here (e.g. LOGIN PLAIN CRAM-MD5, etc.)
+## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).
+## If empty, use any of the authentication parameters supported by the server.
 #smtp_auth =
 
 [server:main]