Fixes to library to parse "some@email.com (comments) <some@email.com>"

[chesnokovilya]

There are a lot of mail addresses written in the form some@email.com (comments) <some@email.com>
Currently library does not parse them correctly. (it would output undefined when parsing this name)

This is causing some issues with pgp (pretty good privacy) realisations:
openpgpjs/openpgpjs#918

In this pull request I fix this behaviour to correctly parse displayName with @. Secondly comments are correctly parsed and outputted as concatenated string.

[tomholub]

@jackbearheart gentle ping. Thanks!

[twiss]

This library aims to implement RFC 5322, while OpenPGP clients are more lenient than that. I've created a fork using these commits at https://github.com/openpgpjs/email-addresses, but it might not be appropriate to include them in the original, as these User IDs are not in fact RFC 5322 compliant.

[jackbearheart]

Thanks for the PR! I appreciate you folks wanting to contribute this upstream if possible.

twiss is correct in my intent here. This PR as is isn't right for this library because it would change the default behavior to be non-rfc compliant. What we could do is add an option acceptAtSignInDisplayName (or something more concise) that enables this. There are some other options like this floating around.

[chesnokovilya]

ok, I will look at the option path.
What do you think regarding concatenating comments @jackbearheart? Currently library make comments on email unaccessible.

[jackbearheart]

@chesnokovilya concatenating comments like you did seems reasonable

[chesnokovilya]

I have updated PR. Now this feature is behind option atInDisplayName which is false by default.
@jackbearheart

[jackbearheart]

@chesnokovilya Great, thank you! I haven't had the chance to merge and release this yet, but from a brief look I think it is good. I'll do this when I have a moment.

[chesnokovilya]

Great

[JoeNyland]

@jackbearheart Any chance this can be merged and a new release out out soon, please?

[jackbearheart]

Yes, I'll do that now. Apologies for the delay...

[jackbearheart]

I published this in version 3.1.0. I made some minor changes to preserve backwards compatibility. Thank you!

[JoeNyland]

Awesome, thank you!