Foodsoft
/
foodsoft
1
1
Fork 0
Code Issues 36 Pull Requests 5 Projects 1 Releases Wiki Activity

Add documentation for receiving mails to the README of the messages plugin

This commit is contained in:
Patrick Gansterer 2017-02-15 10:41:03 +01:00
parent ef5b5a11a2
commit 12bc5f9ab7
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
plugins/messages/README.md
View File

@ -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).