ep_email_notifications

Find a file

Brett Smith 63403293d0 update: Improve email text. * Make the text less verbose. * Tell the reader how to unsubscribe. * Remove the placeholder for document changes.		2017-08-30 12:40:46 -04:00
locales	added spanish translation	2014-03-17 20:23:00 -03:00
static	previous fix generate another bug -> fixed	2013-04-06 22:55:21 +02:00
templates	forgot to commit i18n files + validation output page with template and external css	2013-04-03 05:16:18 +02:00
.gitignore	clean up	2013-01-31 02:00:07 +00:00
.travis.yml	travis	2013-10-06 18:04:45 +01:00
client.js	fixed bad vlue: undefiend -> undefined	2013-04-08 21:10:24 +02:00
ep.json	handling missing setting values	2013-04-04 20:39:43 +02:00
handleMessage.js	make it work again	2015-05-05 20:37:00 +01:00
index.js	bump v	2015-06-25 11:49:29 +01:00
package.json	bump v	2015-06-25 11:49:29 +01:00
README.md	begin fixing plugin	2015-05-03 12:48:15 +01:00
update.js	update: Improve email text.	2017-08-30 12:40:46 -04:00

README.md

Description

This plugin allows users to subscribe to pads and receive email updates when a pad is being modified. You can modify the frequency. This plugin is still in early stage and has things TODO (See TODO).

Source code

On Github : https://github.com/JohnMcLear/ep_email_notifications

Installation

Make sure an SMTP gateway is installed IE postfix

Configure SPF and RDNS records to ensure proper mail flow <-- Search online

Copy/Edit the below to your settings.json

Connect to a pad, Click on the Share/Embed link and enter in your email address.

Open that pad in ANOTHER BROWSER then begin modifying, you should receive an email when the pad has begun editing and once the pad has gone stale (when everyone stops editing it and a time period passes).

NOTE: You will NOT receive an email if you(the author that registered their email) are currently on or editing that pad!

 "ep_email_notifications" : {
    "panelDisplayLocation": { // Where you want to have the subscription panel
      "mysettings": true,
      "popup": true
    },
    "checkFrequency": "6000", // checkFrequency = How frequently(milliseconds) to check for pad updates -- Move me to the settings file
    "staleTime": "30000",  // staleTime = How stale(milliseconds) does a pad need to be before notifying subscribers?  Move me to settings
    "fromName": "Etherpad SETTINGS FILE!",
    "fromEmail": "pad@etherpad.org",
    "urlToPads": "http://beta.etherpad.org/p/", // urlToPads = The URL to your pads note the trailing /
    "emailServer": { // See https://github.com/eleith/emailjs for settings
      "host": "127.0.0.1"
    }
  }

Translation

This plugin has for now translations for english, french and german. In case you would like to have it in another language, you can easily translate the few sentences and then contact us on irc (#etherpad-lite-dev on irc.freenode.net) or create a Pull-Request on the GitHub repository. You can find the sentences to translate in the ep_email_notifications/locales/ directory. Specials chars written in unicode (See https://fr.wikipedia.org/wiki/Table_des_caract%C3%A8res_Unicode_%280000-0FFF%29)

TODO

Clean up all code

FUTURE VERSIONS TODO

v2 - Get the modified contents from the API HTML diff and append that to the Email and make the email from the server HTML not plain text
v2 - Keep a record of when a user was last on a pad