premailer-api
v1.0.4
Published
Node wrapper for the Premailer API (premailer.dialect.ca/api)
Downloads
4,531
Maintainers
Readme
node-premailer
A simple api wrapper for http://premailer.dialect.ca, a great tool for inlining css before you send an email.
node-premailer simplifies api integration by calling the Premailer API to inline css styles (and other options such as removing comments, classes and ids), then retrieving the generated html and text from their respective URLs before passing them to your callback.
Install
Or from source:
Usage
var premailer = require('premailer-api');
var emailTemplate = '
<html>
<head>
<title>My Email</title>
<style type="text/css">
a { color: #336699; }
</style>
</head>
<body>
Styles inlined with
<a href="http://premailer.dialect.ca">Premailer</a> via
<a href="https://github.com/JedWatson/node-premailer">node-premailer</a>.
</body>
<html>';
premailer.prepare({html: emailTemplate }, function(err, email) {
res.send(email.html);
});
Options
- premailerAPI (string) The URL of the premailer API. If you're running your own, replace this. Defaults to http://premailer.dialect.ca/api/0.1/documents
- html (string) The html of the email to parse and inline styles.
- url (string) The url of the email to fetch then parse and inline styles.
- fetchHTML (boolean) Whether to fetch the parsed HTML (you'll usually want this). Defaults to true.
- fetchText (boolean) Whether to fetch the auto-generated text version (disable this if you are providing your own). Defaults to true.
- See http://premailer.dialect.ca/api for full list of options. All options have aliases for node.js style variable names.
adapter
baseUrl
||base_url
lineLength
||line_length
linkQueryString
||link_query_string
preserveStyles
||preserve_styles
removeIds
||remove_ids
removeClasses
||remove_classes
removeComments
||remove_comments
License and Credits
MIT Licensed. Copyright Jed Watson 2016.
A big thank you to Dialect for Premailer, and for making the API freely available.
There's also a web version available here: http://premailer.dialect.ca
And you can check out the source code for Premailer itself here: https://github.com/alexdunae/premailer/