Skip to content
Compile pairs of names & email addresses into an RFC 2822 string
Branch: master
Clone or download
Latest commit e7d3fe0 Feb 16, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test Initial commit with working tests Nov 3, 2014
.gitignore Initial commit with working tests Nov 3, 2014
.jshintrc Initial commit with working tests Nov 3, 2014
.travis.yml
Gruntfile.js Initial commit with working tests Nov 3, 2014
LICENSE Initial commit with working tests Nov 3, 2014
README.md README syntax highlighting Oct 4, 2016
package.json

README.md

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: "john@example.com"
});

// returns
'John Smith <john@example.com>'

Or a list:

addresscompiler.compile([{
    name: "Bach, Sebastian",
    address: "sebu@example.com"
}, {
    name: "Mozzie",
    address: "mozart@example.com"
}]);

// returns
'"Bach, Sebastian" <sebu@example.com>, Mozzie <mozart@example.com>'

And when using groups

addresscompiler.compile([{
    name: "Composers",
    group: [{
        address: "sebu@example.com",
        name: "Bach, Sebastian"
    }, {
        address: "mozart@example.com",
        name: "Mozzie"
    }]
}]);

// returns
'Composers:"Bach, Sebastian" <sebu@example.com>, Mozzie <mozart@example.com>;'

See also

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.
You can’t perform that action at this time.