nodemailer 0.6.3 → 0.7.1

package/.npmignore

@@ -1,3 +1,6 @@
-node_modules
-npm-debug.log
-.DS_Store
+.travis.yml
+CONTRIBUTING.md
+assets
+examples
+test
+

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## v0.7.1 2014-07-09
+
+  * Upgraded aws-sdk to 2.0.5
+
+## v0.7.0 2014-06-17
+
+  * Bumped version to v0.7.0
+  * Fix AWS-SES usage [5b6bc144]
+  * Replace current SES with new SES using AWS-SDK (Elanorr) [c79d797a]
+  * Updated README.md about Node Email Templates (niftylettuce) [e52bef81]
+
+## v0.6.5 2014-05-15
+
+  * Bumped version to v0.6.5
+  * Use tildes instead of carets for dependency listing [5296ce41]
+  * Allow clients to set a custom identityString (venables) [5373287d]
+  * bugfix (adding "-i" to sendmail command line for each new mail)  by copying this.args (vrodic) [05a8a9a3]
+  * update copyright (gdi2290) [3a6cba3a]
+
+## v0.6.4 2014-05-13
+
+  * Bumped version to v0.6.4
+  * added npmignore, bumped dependencies [21bddcd9]
+  * Add AOL to well-known services (msouce) [da7dd3b7]
+
 ## v0.6.3 2014-04-16
 
   * Bumped version to v0.6.3

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2013 Andris Reinman
+Copyright (c) 2011-2014 Andris Reinman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -13,4 +13,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -58,8 +58,8 @@ check out [simplesmtp](https://github.com/andris9/simplesmtp).
 
 To use Nodemailer with templates, please see documentation for these projects.
 
+ * [node-email-templates](https://github.com/niftylettuce/node-email-templates) - ejs, jade, swig, handlebars, less, sass, stylus, styl
  * [swig-email-templates](https://github.com/superjoe30/swig-email-templates) - swig, template inheritance, dummy context
- * [node-email-templates](https://github.com/niftylettuce/node-email-templates) - ejs
 
 ## TL;DR Usage Example
 
@@ -174,7 +174,7 @@ transport.sendMail({
 `type` parameter can be one of the following:
 
   * **SMTP** for using SMTP
-  * **SES** for using Amazon SES
+  * **SES** for using Amazon SES with AWS Identity and Access Management (IAM) roles
   * **Sendmail** for utilizing systems *sendmail* command
   * **Pickup** for storing the e-mail in a directory on your machine
   * **Direct** for sending e-mails directly to recipients MTA servers
@@ -325,15 +325,25 @@ var transportOptions = {
 
 ### Setting up SES
 
-SES is actually a HTTP based protocol, the compiled e-mail and related info
-(signatures and such) are sent as a HTTP request to SES servers.
+SES use the aws-sdk node module that wraps all the HTTP requests to SES servers.
+If running on an Amazon EC2 instance, it allows the use of IAM Roles instead of AWS credentials.
+If necessary, the AWS credentials can still be provided to the *createTransport* method or through environment variables ( AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY ).
 
-Possible SES options are the following:
+The SES options were renamed in v0.7. The new names are compatible with the naming convention of the AWS SDK for javascript in nodeJS used in Nodemailer. Thus you can pass a configuration object compatible with the AWS SDK to the createTransport() function.
 
- * **AWSAccessKeyID** - AWS access key (required)
- * **AWSSecretKey** - AWS secret (required)
- * **ServiceUrl** - *optional* API end point URL (defaults to *"https://email.us-east-1.amazonaws.com"*)
- * **AWSSecurityToken** - *optional* security token
+  Possible SES options are the following:
+
+  * **accessKeyId** - *optional* AWS access key.
+  * **secretAccessKey** - *optional* AWS secret.
+  * **sessionToken** - *optional* session token.
+  * **region** - *optional* Specify the region to send the service request to. Default to *us-east-1*
+
+  Deprecated parameters. These are kept for backward compatibility reasons to support users of Nodemailer prior to v0.7. Any new development should use the new parameters above:
+
+ * **AWSAccessKeyID** - *optional* AWS access key. The option **accessKeyId** should be used instead.
+ * **AWSSecretKey** - *optional* AWS secret. The option **secretAccessKey** should be used instead.
+ * **ServiceUrl** - *optional* API end point URL (defaults to *"https://email.us-east-1.amazonaws.com"*). The option **region** should be used instead.
+ * **AWSSecurityToken** - *optional* security token. The option **sessionToken** should be used instead.
 
 Example:
 
@@ -343,6 +353,7 @@ var transport = nodemailer.createTransport("SES", {
     AWSSecretKey: "AWS/Secret/key"
 });
 ```
+**As of v0.7, ```sendmail()``` return only ```messageId``` instead of ```message```, ```response``` and ```messageID```**
 
 ### Setting up Sendmail
 
@@ -564,6 +575,7 @@ to enter the hostname or port number, just use the `service` parameter
 
 Currently supported services are:
 
+  * **AOL**
   * **DynectEmail**
   * **Gmail**
   * **hot.ee**

package/lib/engines/sendmail.js

@@ -54,7 +54,7 @@ function SendmailTransport(config){
 SendmailTransport.prototype.sendMail = function sendMail(emailMessage, callback){
 
     var envelope = emailMessage.getEnvelope(),
-        args = this.args || ["-f"].concat(envelope.from).concat(envelope.to),
+        args = this.args ? this.args.slice() : ["-f"].concat(envelope.from).concat(envelope.to),
         sendmail,
         cbCounter = 2,
         didCb,

package/lib/engines/ses.js

@@ -2,38 +2,45 @@
 
 /*
  * This file is based on the original SES module for Nodemailer by dfellis
- * https://github.com/andris9/Nodemailer/blob/11fb3ef560b87e1c25e8bc15c2179df5647ea6f5/lib/engines/SES.js
- */
+* https://github.com/andris9/Nodemailer/blob/11fb3ef560b87e1c25e8bc15c2179df5647ea6f5/lib/engines/SES.js
+* and on the rewrite by andris9
+* https://github.com/andris9/Nodemailer/blob/3ac11ae9a9faf95aabd9bffb37ca702fe33105e4/lib/engines/ses.js
+*/
 
 // NB! Amazon SES does not allow unicode filenames on attachments!
 
-var http = require('http'),
-    https = require('https'),
-    crypto = require('crypto'),
-    urllib = require("url");
+var AWS = require('aws-sdk');
 
 // Expose to the world
 module.exports = SESTransport;
 
 /**
- * <p>Generates a Transport object for Amazon SES</p>
+ * <p>Generates a Transport object for Amazon SES with aws-sdk</p>
  *
  * <p>Possible options can be the following:</p>
  *
  * <ul>
- *     <li><b>AWSAccessKeyID</b> - AWS access key (required)</li>
- *     <li><b>AWSSecretKey</b> - AWS secret (required)</li>
- *     <li><b>ServiceUrl</b> - optional API endpoint URL (defaults to <code>"https://email.us-east-1.amazonaws.com"</code>)
+ *     <li><b>accessKeyId</b> - AWS access key (optional)</li>
+ *     <li><b>secretAccessKey</b> - AWS secret (optional)</li>
+ *     <li><b>region</b> - optional region (defaults to <code>"us-east-1"</code>)
  * </ul>
  *
  * @constructor
- * @param {Object} options Options object for the SES transport
+ * @param {Object} optional config parameter for the AWS SES service
  */
-function SESTransport(options){
+function SESTransport(options) {
+
+    var pattern = /(.*)email(.*)\.(.*).amazonaws.com/i,
+        result = pattern.exec(options.ServiceUrl);
+
     this.options = options || {};
+    this.options.accessKeyId = options.accessKeyId || options.AWSAccessKeyID;
+    this.options.secretAccessKey = options.secretAccessKey || options.AWSSecretKey;
+    this.options.sessionToken = options.sessionToken || options.AWSSecurityToken;
+    this.options.apiVersion = '2010-12-01';
+    this.options.region = options.region || (result && result[3]) || 'us-east-1';
 
-    //Set defaults if necessary
-    this.options.ServiceUrl = this.options.ServiceUrl || "https://email.us-east-1.amazonaws.com";
+    this.ses = new AWS.SES(this.options);
 }
 
 /**
@@ -42,19 +49,13 @@ function SESTransport(options){
  * @param {Object} emailMessage MailComposer object
  * @param {Function} callback Callback function to run when the sending is completed
  */
-SESTransport.prototype.sendMail = function(emailMessage, callback) {
-
+SESTransport.prototype.sendMail = function (emailMessage, callback) {
     // SES strips this header line by itself
     emailMessage.options.keepBcc = true;
 
-    //Check if required config settings set
-    if(!this.options.AWSAccessKeyID || !this.options.AWSSecretKey) {
-        return callback(new Error("Missing AWS Credentials"));
-    }
-
-    this.generateMessage(emailMessage, (function(err, email){
-        if(err){
-            return typeof callback == "function" && callback(err);
+    this.generateMessage(emailMessage, (function (err, email) {
+        if (err) {
+            return typeof callback === "function" && callback(err);
         }
         this.handleMessage(email, callback);
     }).bind(this));
@@ -66,181 +67,54 @@ SESTransport.prototype.sendMail = function(emailMessage, callback) {
  * @param {String} email Compiled raw e-mail as a string
  * @param {Function} callback Callback function to run once the message has been sent
  */
-SESTransport.prototype.handleMessage = function(email, callback) {
-    var request,
-        date = new Date(),
-        urlparts = urllib.parse(this.options.ServiceUrl),
-        pairs = {
-            'Action': 'SendRawEmail',
-            'RawMessage.Data': (new Buffer(email, "utf-8")).toString('base64'),
-            'Version': '2010-12-01',
-            'Timestamp': this.ISODateString(date)
-        };
-
-    if (this.options.AWSSecurityToken) {
-        pairs.SecurityToken = this.options.AWSSecurityToken;
-    }
-
-    var params = this.buildKeyValPairs(pairs),
-
-        reqObj = {
-            host: urlparts.hostname,
-            path: urlparts.path || "/",
-            method: "POST",
-            headers: {
-                'Content-Type': 'application/x-www-form-urlencoded',
-                'Content-Length': params.length,
-                'Date': date.toUTCString(),
-                'X-Amzn-Authorization':
-                    ['AWS3-HTTPS AWSAccessKeyID='+this.options.AWSAccessKeyID,
-                    "Signature="+this.buildSignature(date.toUTCString(), this.options.AWSSecretKey),
-                    "Algorithm=HmacSHA256"].join(",")
+SESTransport.prototype.handleMessage = function (email, callback) {
+    var params = {
+            RawMessage: { // required
+                Data: new Buffer(email, "utf-8") // required
             }
         };
-
-    //Execute the request on the correct protocol
-    if(urlparts.protocol.substr() == "https:") {
-        request = https.request(reqObj, this.responseHandler.bind(this, callback));
-    } else {
-        request = http.request(reqObj, this.responseHandler.bind(this, callback));
-    }
-    request.end(params);
-
-    // Handle fatal errors
-    request.on("error", this.errorHandler.bind(this, callback) );
+    this.ses.sendRawEmail(params, this.responseHandler.bind(this, callback));
 };
 
-
-
-/**
- * <p>Handles a fatal error response for the HTTP request to SES</p>
- *
- * @param {Function} callback Callback function to run on end (binded)
- * @param {Object} response HTTP Response object
- */
-SESTransport.prototype.errorHandler = function(callback, err) {
-    if( ! ( err instanceof Error) ) {
-        err = new Error('Email failed ' + ("statusCode" in err ? err.statusCode : null ), {response:err});
-    }
-    return typeof callback == "function" && callback(err, null);
-};
-
-
 /**
  * <p>Handles the response for the HTTP request to SES</p>
  *
  * @param {Function} callback Callback function to run on end (binded)
- * @param {Object} response HTTP Response object
+ * @param {Object} err Error object returned from the request
+ * @param {Object} data De-serialized data returned from the request
  */
-SESTransport.prototype.responseHandler = function(callback, response) {
-    var body = "", match;
-    response.setEncoding('utf8');
-
-    //Re-assembles response data
-    response.on('data', function(d) {
-        body += d.toString();
-    });
-
-    //Performs error handling and executes callback, if it exists
-    response.on('end', function(err) {
-        if(err instanceof Error) {
-            return typeof callback == "function" && callback(err, null);
+SESTransport.prototype.responseHandler = function (callback, err, data) {
+    if (err) {
+        if (!(err instanceof Error)) {
+            err = new Error('Email failed: ' + err);
         }
-        if(response.statusCode != 200) {
-            return typeof callback == "function" &&
-                callback(new Error('Email failed: ' + response.statusCode + '\n' + body), {
-                    message: body,
-                    response: response
-                });
-        }
-        match = (body || "").toString().match(/<MessageId\b[^>]*>([^<]+)<\/MessageId\b[^>]*>/i);
-        return typeof callback == "function" && callback(null, {
-            message: body,
-            response: response,
-            messageId: match && match[1] && match[1] + "@email.amazonses.com"
-        });
+        return typeof callback === "function" && callback(err, null);
+    }
+    return typeof callback === "function" && callback(null, {
+        messageId: data && data.MessageId && data.MessageId + "@email.amazonses.com"
     });
 };
 
 /**
  * <p>Compiles the messagecomposer object to a string.</p>
  *
- * <p>It really sucks but I don't know a good way to stream a POST request with
- * unknown legth, so the message needs to be fully composed as a string.</p>
+ * <p>SES requires strings as parameter so the message needs to be fully composed as a string.</p>
  *
  * @param {Object} emailMessage MailComposer object
  * @param {Function} callback Callback function to run once the message has been compiled
  */
 
-SESTransport.prototype.generateMessage = function(emailMessage, callback) {
+SESTransport.prototype.generateMessage = function (emailMessage, callback) {
     var email = "";
 
-    emailMessage.on("data", function(chunk){
+    emailMessage.on("data", function (chunk) {
         email += (chunk || "").toString("utf-8");
     });
 
-    emailMessage.on("end", function(chunk){
+    emailMessage.on("end", function (chunk) {
         email += (chunk || "").toString("utf-8");
         callback(null, email);
     });
 
     emailMessage.streamMessage();
 };
-
-/**
- * <p>Converts an object into a Array with "key=value" values</p>
- *
- * @param {Object} config Object with keys and values
- * @return {Array} Array of key-value pairs
- */
-SESTransport.prototype.buildKeyValPairs = function(config){
-    var keys = Object.keys(config).sort(),
-        keyValPairs = [],
-        key, i, len;
-
-    for(i=0, len = keys.length; i < len; i++) {
-        key = keys[i];
-        if(key != "ServiceUrl") {
-            keyValPairs.push((encodeURIComponent(key) + "=" + encodeURIComponent(config[key])));
-        }
-    }
-
-    return keyValPairs.join("&");
-};
-
-/**
- * <p>Uses SHA-256 HMAC with AWS key on date string to generate a signature</p>
- *
- * @param {String} date ISO UTC date string
- * @param {String} AWSSecretKey ASW secret key
- */
-SESTransport.prototype.buildSignature = function(date, AWSSecretKey) {
-    var sha256 = crypto.createHmac('sha256', AWSSecretKey);
-    sha256.update(date);
-    return sha256.digest('base64');
-};
-
-/**
- * <p>Generates an UTC string in the format of YYY-MM-DDTHH:MM:SSZ</p>
- *
- * @param {Date} d Date object
- * @return {String} Date string
- */
-SESTransport.prototype.ISODateString = function(d){
-    return d.getUTCFullYear() +             '-' +
-           this.strPad(d.getUTCMonth()+1) + '-' +
-           this.strPad(d.getUTCDate()) +    'T' +
-           this.strPad(d.getUTCHours()) +   ':' +
-           this.strPad(d.getUTCMinutes()) + ':' +
-           this.strPad(d.getUTCSeconds()) + 'Z';
-};
-
-/**
- * <p>Simple padding function. If the number is below 10, add a zero</p>
- *
- * @param {Number} n Number to pad with 0
- * @return {String} 0 padded number
- */
-SESTransport.prototype.strPad = function(n){
-    return n<10 ? '0'+n : n;
-};

package/lib/nodemailer.js

@@ -89,6 +89,10 @@ function Nodemailer(options){
 
     mailcomposerOptions.identityString = X_MAILER_NAME + " " + packageData.version;
 
+    if(this.options.identityString){
+        mailcomposerOptions.identityString = this.options.identityString;
+    }
+
     if(this.options.encoding){
         mailcomposerOptions.encoding = this.options.encoding;
     }
@@ -171,22 +175,25 @@ Nodemailer.prototype.getGlobalTransport = function(){
  * @param {Function} callback Callback function to run after validation
  */
 Nodemailer.prototype.validateSettings = function(callback){
-    if(!this.transport || !this.transport.transport){
-        return callback(new Error("No transport method defined"));
-    }
+    var self = this;
+    process.nextTick(function(){
+        if(!self.transport || !self.transport.transport){
+            return callback(new Error("No transport method defined"));
+        }
 
-    // transport.options.resolveHostname is set to true, resolve pulbic
-    // hostname for the machine and use this when generating Message-ID values
-    // or when communicating with SMTP
-    if(this.transport.options && this.transport.options.resolveHostname && !this.transport.options.name){
-        return publicHostnameResolver.resolve((function(err, resolved){
-            this.transport.options.name = this.resolveHostname(
-                resolved ? resolved.hostname : this.options.name);
-            callback();
-        }).bind(this));
-    }
+        // transport.options.resolveHostname is set to true, resolve pulbic
+        // hostname for the machine and use self when generating Message-ID values
+        // or when communicating with SMTP
+        if(self.transport.options && self.transport.options.resolveHostname && !self.transport.options.name){
+            return publicHostnameResolver.resolve((function(err, resolved){
+                self.transport.options.name = self.resolveHostname(
+                    resolved ? resolved.hostname : self.options.name);
+                callback();
+            }).bind(self));
+        }
 
-    callback(null);
+        callback(null);
+    });
 };
 
 /**

package/lib/wellknown.js

@@ -161,9 +161,17 @@ module.exports = {
         domains: ['fastmail.fm']
     },
     "SendCloud": {
-        transport: "SMPT",
+        transport: "SMTP",
         host: "smtpcloud.sohu.com",
         port: 25,
         requiresAuth: true
+    },
+    // http://help.aol.com/help/microsites/microsite.do?cmd=displayKC&externalId=73332
+    "AOL":{
+        transport: "SMTP",
+        host: "smtp.aol.com",
+        port: 587,
+        requiresAuth: true,
+        domains: ["aol.com"]
     }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nodemailer",
   "description": "Easy to use module to send e-mails, supports unicode and SSL/TLS",
-  "version": "0.6.3",
+  "version": "0.7.1",
   "author": "Andris Reinman",
   "maintainers": [
     {
@@ -25,11 +25,12 @@
     }
   ],
   "dependencies": {
-    "mailcomposer": "~0.2.7",
-    "simplesmtp": "~0.2 || ^0.3.25",
-    "directmail": "~0.1.6",
+    "mailcomposer": "~0.2.10",
+    "simplesmtp": "~0.2 || ~0.3.30",
+    "directmail": "~0.1.7",
     "he": "~0.3.6",
-    "public-address": "~0.1.0"
+    "public-address": "~0.1.1",
+    "aws-sdk": "2.0.5"
   },
   "devDependencies": {
     "nodeunit": "*"

package/.travis.yml

@@ -1,12 +0,0 @@
-language: node_js
-node_js:
-  - 0.8
-  - "0.10"
-  - "0.11"
-
-notifications:
-  email:
-    recipients:
-      - andris@kreata.ee
-    on_success: change
-    on_failure: change

package/CONTRIBUTING.md

@@ -1,11 +0,0 @@
-# Contributing
-
-All SMTP related issues are high priority. Report these here or at [simplesmtp](https://github.com/andris9/simplesmtp).
-
-"Sendmail" transport related issues are low priority. If you want something to get fixed, making a pull request instead of filing an issue helps a lot to speed things up. Most probably the issue is related with a specific sendmail implementation and I'm not able to test every sendmail clone out there.
-
-When making a pull request try not to introduce anything that is not backwards compatible.
-
-## Formatting
-
-Use 4 spaces instead of tabs. Commas last. Use double quotes instead of single quotes where possible.