diff docs/usage/email.rst @ 5455:c935bcaf7086

email: send comment and pullrequest mails with the author's name in 'From' When emails are sent for comments and pullrequest invitations, set the From header to: Author's Name (no-reply) <generic email address> Using the name of the person that causes the email, makes the emails more useful and interpretable for the recipient of the emails. To avoid replies directly to the author, triggering an 'offline' email discussion that is not visible in the Kallithea interface, a generic 'no-reply' email address is used instead of the author's email address. This approach is assumed to be accepted by spam filters, as several other web services are using the same approach. The sender used for other email types, e.g. password reset mails, is untouched and remains the value configured in app_email_from. The sender used for the SMTP envelope is untouched as well. Based on code by Cedric De Herdt.
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Thu, 27 Aug 2015 22:19:39 +0200
parents fbbe80e3322b
children a5ad2900985b ea9342f8d46b
line wrap: on
line diff
--- a/docs/usage/email.rst	Sat Aug 15 21:41:03 2015 +0200
+++ b/docs/usage/email.rst	Thu Aug 27 22:19:39 2015 +0200
@@ -39,9 +39,14 @@
 ``app_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
-<kallithea-noreply@example.com>`. The subject of these emails can
-optionally be prefixed with the value of ``email_prefix`` in the configuration
-file.
+<kallithea-noreply@example.com>`. However, if the email is sent due to an
+action of a particular user, for example when a comment is given or a pull
+request created, the name of that user will be combined with the email address
+specified in ``app_email_from`` to form the sender (and any name part in that
+configuration setting disregarded).
+
+The subject of these emails can optionally be prefixed with the value of
+``email_prefix`` in the configuration file.
 
 
 Error emails