} - The content of the email.
*/
function generateEmailNotification (forceDate) {
var now, events, contactList, subjectPrefix, subjectBuilder, subject,
bodyPrefix, bodySuffixes, bodyBuilder, body, htmlBody, htmlBodyBuilder,
contactIter, runningOutdatedVersion, maxSubjectLength, ellipsis;
log.add('generateEmailNotification() running.', Priority.INFO);
now = forceDate || new Date();
log.add('Date used: ' + now, Priority.INFO);
events = [].concat.apply(
[],
settings.notifications.anticipateDays
.map(function (days) {
var date = now.addDays(days);
return getEventsOnDate(
parseInt(Utilities.formatDate(date, settings.notifications.timeZone, 'yyyy'), 10),
parseInt(Utilities.formatDate(date, settings.notifications.timeZone, 'MM'), 10) - 1,
parseInt(Utilities.formatDate(date, settings.notifications.timeZone, 'dd'), 10),
settings.user.calendarId
);
})
);
if (events.length === 0) {
log.add('No events found. Exiting now.', Priority.INFO);
return null;
}
log.add('Found ' + events.length + ' events.', Priority.INFO);
contactList = [];
/*
* Build a list of contacts (with complete information) from the event list.
*
* **Note:** multiple events can refer to the same contact.
*/
events.forEach(function (rawEvent) {
var eventData;
if (!rawEvent.gadget || !rawEvent.gadget.preferences) {
log.add(rawEvent, Priority.INFO);
log.add('The structure of this event cannot be parsed.', Priority.FATAL_ERROR);
}
eventData = rawEvent.gadget.preferences;
// Look if the contact of this event is already in the contact list.
for (contactIter = 0; contactIter < contactList.length; contactIter++) {
if (
eventData['goo.contactsContactId'] !== null &&
eventData['goo.contactsContactId'] === contactList[contactIter].contactId
) {
// FOUND!
// Integrate this event information into the contact.
break;
}
}
if (contactIter === contactList.length) {
// NOT FOUND!
// Add a new contact to the contact list and store all the info in that contact.
contactList.push(new MergedContact());
}
contactList[contactIter].getInfoFromRawEvent(rawEvent);
});
// Iterate by reverse index to allow safe splicing from within the loop
contactIter = contactList.length;
while (contactIter--) {
if (!contactList[contactIter].events || !contactList[contactIter].events.length) {
contactList.splice(contactIter, 1);
}
}
if (contactList.length === 0) {
log.add('No contacts with valid events found. Exiting now.', Priority.INFO);
return null;
}
log.add('Found ' + contactList.length + ' contacts with matching events.', Priority.INFO);
// Give a default profile image to the contacts without one.
contactList.forEach(function (contact) {
contact.data.merge(new ContactDataDC(
null, // Full name.
null, // Nickname.
defaultProfileImageURL // Profile photo URL.
));
});
// Start building the email notification text.
subjectPrefix = _('Events') + ': ';
subjectBuilder = contactList.map(function (contact) { return contact.data.getProp('fullName'); });
bodyPrefix = _('Hey! Don\'t forget these events') + ':';
bodySuffixes = [
_('Google Contacts Events Notifier') + ' (' + _('version') + ' ' + version.toString() + ')',
_('It looks like you are using an outdated version of this script') + '.',
_('You can find the latest one here')
];
inlineImages = {};
// The email is built both with plain text and HTML text.
bodyBuilder = [];
htmlBodyBuilder = [];
settings.notifications.anticipateDays
.forEach(function (daysInterval) {
var date, formattedDate;
date = now.addDays(daysInterval);
formattedDate = Utilities.formatDate(date, settings.notifications.timeZone, _('dd-MM-yyyy'));
eventTypes.forEach(function (eventType) {
var plaintextLines, htmlLines, whenIsIt;
// Get all the matching 'eventType' events.
log.add('Checking ' + eventTypeNamePlural[eventType] + ' on ' + formattedDate, Priority.INFO);
plaintextLines = contactList
.map(function (contact) { return contact.getLines(eventType, date, NotificationType.PLAIN_TEXT); })
.filter(function (lines) { return lines.length > 0; });
htmlLines = contactList
.map(function (contact) { return contact.getLines(eventType, date, NotificationType.HTML); })
.filter(function (lines) { return lines.length > 0; });
if (plaintextLines.length === 0 || htmlLines.length === 0) {
log.add('No events found on this date.', Priority.INFO);
return;
}
log.add('Found ' + plaintextLines.length + ' ' + eventTypeNamePlural[eventType], Priority.INFO);
// Build the headers of 'eventType' event grouping by date.
bodyBuilder.push('\n * ');
htmlBodyBuilder.push('');
whenIsIt = eventTypeNamePlural[eventType].charAt(0).toUpperCase() + eventTypeNamePlural[eventType].slice(1);
switch (daysInterval) {
case 0:
whenIsIt += ' today';
break;
case 1:
whenIsIt += ' tomorrow';
break;
default:
whenIsIt += ' in {0} days';
}
whenIsIt = _(whenIsIt).format(daysInterval) + ' (' + formattedDate + ')';
bodyBuilder.push(whenIsIt, ':\n');
plaintextLines.forEach(function (line) { bodyBuilder.extend(line); });
htmlBodyBuilder.push(whenIsIt, '');
htmlLines.forEach(function (line) { htmlBodyBuilder.extend(line); });
htmlBodyBuilder.push('
');
});
});
if (bodyBuilder.length === 0) {
// If there is no email to send
return null;
} else {
// If there is an email to send build the content...
log.add('Building the email notification.', Priority.INFO);
runningOutdatedVersion = isRunningOutdatedVersion();
subject = subjectPrefix + subjectBuilder.join(' - ');
// An error is thrown if the subject of the email is longer than 250 characters.
maxSubjectLength = 250;
ellipsis = '...';
if (subject.length > maxSubjectLength) {
subject = subject.substr(0, maxSubjectLength - ellipsis.length) + ellipsis;
}
body = [bodyPrefix, '\n']
.concat(bodyBuilder)
.concat(['\n\n ', bodySuffixes[0], '\n '])
.concat('\n', runningOutdatedVersion ? [bodySuffixes[1], ' ', bodySuffixes[2], ':\n', baseGitHubProjectURL + 'releases/latest', '\n '] : [])
.join('');
htmlBody = ['', htmlEscape(bodyPrefix), '
']
.concat(htmlBodyBuilder)
.concat(['
', htmlEscape(bodySuffixes[0]), ''])
.concat(runningOutdatedVersion ? ['
', htmlEscape(bodySuffixes[1]), ' ', htmlEscape(bodySuffixes[2]), '.
'] : [''])
.join('');
// ...and return it.
return {
'subject': subject,
'body': body,
'htmlBody': htmlBody,
'inlineImages': inlineImages
};
}
}
/**
*
* Send an email notification to the user containing a list of the events
* of his/her contacts scheduled for the next days.
*
* @param {?Date} forceDate - If this value is not null it's used as 'now'.
*/
function main (forceDate) {
log.add('main() running.', Priority.INFO);
validateSettings();
var emailData = generateEmailNotification(forceDate);
// If generateEmailNotification returned mail content send it.
if (emailData !== null) {
log.add('Sending email...', Priority.INFO);
MailApp.sendEmail({
to: settings.user.notificationEmail,
subject: emailData.subject,
body: emailData.body,
htmlBody: emailData.htmlBody,
inlineImages: emailData.inlineImages,
name: settings.user.emailSenderName
});
log.add('Email sent.', Priority.INFO);
}
// Send the log if the debug options say so.
log.sendEmail(settings.user.notificationEmail, settings.user.emailSenderName);
}
/**
* Execute the `main()` function without forcing any date as "now".
*/
function normal () { // eslint-disable-line no-unused-vars
log.add('normal() running.', Priority.INFO);
main(null);
}
/**
* Execute the `main()` function forcing a given date (`settings.debug.testDate`) as "now".
*/
function test () { // eslint-disable-line no-unused-vars
log.add('test() running.', Priority.INFO);
main(settings.debug.testDate);
}
// NOTIFICATION SERVICE FUNCTIONS
/**
* Start the notification service.
*/
function notifStart () { // eslint-disable-line no-unused-vars
validateSettings();
// Delete old triggers.
notifStop();
// Add a new trigger.
try {
ScriptApp.newTrigger('normal')
.timeBased()
.atHour(settings.notifications.hour)
.everyDays(1)
.inTimezone(settings.notifications.timeZone)
.create();
} catch (err) {
log.add('Failed to start the notification service: make sure that settings.notifications.timeZone is a valid value.', Priority.FATAL_ERROR);
}
log.add('Notification service started.', Priority.INFO);
}
/**
* Stop the notification service.
*/
function notifStop () {
var triggers;
// Delete all the triggers.
triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
ScriptApp.deleteTrigger(triggers[i]);
}
log.add('Notification service stopped.', Priority.INFO);
}
/**
* Check if notification service is running.
*/
function notifStatus () { // eslint-disable-line no-unused-vars
var toLog = 'Notifications are ';
if (ScriptApp.getProjectTriggers().length < 1) {
toLog += 'not ';
}
toLog += 'running.';
log.add(toLog);
log.sendEmail(settings.user.notificationEmail, settings.user.emailSenderName);
}
/**
* Generate a date with a given timezone id.
*
* @param {!Number} year - Full year of the date.
* @param {!Number} month - Month of the date, starting from 0.
* @param {!Number} day - Day of the date, starting from 1.
* @param {!Number} hour - Hour of the date.
* @param {!Number} minute - Minute of the date.
* @param {!Number} second - Second of the date,
* @param {String} timezoneId - A valid IANA timezone identifier.
*
* @returns {Date} - The date corresponding to the input.
*/
function dateWithTimezone (year, month, day, hour, minute, second, timezoneId) {
var date, offset;
// Generate the date as in the UTC0 timezone.
date = new Date(Date.UTC(year, month, day, hour, minute, second));
// Calculate the offset for the given timezone.
offset = Utilities.formatDate(date, timezoneId, 'Z');
// Evaluate the offset (in minutes).
offset = (offset[0] === '-' ? -1 : +1) * (parseInt(offset[1] + offset[2], 10) * 60 + parseInt(offset[3] + offset[4], 10));
// Apply the offse to the UTC date to get the correct date.
date = new Date(date.getTime() - offset * 60000);
return date;
}