Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[api] added the abiltity to do mustache templating. bumped to 0.4.0

  • Loading branch information...
commit 183e038a31eedc5e812f5cde441a5e5288c1982d 1 parent 186590f
Marak authored
52 Readme.md
View
@@ -14,11 +14,11 @@
- super simple api
- emails are blasted out asynchronously
- uses connection pooling per SMTP server
+ - super simple built in templates using Mustache.js
# REQUIRES
- SMTP Server
-
# USAGE
var email = require("mailer");
@@ -41,6 +41,56 @@
}
+# USING TEMPLATES
+
+### create a simple template
+
+/templates/sample.text
+
+ Hello {{username}},
+
+ This is a sample template of the node mailer.
+
+ It uses mustache templating to do basic search and replaces.
+
+ The {{color}} {{animal}} {{adjective}} ran over the {{noun}}.
+
+### then send the mail using some simple JSON based Mustache replacement.
+
+ var email = require("../lib/node_mailer");
+
+ for(var i = 0; i < 10; i++){
+
+ email.send({
+ host : "localhost", // smtp server hostname
+ port : "252", // smtp server port
+ domain : "localhost", // domain used by client to identify itself to server
+ to : "marak.squires@gmail.com",
+ from : "obama@whitehouse.gov",
+ subject : "node_mailer test email",
+ template : "../templates/sample.txt", // path to template name
+ data : {
+ "username": "Billy Bob",
+ "color": function(){
+ var arr = ["purple", "red", "green", "yello"];
+ return arr[Math.floor(Math.random()*3)];
+ },
+ "animal": "monkey",
+ "adjective": "quickly",
+ "noun": "hot lava"
+ },
+
+ authentication : "login", // auth login is supported; anything else is no auth
+ username : "dXNlcm5hbWU=", // Base64 encoded username
+ password : "cGFzc3dvcmQ=" // Base64 encoded password
+ },
+ function(err, result){
+ if(err){ console.log(err); }
+ });
+ }
+
+
+
## Authors
Marak Squires, Elijah Insua
33 examples/demo-template.js
View
@@ -0,0 +1,33 @@
+var email = require("../lib/node_mailer");
+
+for(var i = 0; i < 10; i++){
+
+ email.send({
+ host : "localhost", // smtp server hostname
+ port : "252", // smtp server port
+ domain : "localhost", // domain used by client to identify itself to server
+ to : "marak.squires@gmail.com",
+ from : "obama@whitehouse.gov",
+ subject : "node_mailer test email",
+ template : "../templates/sample.txt", // path to template name
+ data : {
+ "username": "Billy Bob",
+ "color": function(){
+ var arr = ["purple", "red", "green", "yello"];
+ return arr[Math.floor(Math.random()*3)];
+ },
+ "animal": "monkey",
+ "adjective": "quickly",
+ "noun": "hot lava"
+ },
+
+ authentication : "login", // auth login is supported; anything else is no auth
+ username : "dXNlcm5hbWU=", // Base64 encoded username
+ password : "cGFzc3dvcmQ=" // Base64 encoded password
+ },
+ function(err, result){
+ if(err){ console.log(err); }
+ });
+
+}
+
17 demo.js → examples/demo.js
View
@@ -1,22 +1,21 @@
-var email = require("./lib/node_mailer");
+var email = require("../lib/node_mailer");
for(var i = 0; i < 10; i++){
-
+
email.send({
host : "localhost", // smtp server hostname
- port : "1025", // smtp server port
+ port : "252", // smtp server port
domain : "localhost", // domain used by client to identify itself to server
to : "marak.squires@gmail.com",
from : "obama@whitehouse.gov",
subject : "node_mailer test email",
- body : "hello this the " + i + " a test email from the node_mailer",
-
+ body: "Hello! This is a test of the node_mailer.",
authentication : "login", // auth login is supported; anything else is no auth
username : "dXNlcm5hbWU=", // Base64 encoded username
- password : "cGFzc3dvcmQ=", // Base64 encoded password
-
+ password : "cGFzc3dvcmQ=" // Base64 encoded password
+ },
+ function(err, result){
+ if(err){ console.log(err); }
});
-
-
}
32 lib/node_mailer.js
View
@@ -24,9 +24,12 @@ OTHER DEALINGS IN THE SOFTWARE.
var tcp = require('net'),
+ fs = require('fs'),
+ mustache = require('../vendor/mustache'),
defaultOptions = {
to : "marak.squires@gmail.com",
from : "obama@whitehouse.gov",
+ data : {},
subject : "node_mailer test email",
body : "hello this is a test email from the node_mailer",
host : "localhost",
@@ -34,13 +37,14 @@ var tcp = require('net'),
port : 25
},
keys = Object.keys(defaultOptions),
- connections = {};
+ connections = {},
+ templateCache = {};
exports.connections = connections;
var Connection = function(options, callback) {
this.options = options;
- this.callback = callback;
+ this.callback = callback || function(){};
};
Connection.prototype = {
options : {},
@@ -202,6 +206,28 @@ exports.send = function(options, callback) {
options[key] = defaultOptions[key];
}
}
+ var eyes = require('eyes');
Ben Williamson
benw added a note

require('eyes')? What's that?

Marak Owner
Marak added a note

ahhh crap, its a debugging library, i must have slipped there >.<

npm install eyes

will install it, but it is not needed. sorry!

Marak Owner
Marak added a note

fixed with: 7de32d6

bumped to version 0.4.1, pushed to npm.

sorry again!

Ben Williamson
benw added a note

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+
+ // determine if we need to load a template before processing email for sending
+
+ // there is currently a bit of a dog pile effect on the template caching, but in theory
+ // it should eventually cache before we run out of File Descriptors. templateCache should be refactored
+ if(options.template){
+ if(typeof templateCache[options.template] != 'undefined'){
+ options.body = mustache.to_html(templateCache[options.template], options.data);
+ return new Email(options, callback);
+ }
+ else{
+ fs.readFile(options.template, function (err, data) {
+ if (err) throw err;
+ templateCache[options.template] = data.toString();
+ options.body = mustache.to_html(templateCache[options.template], options.data);
+ return new Email(options, callback);
+ });
+ }
+ }
+ else{
+ return new Email(options, callback);
+ }
- return new Email(options, callback);
};
4 package.json
View
@@ -1,7 +1,7 @@
{
"name": "mailer",
"description": "send emails from node.js to a smtp server, simple as cake",
- "version": "0.3.0",
+ "version": "0.4.0",
"author": "Marak Squires",
"contributors" : [
"Elijah Insua <tmpvar@gmail.com> (http://tmvpar.com/)"
@@ -10,6 +10,6 @@
"type": "git",
"url": "http://github.com/Marak/node_mailer.git"
},
- "engine": [ "node >=0.1.90" ],
+ "engine": [ "node >=0.2.00" ],
"main": "lib/node_mailer"
}
7 templates/sample.txt
View
@@ -0,0 +1,7 @@
+Hello {{username}},
+
+This is a sample template of the node mailer.
+
+It uses mustache templating to do basic search and replaces.
+
+The {{color}} {{animal}} {{adjective}} ran over the {{noun}}.
337 vendor/mustache.js
View
@@ -0,0 +1,337 @@
+/*
+ * CommonJS-compatible mustache.js module
+ *
+ * See http://github.com/janl/mustache.js for more info.
+ */
+
+/*
+ mustache.js — Logic-less templates in JavaScript
+
+ See http://mustache.github.com/ for more info.
+*/
+
+var Mustache = function() {
+ var Renderer = function() {};
+
+ Renderer.prototype = {
+ otag: "{{",
+ ctag: "}}",
+ pragmas: {},
+ buffer: [],
+ pragmas_implemented: {
+ "IMPLICIT-ITERATOR": true
+ },
+ context: {},
+
+ render: function(template, context, partials, in_recursion) {
+ // reset buffer & set context
+ if(!in_recursion) {
+ this.context = context;
+ this.buffer = []; // TODO: make this non-lazy
+ }
+
+ // fail fast
+ if(!this.includes("", template)) {
+ if(in_recursion) {
+ return template;
+ } else {
+ this.send(template);
+ return;
+ }
+ }
+
+ template = this.render_pragmas(template);
+ var html = this.render_section(template, context, partials);
+ if(in_recursion) {
+ return this.render_tags(html, context, partials, in_recursion);
+ }
+
+ this.render_tags(html, context, partials, in_recursion);
+ },
+
+ /*
+ Sends parsed lines
+ */
+ send: function(line) {
+ if(line != "") {
+ this.buffer.push(line);
+ }
+ },
+
+ /*
+ Looks for %PRAGMAS
+ */
+ render_pragmas: function(template) {
+ // no pragmas
+ if(!this.includes("%", template)) {
+ return template;
+ }
+
+ var that = this;
+ var regex = new RegExp(this.otag + "%([\\w-]+) ?([\\w]+=[\\w]+)?" +
+ this.ctag);
+ return template.replace(regex, function(match, pragma, options) {
+ if(!that.pragmas_implemented[pragma]) {
+ throw({message:
+ "This implementation of mustache doesn't understand the '" +
+ pragma + "' pragma"});
+ }
+ that.pragmas[pragma] = {};
+ if(options) {
+ var opts = options.split("=");
+ that.pragmas[pragma][opts[0]] = opts[1];
+ }
+ return "";
+ // ignore unknown pragmas silently
+ });
+ },
+
+ /*
+ Tries to find a partial in the curent scope and render it
+ */
+ render_partial: function(name, context, partials) {
+ name = this.trim(name);
+ if(!partials || partials[name] === undefined) {
+ throw({message: "unknown_partial '" + name + "'"});
+ }
+ if(typeof(context[name]) != "object") {
+ return this.render(partials[name], context, partials, true);
+ }
+ return this.render(partials[name], context[name], partials, true);
+ },
+
+ /*
+ Renders inverted (^) and normal (#) sections
+ */
+ render_section: function(template, context, partials) {
+ if(!this.includes("#", template) && !this.includes("^", template)) {
+ return template;
+ }
+
+ var that = this;
+ // CSW - Added "+?" so it finds the tighest bound, not the widest
+ var regex = new RegExp(this.otag + "(\\^|\\#)\\s*(.+)\\s*" + this.ctag +
+ "\n*([\\s\\S]+?)" + this.otag + "\\/\\s*\\2\\s*" + this.ctag +
+ "\\s*", "mg");
+
+ // for each {{#foo}}{{/foo}} section do...
+ return template.replace(regex, function(match, type, name, content) {
+ var value = that.find(name, context);
+ if(type == "^") { // inverted section
+ if(!value || that.is_array(value) && value.length === 0) {
+ // false or empty list, render it
+ return that.render(content, context, partials, true);
+ } else {
+ return "";
+ }
+ } else if(type == "#") { // normal section
+ if(that.is_array(value)) { // Enumerable, Let's loop!
+ return that.map(value, function(row) {
+ return that.render(content, that.create_context(row),
+ partials, true);
+ }).join("");
+ } else if(that.is_object(value)) { // Object, Use it as subcontext!
+ return that.render(content, that.create_context(value),
+ partials, true);
+ } else if(typeof value === "function") {
+ // higher order section
+ return value.call(context, content, function(text) {
+ return that.render(text, context, partials, true);
+ });
+ } else if(value) { // boolean section
+ return that.render(content, context, partials, true);
+ } else {
+ return "";
+ }
+ }
+ });
+ },
+
+ /*
+ Replace {{foo}} and friends with values from our view
+ */
+ render_tags: function(template, context, partials, in_recursion) {
+ // tit for tat
+ var that = this;
+
+ var new_regex = function() {
+ return new RegExp(that.otag + "(=|!|>|\\{|%)?([^\\/#\\^]+?)\\1?" +
+ that.ctag + "+", "g");
+ };
+
+ var regex = new_regex();
+ var tag_replace_callback = function(match, operator, name) {
+ switch(operator) {
+ case "!": // ignore comments
+ return "";
+ case "=": // set new delimiters, rebuild the replace regexp
+ that.set_delimiters(name);
+ regex = new_regex();
+ return "";
+ case ">": // render partial
+ return that.render_partial(name, context, partials);
+ case "{": // the triple mustache is unescaped
+ return that.find(name, context);
+ default: // escape the value
+ return that.escape(that.find(name, context));
+ }
+ };
+ var lines = template.split("\n");
+ for(var i = 0; i < lines.length; i++) {
+ lines[i] = lines[i].replace(regex, tag_replace_callback, this);
+ if(!in_recursion) {
+ this.send(lines[i]);
+ }
+ }
+
+ if(in_recursion) {
+ return lines.join("\n");
+ }
+ },
+
+ set_delimiters: function(delimiters) {
+ var dels = delimiters.split(" ");
+ this.otag = this.escape_regex(dels[0]);
+ this.ctag = this.escape_regex(dels[1]);
+ },
+
+ escape_regex: function(text) {
+ // thank you Simon Willison
+ if(!arguments.callee.sRE) {
+ var specials = [
+ '/', '.', '*', '+', '?', '|',
+ '(', ')', '[', ']', '{', '}', '\\'
+ ];
+ arguments.callee.sRE = new RegExp(
+ '(\\' + specials.join('|\\') + ')', 'g'
+ );
+ }
+ return text.replace(arguments.callee.sRE, '\\$1');
+ },
+
+ /*
+ find `name` in current `context`. That is find me a value
+ from the view object
+ */
+ find: function(name, context) {
+ name = this.trim(name);
+
+ // Checks whether a value is thruthy or false or 0
+ function is_kinda_truthy(bool) {
+ return bool === false || bool === 0 || bool;
+ }
+
+ var value;
+ if(is_kinda_truthy(context[name])) {
+ value = context[name];
+ } else if(is_kinda_truthy(this.context[name])) {
+ value = this.context[name];
+ }
+
+ if(typeof value === "function") {
+ return value.apply(context);
+ }
+ if(value !== undefined) {
+ return value;
+ }
+ // silently ignore unkown variables
+ return "";
+ },
+
+ // Utility methods
+
+ /* includes tag */
+ includes: function(needle, haystack) {
+ return haystack.indexOf(this.otag + needle) != -1;
+ },
+
+ /*
+ Does away with nasty characters
+ */
+ escape: function(s) {
+ s = String(s === null ? "" : s);
+ return s.replace(/&(?!\w+;)|["<>\\]/g, function(s) {
+ switch(s) {
+ case "&": return "&amp;";
+ case "\\": return "\\\\";
+ case '"': return '\"';
+ case "<": return "&lt;";
+ case ">": return "&gt;";
+ default: return s;
+ }
+ });
+ },
+
+ // by @langalex, support for arrays of strings
+ create_context: function(_context) {
+ if(this.is_object(_context)) {
+ return _context;
+ } else {
+ var iterator = ".";
+ if(this.pragmas["IMPLICIT-ITERATOR"]) {
+ iterator = this.pragmas["IMPLICIT-ITERATOR"].iterator;
+ }
+ var ctx = {};
+ ctx[iterator] = _context;
+ return ctx;
+ }
+ },
+
+ is_object: function(a) {
+ return a && typeof a == "object";
+ },
+
+ is_array: function(a) {
+ return Object.prototype.toString.call(a) === '[object Array]';
+ },
+
+ /*
+ Gets rid of leading and trailing whitespace
+ */
+ trim: function(s) {
+ return s.replace(/^\s*|\s*$/g, "");
+ },
+
+ /*
+ Why, why, why? Because IE. Cry, cry cry.
+ */
+ map: function(array, fn) {
+ if (typeof array.map == "function") {
+ return array.map(fn);
+ } else {
+ var r = [];
+ var l = array.length;
+ for(var i = 0; i < l; i++) {
+ r.push(fn(array[i]));
+ }
+ return r;
+ }
+ }
+ };
+
+ return({
+ name: "mustache.js",
+ version: "0.3.1-dev",
+
+ /*
+ Turns a template and view into HTML
+ */
+ to_html: function(template, view, partials, send_fun) {
+ var renderer = new Renderer();
+ if(send_fun) {
+ renderer.send = send_fun;
+ }
+ renderer.render(template, view, partials);
+ if(!send_fun) {
+ return renderer.buffer.join("\n");
+ }
+ }
+ });
+}();
+
+exports.name = Mustache.name;
+exports.version = Mustache.version;
+
+exports.to_html = function() {
+ return Mustache.to_html.apply(this, arguments);
+};
Ben Williamson

require('eyes')? What's that?

Marak

ahhh crap, its a debugging library, i must have slipped there >.<

npm install eyes

will install it, but it is not needed. sorry!

Marak

fixed with: 7de32d6

bumped to version 0.4.1, pushed to npm.

sorry again!

Please sign in to comment.
Something went wrong with that request. Please try again.