Allow comma in display name

Changes.md

@@ -1,4 +1,9 @@
 
+## 2.1.0 - 2021-02-26
+
+- make parse accept an options object as second argument
+- allow , character in display name, off by default #52
+
 ## 2.0.6 - 2020-11-17
 
 - replace travis/appveyor CI tests with Github Actions

index.js

@@ -2,11 +2,21 @@
 
 const ea_lib = require('email-addresses');
 
-exports.parse = function parse (line, startAt) {
+exports.parse = function parse (line, opts = null) {
     if (!line) throw new Error('Nothing to parse');
 
     line = line.trim();
 
+    const defaultOpts = {
+        startAt: null,
+        allowAtInDisplayName: true,
+        allowCommaInDisplayName: false,
+    }
+
+    const { startAt, allowAtInDisplayName, allowCommaInDisplayName } = typeof opts === 'object'
+        ? Object.assign({}, defaultOpts, opts)
+        : Object.assign({}, defaultOpts, { startAt: opts })
+
     const addr = ea_lib({
         input: line,
         rfc6532: true, // unicode
@@ -15,7 +25,8 @@ exports.parse = function parse (line, startAt) {
         strict: false, // turn off obs- features in the rfc
         rejectTLD: false, // domains require a "."
         startAt: startAt || null,
-        atInDisplayName: true // allow at in display name
+        atInDisplayName: allowAtInDisplayName,
+        commaInDisplayName: allowCommaInDisplayName,
     });
 
     if (!addr) throw new Error('No results');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "address-rfc2822",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "description": "RFC 2822 & 5322 (Header) email address parser",
   "main": "index.js",
   "homepage": "https://github.com/haraka/node-address-rfc2822",
@@ -31,6 +31,6 @@
   },
   "license": "MIT",
   "dependencies": {
-    "email-addresses": "^3.1.0"
+    "email-addresses": "^4.0.0"
   }
 }

test/functions.js

@@ -91,3 +91,27 @@ describe('parseReplyTo', function () {
         done();
     })
 })
+
+describe('parse with options', function () {
+    it('should not allow parsing display name with comma by default', function (done) {
+        try {
+            address.parse('Foo, Bar <foo@example.com>');
+        }
+        catch (e) {
+            assert.equal(e.message, 'No results');
+        }
+        done();
+    })
+
+    it('should allow parsing display name with comma', function (done) {
+        try {
+            const [r] = address.parse('Foo, Bar <foo@example.com>', { allowCommaInDisplayName: true });
+            assert.equal('foo@example.com', r.address);
+            assert.equal('Foo, Bar', r.phrase);
+        }
+        catch (e) {
+            console.error(e);
+        }
+        done();
+    })
+})