Skip to content

Commit 9627ecb

Browse files
namangupta01jywarren
authored andcommitted
Documentation for the reply-by-email to comment feature (#2774)
* Added documentation for the reply-by-email to comment feature * Added documentation for the reply-by-email to comment feature * Added documentation for the reply-by-email to comment feature * Added documentation for the reply-by-email to comment feature
1 parent e977a34 commit 9627ecb

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,20 @@ Secure connection is needed for OAuth authentication etc.
8080
5. To see the installed list of cron jobs use command `crontab -l`
8181
6. For more details about this gem, visit the official repository of whenever gem.
8282

83+
***
84+
8385
### Bundle exec
8486

8587
For some, it will be necessary to prepend your gem-related commands with `bundle exec`, for example, `bundle exec passenger start`; adding `bundle exec` ensures you're using the version of passenger you just installed with Bundler. `bundle exec rake db: setup`, `bundle exec rake db: seed` are other examples of where this might be necessary.
8688

8789
***
8890

91+
### Reply-by-email
92+
93+
Public Lab now supports reply by email to comment feature. For more details regarding it go to the [email documentation](https://github.com/publiclab/plots2/blob/master/doc/EMAIL.md)
94+
95+
***
96+
8997
## Bugs and support
9098

9199
To report bugs and request features, please use the GitHub issue tracker provided at https://github.com/publiclab/plots2/issues

doc/EMAIL.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## How to start reply by email to comment feature
2+
3+
With the merge of [#2669](https://github.com/publiclab/plots2/pull/2669) Public lab now supports Reply-by-email to comment features to the various nodes. For implementing this feature we have used `mailman` gem which is a microframework for processing incoming email. More details about this can be found at [mailman](https://github.com/mailman/mailman).
4+
5+
[This](https://github.com/publiclab/plots2/blob/master/script/mailman_server) file contains the script for starting the mailman server. It is using POP3 (Post Office Protocol version 3) to receive emails from a remote server to a local email client. All the configrations regarding this is to be done in [mailman script](https://github.com/publiclab/plots2/blob/master/script/mailman_server).
6+
7+
After configurations are done we are good to start the `mailman` server. For starting the server use the go to the script folder and use command `mailman`.
8+
9+
> cd script
10+
11+
> mailman
12+
13+
Above command will start the server and then the mailman server will do polling in every 60 seconds(which is by default) to check for the incoming mail. However polling time can be changed by setting value to `Mailman.config.poll_interval`(more details can be found at its official [mailman user guide](https://github.com/mailman/mailman/blob/master/USER_GUIDE.md)).

0 commit comments

Comments
 (0)