aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLouise Crow <louise.crow@gmail.com>2014-08-08 16:04:36 +0100
committerLouise Crow <louise.crow@gmail.com>2014-08-08 16:08:05 +0100
commit44ec8967fca38d9f0064e245ac82d23651b17e0b (patch)
treef4da4393431d7a4ea925c104fd6638ebd6737a6a /docs
parent40cc4bf5bdf810c57d180b46ed8717f087a12cfe (diff)
Wrap
Diffstat (limited to 'docs')
-rw-r--r--docs/installing/email.md44
1 files changed, 37 insertions, 7 deletions
diff --git a/docs/installing/email.md b/docs/installing/email.md
index 9d103cc66..d52b30823 100644
--- a/docs/installing/email.md
+++ b/docs/installing/email.md
@@ -42,16 +42,44 @@ a backup copy of the email sent to the special Alaveteli addresses in a separate
### Other mail
-Alaveteli also sends other kinds of mail - emails to users about their requests, letting them know when someone has replied to them, or prompting them to take further action, and emails to users who have subscribed to updates from the site, also known as `tracks`, letting them know that there is something new of interest to them on the site. The addresses that these messages come from can be configured with the [`CONTACT_EMAIL`]({{site.baseurl}}docs/customising/config/#contact_email) and [`TRACK_SENDER_EMAIL`]({{site.baseurl}}docs/customising/config/#track_sender_email) options in `config/general.yml` respectively:
+Alaveteli also sends other kinds of mail - emails to users about their
+requests, letting them know when someone has replied to them, or
+prompting them to take further action, and emails to users who have
+subscribed to updates from the site, also known as `tracks`, letting
+them know that there is something new of interest to them on the site.
+The addresses that these messages come from can be configured with the
+[`CONTACT_EMAIL`]({{site.baseurl}}docs/customising/config/#contact_email)
+and [`TRACK_SENDER_EMAIL`]({{site.baseurl}}docs/customising/config/#track_sender_email) options in
+`config/general.yml` respectively:
CONTACT_EMAIL = 'team@example.com'
TRACK_SENDER_EMAIL = 'team@example.com'
-The address in [`CONTACT_EMAIL`]({{ site.baseurl }}docs/customising/config/#contact_email) is also visible in various places on the site, so people can get in touch with the team that runs the site. Your MTA needs to be configured to deliver mail to these addresses to the people who are going to administer your site, so that they can handle it. Optionally, Alaveteli can also be configured so that emails to these addresses are filtered through a script, `script/handle-mail-replies`, that handles <a href="{{ site.baseurl }}docs/glossary/#bounce-message">bounce messages</a> for temporary and permanent delivery problems and 'out of office' notifications and forwards other mails to your administrators. This script will also prevent any further track emails being sent to a user email address that appears to have a permanent delivery problem.
-
-If you want to make use of this automatic bounce-message handling, then set the [`TRACK_SENDER_EMAIL`]({{ site.baseurl }}docs/customising/config/#track_sender_email) and [`CONTACT_EMAIL`]({{ site.baseurl }}docs/customising/config/#contact_email) address to one that you will filter through `script/handle-mail-replies` (see the MTA-specific instructions for how to do this for exim and [postfix]({{ site.baseurl }}docs/installing/email#filter-incoming-messages-to-site-admin-addresses)). Messages that are not bounces or out-of-office autoreplies will be forwarded to [`FORWARD_NONBOUNCE_RESPONSES_TO`]({{ site.baseurl }}docs/customising/config/#forward_nonbounce_responses_to), which you should set to a mail alias that points at your list of site administrators.
-
-Note that this bounce handling is not applied to request email addresses; any bounce messages from authorities will be added to the request page so that the user can see what has happened and ask site admins for help redelivering the request if necessary.
+The address in [`CONTACT_EMAIL`]({{ site.baseurl }}docs/customising/config/#contact_email) is also visible in various
+places on the site, so people can get in touch with the team that runs
+the site. Your MTA needs to be configured to deliver mail to these
+addresses to the people who are going to administer your site, so that
+they can handle it. Optionally, Alaveteli can also be configured so that
+emails to these addresses are filtered through a script,
+`script/handle-mail-replies`, that handles <a href="{{ site.baseurl }}docs/glossary/#bounce-message">bounce messages</a> for temporary and permanent
+delivery problems and 'out of office' notifications and forwards other
+mails to your administrators. This script will also prevent any further
+track emails being sent to a user email address that appears to have a
+permanent delivery problem.
+
+If you want to make use of this automatic bounce-message handling, then
+set the [`TRACK_SENDER_EMAIL`]({{ site.baseurl }}docs/customising/config/#track_sender_email) and [`CONTACT_EMAIL`]({{ site.baseurl }}docs/customising/config/#contact_email) address to one
+that you will filter through `script/handle-mail-replies` (see the
+MTA-specific instructions for how to do this for exim and [postfix]({{ site.baseurl }}docs/installing/email#filter-incoming-messages-to-site-admin-addresses)).
+Messages that are not bounces or out-of-office autoreplies will be
+forwarded to [`FORWARD_NONBOUNCE_RESPONSES_TO`]({{ site.baseurl }}docs/customising/config/#forward_nonbounce_responses_to), which you
+should set to a mail alias that points at your list of site
+administrators.
+
+Note that this bounce handling is not applied to request email
+addresses; any bounce messages from authorities will be added to the
+request page so that the user can see what has happened and ask site
+admins for help redelivering the request if necessary.
Make sure you follow the correct instructions for the specific MTA you're using:
@@ -157,7 +185,9 @@ add a new line to `/etc/postfix/master.cf`:
alaveteli_replies unix - n n - 50 pipe
flags=R user=alaveteli argv=/var/www/alaveteli/script/handle-mail-replies
-making sure to replace `/var/www/alaveteli` with the correct path to alaveteli if you're not running it from `/var/www/alaveteli`. Next, add a line to `/etc/postfix/transports`:
+making sure to replace `/var/www/alaveteli` with the correct path to
+alaveteli if you're not running it from `/var/www/alaveteli`. Next, add
+a line to `/etc/postfix/transports`:
/^team@*/ alaveteli_replies