From 1dd4d305af8d12b8b86ed8cd6a8a67d0e05c4e4a Mon Sep 17 00:00:00 2001 From: Naman Gupta <01namangupta@gmail.com> Date: Wed, 6 Jun 2018 03:45:43 +0530 Subject: [PATCH 1/4] Added documentation for the reply-by-email to comment feature --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 4fe2fb7e51..0e3aff1069 100644 --- a/README.md +++ b/README.md @@ -80,12 +80,28 @@ Secure connection is needed for OAuth authentication etc. 5. To see the installed list of cron jobs use command `crontab -l` 6. For more details about this gem, visit the official repository of whenever gem. +*** + ### Bundle exec 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. *** +## How to start reply by email to comment feature + +With the merge of [fad88f](https://github.com/publiclab/plots2/commit/fad88fd72c9d08f5591bf4c0cab402160eb9ea54) 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). + +[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). + +After configurations are done we are good to start the `mailman` server. For starting the server use the command `script/mailman` from the root directory of the project. + +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`. + +`message_id` of email is also being stored in case we need to debug. + +*** + ## Bugs and support To report bugs and request features, please use the GitHub issue tracker provided at https://github.com/publiclab/plots2/issues From 042e136a75276d0bb16a1575b89c5053e7398743 Mon Sep 17 00:00:00 2001 From: Naman Gupta <01namangupta@gmail.com> Date: Mon, 11 Jun 2018 23:43:32 +0530 Subject: [PATCH 2/4] Added documentation for the reply-by-email to comment feature --- README.md | 12 +----------- doc/EMAIL.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 11 deletions(-) create mode 100644 doc/EMAIL.md diff --git a/README.md b/README.md index 0e3aff1069..8eba28e1fd 100644 --- a/README.md +++ b/README.md @@ -88,17 +88,7 @@ For some, it will be necessary to prepend your gem-related commands with `bundle *** -## How to start reply by email to comment feature - -With the merge of [fad88f](https://github.com/publiclab/plots2/commit/fad88fd72c9d08f5591bf4c0cab402160eb9ea54) 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). - -[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). - -After configurations are done we are good to start the `mailman` server. For starting the server use the command `script/mailman` from the root directory of the project. - -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`. - -`message_id` of email is also being stored in case we need to debug. +## Public Lab now supports reply by email to comment feature. For more details regarding it go to [Doc](https://github.com/publiclab/plots2/blob/master/doc/EMAIL.md) *** diff --git a/doc/EMAIL.md b/doc/EMAIL.md new file mode 100644 index 0000000000..ecc78b6f30 --- /dev/null +++ b/doc/EMAIL.md @@ -0,0 +1,12 @@ +## How to start reply by email to comment feature + +With the merge of [fad88f](https://github.com/publiclab/plots2/commit/fad88fd72c9d08f5591bf4c0cab402160eb9ea54) 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). + +[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). + +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`. + +> cd script +> mailman + +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)). \ No newline at end of file From b0da5110d2b287ebbb379321e2d4bd9f77c30b22 Mon Sep 17 00:00:00 2001 From: Naman Gupta <01namangupta@gmail.com> Date: Mon, 11 Jun 2018 23:50:05 +0530 Subject: [PATCH 3/4] Added documentation for the reply-by-email to comment feature --- README.md | 2 +- doc/EMAIL.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8eba28e1fd..2bd444f090 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ For some, it will be necessary to prepend your gem-related commands with `bundle *** -## Public Lab now supports reply by email to comment feature. For more details regarding it go to [Doc](https://github.com/publiclab/plots2/blob/master/doc/EMAIL.md) +### Public Lab now supports reply by email to comment feature. For more details regarding it go to [Doc](https://github.com/publiclab/plots2/blob/master/doc/EMAIL.md) *** diff --git a/doc/EMAIL.md b/doc/EMAIL.md index ecc78b6f30..c533b1b66a 100644 --- a/doc/EMAIL.md +++ b/doc/EMAIL.md @@ -7,6 +7,7 @@ With the merge of [fad88f](https://github.com/publiclab/plots2/commit/fad88fd72c 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`. > cd script + > mailman 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)). \ No newline at end of file From c8c20513c334a819a28943ef821923099c9133e7 Mon Sep 17 00:00:00 2001 From: Naman Gupta <01namangupta@gmail.com> Date: Fri, 15 Jun 2018 14:12:46 +0530 Subject: [PATCH 4/4] Added documentation for the reply-by-email to comment feature --- README.md | 4 +++- doc/EMAIL.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2bd444f090..a225061808 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,9 @@ For some, it will be necessary to prepend your gem-related commands with `bundle *** -### Public Lab now supports reply by email to comment feature. For more details regarding it go to [Doc](https://github.com/publiclab/plots2/blob/master/doc/EMAIL.md) +### Reply-by-email + +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) *** diff --git a/doc/EMAIL.md b/doc/EMAIL.md index c533b1b66a..fb5275d879 100644 --- a/doc/EMAIL.md +++ b/doc/EMAIL.md @@ -1,6 +1,6 @@ ## How to start reply by email to comment feature -With the merge of [fad88f](https://github.com/publiclab/plots2/commit/fad88fd72c9d08f5591bf4c0cab402160eb9ea54) 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). +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). [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).