addresscompiler

Address compiler

addresscompiler is a UMD module that allows you to compile name-addr e-mail addresses in node and the browser.

Usage

node.js and AMD

require('addresscompiler');

Global context

<!-- exposes global variable addresscompiler -->
<script src="addresscompiler.js"></script>

addresscompiler.compile

Compiles name-address e-mail addresses into a single string.

Examples

A single address:

addresscompiler.compile({
    name: "John Smith",
    address: "[e-mail]"
});

// returns
'John Smith <[e-mail]>'

Or a list:

addresscompiler.compile([{
    name: "Bach, Sebastian",
    address: "[e-mail]"
}, {
    name: "Mozzie",
    address: "[e-mail]"
}]);

// returns
'"Bach, Sebastian" <[e-mail]>, Mozzie <[e-mail]>'

And when using groups

addresscompiler.compile([{
    name: "Composers",
    group: [{
        address: "[e-mail]",
        name: "Bach, Sebastian"
    }, {
        address: "[e-mail]",
        name: "Mozzie"
    }]
}]);

// returns
'Composers:"Bach, Sebastian" <[e-mail]>, Mozzie <[e-mail]>;'

See also

• addressparser - similar library to do the inverse
• Source partially extracted from whiteout-io/mailbuild
• Python implementation

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
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.