ep_email_notifications

Find a file

quenenni 907ecb9a7b Small corrections - put back msgs to the debug level instead of info - remove a call to ep_etherpad-lite/node/utils/Settings as it was for a function that doesn't exist anymore - remove checked_state var for the form as I manage myself the default check for the options.		2013-03-26 21:40:02 +01:00
static	Unsubscription & choose to receive a mail onStart / onEnd	2013-03-26 20:44:34 +01:00
templates	Unsubscription & choose to receive a mail onStart / onEnd	2013-03-26 20:44:34 +01:00
.gitignore	clean up	2013-01-31 02:00:07 +00:00
client.js	Small corrections	2013-03-26 21:40:02 +01:00
ep.json	Unsubscription & choose to receive a mail onStart / onEnd	2013-03-26 20:44:34 +01:00
handleMessage.js	Small corrections	2013-03-26 21:40:02 +01:00
package.json	Update package.json	2013-03-19 22:30:15 +00:00
README.md	fix issue #2 recieve typo	2013-02-09 21:36:51 +01:00
update.js	Unsubscription & choose to receive a mail onStart / onEnd	2013-03-26 20:44:34 +01: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 very much in alpha stage and has a lot of things TODO (See TODO).

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" : {
    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"
    }
  }

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 - a point to unsubscribe and validate/verify email https://github.com/alfredwesterveld/node-email-verification
v2 - Keep a record of when a user was last on a pad