From 12bc5f9ab76249a176d60cbc531af9463e849347 Mon Sep 17 00:00:00 2001 From: Patrick Gansterer Date: Wed, 15 Feb 2017 10:41:03 +0100 Subject: [PATCH] Add documentation for receiving mails to the README of the messages plugin --- plugins/messages/README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/plugins/messages/README.md b/plugins/messages/README.md index fd289467..15078891 100644 --- a/plugins/messages/README.md +++ b/plugins/messages/README.md @@ -14,9 +14,14 @@ gem 'foodsoft_messages', path: 'lib/foodsoft_messages' This plugin introduces the foodcoop config option `use_messages`, which can be set to `false` to disable messages. May be useful in multicoop deployments. -To allow members to respond to messages via email, see the config option -`reply_email_domain` and the rake task `foodsoft:parse_reply_email`. We need to -add some documentation on setting it up, though. +To allow members to respond to messages via email, you need the set the config +option `reply_email_domain` and handle incoming mails via one of the following +rake tasks. `foodsoft:reply_email_smtp_server` starts an SMTP server on the +port given via the environment variable `PORT` and listens until a shutdown +signal is received. If there is already a SMTP server for handling incoming +mails you can also feed every mail via a call to `foodsoft:parse_reply_email` +into foodsoft. It expects the address given in the `MAIL FROM` command via +SMTP in the environment variable `RECIPIENT` and the mail body as `STDIN`. This plugin is part of the foodsoft package and uses the GPL-3 license (see foodsoft's LICENSE for the full license text).