[NEW] Sending email notifications after editing time expires. And user setting for offline digest/notification frequency.

package.json

@@ -97,6 +97,7 @@
 		"file-type": "^5.2.0",
 		"highlight.js": "^9.12.0",
 		"jquery": "^3.2.1",
+		"later": "^1.2.0",
 		"mime-db": "^1.29.0",
 		"mime-type": "^3.0.5",
 		"moment": "^2.18.1",

packages/rocketchat-i18n/i18n/en.i18n.json

@@ -1005,6 +1005,8 @@
   "Message_DateFormat_Description": "See also: <a href=\"http://momentjs.com/docs/#/displaying/format/\" target=\"momemt\">Moment.js</a>",
   "Message_deleting_blocked": "This message cannot be deleted anymore",
   "Message_editing": "Message editing",
+  "Message_EmailNotificationAfterEditingExpires": "Send Email-notifications after editing-time expires",
+  "Message_EmailNotificationAfterEditingExpiresDescription": "[Sends updated/edited message in email notification] Requires editing enabled & editing time [ if 0 send instantly, else wait for specified time] ",
   "Message_GroupingPeriod": "Grouping Period (in seconds)",
   "Message_GroupingPeriodDescription": "Messages will be grouped with previous message if both are from the same user and the elapsed time was less than the informed time in seconds.",
   "Message_HideType_au": "Hide \"User Added\" messages",
@@ -1122,6 +1124,8 @@
   "Offline_Link_Message": "GO TO MESSAGE",
   "Offline_Mention_Email": "You have been mentioned by __user__ in #__room__",
   "Offline_message": "Offline message",
+  "Offline_Notification_Frequency": "Offline Notification Frequency",
+  "Offline_Notification_Frequency_Info": "You can still read messages [& Email will not be sent] until 'Allowed Editing Time' given by Administrators",
   "Offline_success_message": "Offline success message",
   "Offline_unavailable": "Offline unavailable",
   "On": "On",

packages/rocketchat-lib/package.js

@@ -101,6 +101,7 @@ Package.onUse(function(api) {
 	api.addFiles('server/lib/sendEmailOnMessage.js', 'server');
 	api.addFiles('server/lib/sendNotificationsOnMessage.js', 'server');
 	api.addFiles('server/lib/validateEmailDomain.js', 'server');
+	api.addFiles('server/lib/scheduleEmailMessage.js', 'server');
 
 	// SERVER MODELS
 	api.addFiles('server/models/_Base.js', 'server');

packages/rocketchat-lib/server/lib/scheduleEmailMessage.js

@@ -0,0 +1,111 @@
+import moment from 'moment';
+import later from 'later';
+
+// constains message details for which emails[updated message] are to be sent later
+const FutureNotificationEmails = new Meteor.Collection('future_notification_emails');
+// contains emails to be sent on desired frequency[ non-zero ]
+const FutureDigestEmails = new Meteor.Collection('future_digest_emails');
+
+RocketChat.EmailSchedule = new function() {
+	this.sendNotificationEmail = function(messageDetails) {
+		const room = RocketChat.models.Rooms.findOneById(messageDetails.rid);
+
+		const message = RocketChat.models.Messages.findOneById(messageDetails._id);
+
+		if (room !== undefined && message !== undefined) {
+			RocketChat.sendEmailOnMessage(message, room);
+		}
+		return true;
+	};
+
+	this.scheduleNotificationEmail = function(insertId, messageDetails) {
+		global.SyncedCron.add({
+			name: insertId,
+			schedule() {
+				return later.parse.recur().on(messageDetails.ts).fullDate();
+			},
+			job() {
+				RocketChat.EmailSchedule.sendNotificationEmail(messageDetails);
+				FutureNotificationEmails.remove(insertId);
+				global.SyncedCron.remove(insertId);
+				return insertId;
+			}
+		});
+		return true;
+	};
+
+	this.sendOrScheduleNotification = function(messageDetails) {
+		if (messageDetails.ts < new Date()) {
+			RocketChat.EmailSchedule.sendNotificationEmail(messageDetails);
+		} else {
+			const insertId = FutureNotificationEmails.insert(messageDetails);
+			RocketChat.EmailSchedule.scheduleNotificationEmail(insertId, messageDetails);
+		}
+		return true;
+	};
+
+	this.sendDigestEmail = function(email) {
+		if (email !== undefined) {
+			delete email.ts;
+			delete email._id;
+			Meteor.defer(() => {
+				Email.send(email);
+			});
+		}
+		return true;
+	};
+
+	this.scheduleDigestEmail = function(insertId, email) {
+		global.SyncedCron.add({
+			name: insertId,
+			schedule() {
+				return later.parse.recur().on(email.ts).fullDate();
+			},
+			job() {
+				RocketChat.EmailSchedule.sendDigestEmail(email);
+				FutureDigestEmails.remove(insertId);
+				global.SyncedCron.remove(insertId);
+				return insertId;
+			}
+		});
+		return true;
+	};
+
+	this.sendOrScheduleDigest = function(email) {
+		if (email.ts < new Date()) {
+			RocketChat.EmailSchedule.sendDigestEmail(email);
+		} else {
+			const insertId = FutureDigestEmails.insert(email);
+			RocketChat.EmailSchedule.scheduleDigestEmail(insertId, email);
+		}
+		return true;
+	};
+
+	this.getDigestTiming = function(partitions) {
+		return moment(new Date()).startOf('day').add((Math.floor(moment(new Date()).hours()/partitions)+1)*partitions, 'hours').toDate();
+	};
+};
+
+Meteor.startup(function() {
+	FutureNotificationEmails.find().forEach(function(details) {
+		if (details.ts < new Date()) {
+			RocketChat.EmailSchedule.sendNotificationEmail(details);
+			FutureNotificationEmails.remove(details._id);
+			global.SyncedCron.remove(details._id);
+		} else {
+			RocketChat.EmailSchedule.scheduleNotificationEmail(details._id, details);
+		}
+	});
+
+	FutureDigestEmails.find().forEach(function(email) {
+		if (email.ts < new Date()) {
+			RocketChat.EmailSchedule.sendDigestEmail(email);
+			FutureDigestEmails.remove(email._id);
+			global.SyncedCron.remove(email._id);
+		} else {
+			RocketChat.EmailSchedule.scheduleDigestEmail(email._id, email);
+		}
+	});
+
+	global.SyncedCron.start();
+});

packages/rocketchat-lib/server/lib/sendEmailOnMessage.js

@@ -10,6 +10,24 @@ RocketChat.callbacks.add('afterSaveMessage', function(message, room) {
 		return message;
 	}
 
+	if (RocketChat.settings.get('Message_EmailNotificationAfterEditingExpires') && RocketChat.settings.get('Message_AllowEditing') === true && RocketChat.settings.get('Message_AllowEditing_BlockEditInMinutes') > 0) {
+		const details = {
+			'rid': message.rid,
+			'_id': message._id,
+			'ts': message.ts
+		};
+		details.ts.setMinutes(details.ts.getMinutes() + RocketChat.settings.get('Message_AllowEditing_BlockEditInMinutes'));
+
+		RocketChat.EmailSchedule.sendOrScheduleNotification(details);
+	} else {
+		RocketChat.sendEmailOnMessage(message, room);
+	}
+
+	return message;
+
+}, RocketChat.callbacks.priority.LOW, 'sendEmailOnMessage');
+
+RocketChat.sendEmailOnMessage = function(message, room) {
 	let emailSubject;
 	const usersToSendEmail = {};
 	const directMessage = room.t === 'd';
@@ -95,7 +113,9 @@ RocketChat.callbacks.add('afterSaveMessage', function(message, room) {
 			linkByUser[sub.u._id] = getMessageLink(room, sub);
 		});
 	} else {
-		defaultLink = getMessageLink(room, { name: room.name });
+		defaultLink = getMessageLink(room, {
+			name: room.name
+		});
 	}
 
 	if (userIdsToSendEmail.length > 0) {
@@ -114,6 +134,11 @@ RocketChat.callbacks.add('afterSaveMessage', function(message, room) {
 					return;
 				}
 
+				// Check if message still unread
+				if (RocketChat.models.Subscriptions.findUnreadByRoomIdAndUserId(message.rid, user._id) === 0) {
+					return;
+				}
+
 				user.emails.some((email) => {
 					if (email.verified) {
 						email = {
@@ -123,17 +148,19 @@ RocketChat.callbacks.add('afterSaveMessage', function(message, room) {
 							html: header + messageHTML + divisorMessage + (linkByUser[user._id] || defaultLink) + footer
 						};
 
-						Meteor.defer(() => {
-							Email.send(email);
-						});
+						if (user.settings && user.settings.preferences && user.settings.preferences.offlineNotificationFrequency && user.settings.preferences.offlineNotificationFrequency > 0) {
+							email.ts = RocketChat.EmailSchedule.getDigestTiming(user.settings.preferences.offlineNotificationFrequency);
+							RocketChat.EmailSchedule.sendOrScheduleDigest(email);
+						} else {
+							Meteor.defer(() => {
+								Email.send(email);
+							});
+						}
 
 						return true;
 					}
 				});
 			});
 		}
 	}
-
-	return message;
-
-}, RocketChat.callbacks.priority.LOW, 'sendEmailOnMessage');
+};

packages/rocketchat-lib/server/models/Subscriptions.js

@@ -168,6 +168,15 @@ class ModelSubscriptions extends RocketChat.models._Base {
 		return this.find(query, { fields: { unread: 1 } });
 	}
 
+	findUnreadByRoomIdAndUserId(roomId, userId) {
+		const query = {
+			'rid': roomId,
+			'u._id': userId
+		};
+
+		return this.findOne(query, { fields: { unread: 1 } }).unread;
+	}
+
 	// UPDATE
 	archiveByRoomId(roomId) {
 		const query =

packages/rocketchat-lib/server/models/Users.js

@@ -531,7 +531,7 @@ Find users to send a message by email if:
 			'emails.verified': true
 		};
 
-		return this.find(query, { fields: { name: 1, username: 1, emails: 1, 'settings.preferences.emailNotificationMode': 1 } });
+		return this.find(query, { fields: { name: 1, username: 1, emails: 1, 'settings.preferences.emailNotificationMode': 1, 'settings.preferences.offlineNotificationFrequency': 1 } });
 	}
 }
 

packages/rocketchat-lib/server/startup/settings.js

@@ -727,6 +727,11 @@ RocketChat.settings.addGroup('Message', function() {
 		'public': true,
 		i18nDescription: 'Message_AllowEditing_BlockEditInMinutesDescription'
 	});
+	this.add('Message_EmailNotificationAfterEditingExpires', false, {
+		type: 'boolean',
+		'public': true,
+		i18nDescription: 'Message_EmailNotificationAfterEditingExpiresDescription'
+	});
 	this.add('Message_AllowDeleting', true, {
 		type: 'boolean',
 		'public': true

packages/rocketchat-ui-account/client/accountPreferences.html

@@ -171,6 +171,23 @@ <h1>{{_ "Messages"}}</h1>
 								</div>
 								<div class="info">{{_ "You_need_to_verifiy_your_email_address_to_get_notications"}}</div>
 							</div>
+							<div class="input-line double-col" id="offlineNotificationFrequency">
+								<label>{{_ "Offline_Notification_Frequency"}}</label>
+								<div>
+									<select name="offlineNotificationFrequency" >
+										<option value="0" selected="{{selected 'offlineNotificationFrequency' 0 true}}">Instantly, Default </option>
+										<option value="1" selected="{{selected 'offlineNotificationFrequency' 1 false}}">Every Hour</option>
+										<option value="2" selected="{{selected 'offlineNotificationFrequency' 2 false}}">Every 2 Hours</option>
+										<option value="3" selected="{{selected 'offlineNotificationFrequency' 3 false}}">Every 3 Hours</option>
+										<option value="4" selected="{{selected 'offlineNotificationFrequency' 4 false}}">Every 4 Hours</option>
+										<option value="6" selected="{{selected 'offlineNotificationFrequency' 6 false}}">Every 6 Hours</option>
+										<option value="8" selected="{{selected 'offlineNotificationFrequency' 8 false}}">Every 8 Hours</option>
+										<option value="12" selected="{{selected 'offlineNotificationFrequency' 12 false}}">Every 12 Hours</option>
+										<option value="24" selected="{{selected 'offlineNotificationFrequency' 24 false}}">Every 24 Hours</option>
+									</select>
+									<div class="info">{{_ "Offline_Notification_Frequency_Info"}}</div>
+								</div>
+							</div>
 						</div>
 					</div>
 					<div class="section">

packages/rocketchat-ui-account/client/accountPreferences.js

@@ -123,6 +123,7 @@ Template.accountPreferences.onCreated(function() {
 		}));
 		data.desktopNotificationDuration = $('input[name=desktopNotificationDuration]').val();
 		data.unreadAlert = $('#unreadAlert').find('input:checked').val();
+		data.offlineNotificationFrequency = parseInt($('select[name=offlineNotificationFrequency]').val());
 		Meteor.call('saveUserPreferences', data, function(error, results) {
 			if (results) {
 				toastr.success(t('Preferences_saved'));

server/methods/saveUserPreferences.js

@@ -63,6 +63,7 @@ Meteor.methods({
 			preferences.hideFlexTab = settings.hideFlexTab === '1';
 			preferences.highlights = settings.highlights;
 			preferences.sendOnEnter = settings.sendOnEnter;
+			preferences.offlineNotificationFrequency = settings.offlineNotificationFrequency || 0;
 
 			RocketChat.models.Users.setPreferences(Meteor.userId(), preferences);