nodemailer-mailgun-transport - npm Package Compare versions

Comparing version 1.2.4 to 1.3.4

package.json

@@ -5,3 +5,3 @@ {
   "description": "A transport module to use with nodemailer to leverage Mailgun's REST API",
-  "version": "1.2.4",
+  "version": "1.3.4",
   "repository": {
@@ -8,0 +8,0 @@ "type": "git",

README.md

@@ -102,3 +102,16 @@ nodemailer-mailgun-transport
 ```
+## Address objects
+The "from", "to", "cc", and "bcc" fields support an address object or array of address objects. Each "name" and "address" are converted to  ```"name <address>"``` format.  "name" is optional, "address" is required. Missing or null address in object is skipped.
 
+Examples:
+```
+ from: {name: 'Sales', address: '[e-mail]'},
+ to: [{name:'Mary', address:'[e-mail]'}, {address:'[e-mail]'}]
+
+```
+is converted to:
+```
+  from: 'Sales <[e-mail]>',
+  to: 'Mary <[e-mail]>,[e-mail]'
+```
 ## Now with Consolidate.js templates
@@ -140,3 +153,3 @@
 npm install nodemailer
-npm install git+https://github.com/orliesaurus/nodemailer-mailgun-transport.git
+npm install nodemailer-mailgun-transport
 ```

src/mailgun-transport.js

@@ -70,2 +70,32 @@ 'use strict';
     },
+     function(done){
+      //convert address objects or array of objects to strings if present
+      var targets =['from','to','cc','bcc'];
+      var count =0;
+      for (var target of targets){
+        var addrsData = mailData[target];
+        if(addrsData !== null && (typeof addrsData === 'object' || Array.isArray(addrsData))){
+          var addrs= [];
+          var addresses = typeof addrsData === 'object' ? [addrsData] : addrsData;
+          for (var addr of addresses ){ 
+                if (Array.isArray(addr)){
+                  for (var add of addr){
+                    if(add.address){
+                      var final = add.name ? add.name + ' <' + add.address + '>' : add.address
+                      addrs.push(final);
+                    }
+                  }
+                } else{  
+                  if(addr.address){
+                    var final = addr.name ? addr.name + ' <' + addr.address + '>' : addr.address  
+                    addrs.push(final);
+                  }
+                }
+          }
+          mailData[target] = addrs.join();
+        }
+        count++;
+        count == 4 ? done():null;
+      }
+    },
     function (done) {
@@ -72,0 +102,0 @@ // convert nodemailer attachments to mailgun-js attachements

test/mailgun-transport.spec.js

@@ -159,2 +159,59 @@ var chai = require('chai');
   });
-});
+
+ describe('with simple address objects', function () {
+    it('should convert to standard address format', function (done) {
+      var self = this;
+
+      var data = {
+        from: {"name":'From', "address":'[e-mail]'},
+        to: {"name":'To', "address":'[e-mail]'},
+        cc: {"name":'Cc', "address":'[e-mail]'},
+        bcc: {"name":'Bcc', "address":'[e-mail]'},
+        subject: 'Subject',
+        text: 'Hello',
+      };
+      this.transport.send({
+        data: data
+      }, function () {
+        expect(self.transport.messages.send).to.have.been.calledWith({
+          from: 'From <[e-mail]>',
+          to: 'To <[e-mail]>',
+          cc: 'Cc <[e-mail]>',
+          bcc: 'Bcc <[e-mail]>',
+          subject: 'Subject',
+          text: 'Hello'
+        });
+        done();
+      });
+    });
+  });
+
+   describe('with address objects missing data or having multiple entries (array of objects)', function () {
+    it('should convert to standard address format and skip missing data', function (done) {
+      var self = this;
+
+      var data = {
+        from: {"name": null, "address":'[e-mail]'},
+        to: [{"name":'To', "address":'[e-mail]'}, {"name":null, "address":"[e-mail]"}, {"address":"[e-mail]"},{"name":undefined,"address":undefined}],
+        cc: [{"name":'Cc', "address":'[e-mail]'}, {"name":null, "address":"[e-mail]"}, {"address":"[e-mail]"},{"name":"","address":""}],
+        bcc: [{"name":'Bcc', "address":'[e-mail]'}, {"name":null, "address":"[e-mail]"}, {"address":"[e-mail]"},{"name":"Bcc4"}],
+        subject: 'Subject',
+        text: 'Hello',
+      };
+      this.transport.send({
+        data: data
+      }, function () {
+        expect(self.transport.messages.send).to.have.been.calledWith({
+          from: '[e-mail]',
+          to: 'To <[e-mail]>,[e-mail],[e-mail]',
+          cc: 'Cc <[e-mail]>,[e-mail],[e-mail]',
+          bcc: 'Bcc <[e-mail]>,[e-mail],[e-mail]',
+          subject: 'Subject',
+          text: 'Hello'
+        });
+        done();
+      });
+    });
+  });
+
+});

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19265

increased by24.64%

Lines of code

340

increased by31.27%

Number of lines in readme file

154

increased by9.22%

No dependency changes