Skip to content

Commit

Permalink
[docs] Updating ReadMe, removed template demos for now
Browse files Browse the repository at this point in the history
  • Loading branch information
Marak committed May 17, 2011
1 parent d9be8d7 commit d121a9e
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 85 deletions.
54 changes: 2 additions & 52 deletions Readme.md
Expand Up @@ -43,61 +43,11 @@
}

# USING SSL
This fork supports SSL connections (not TLS / STARTTLS, just SSL from the beginning of the connection). To use it,
node_mailer SSL connections (not TLS / STARTTLS, just SSL from the beginning of the connection). To use it,
add an option ssl: true. See usage above.


# 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}} {{adverb}} 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 : "25", // 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",
"adverb": "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, Fedor Indutny
Marak Squires, Elijah Insua, Fedor Indutny, Bradley Meck

31 changes: 0 additions & 31 deletions demo-template.js

This file was deleted.

4 changes: 2 additions & 2 deletions demo.js
Expand Up @@ -11,8 +11,8 @@ for(var i = 0; i < 10; i++){
subject : "node_mailer test email",
body: "Hello! This is a test of the node_mailer.",
authentication : "login", // auth login is supported; anything else is no auth
username : undefined, // Base64 encoded username
password : undefined // Base64 encoded password
username : 'username', // Base64 encoded username
password : 'password' // Base64 encoded password
},
function(err, result){
if(err){ console.log(err); }
Expand Down

0 comments on commit d121a9e

Please sign in to comment.