Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

gulp-email-builder

Package Overview
Dependencies
Maintainers
2
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gulp-email-builder

Uses Email Builder to inline css, send email tests, and send tests to Litmus

  • 3.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
62
decreased by-31.87%
Maintainers
2
Weekly downloads
 
Created
Source

gulp-email-builder

Join the chat at https://gitter.im/Email-builder/gulp-email-builder Build Status

Uses Email Builder to inline css into HTML tags, send tests to Litmus, and send test emails to yourself.

Example:

<!DOCTYPE html>
<html>
<head>
  <!-- styles will be inlined -->
  <link rel="stylesheet" type="text/css" href="../css/styles.css">

  <!-- styles will be embedded -->
  <link rel="stylesheet" type="text/css" href="../css/otherStyles.css" data-embed>

  <!-- link tag will be preserved and styles will not be inlined or embedded -->
  <link href='http://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css' data-embed-ignore>

  <!-- styles will be inlined -->
  <style>
    p { color: red; }
  </style>

  <!-- styles will be embedded -->
  <style data-embed>
    h1 { color: black; }
  </style>
</head>
<body>
  <h1>Heading</h1>
  <p>Body</p>
</body>
</html>

You can see an example setups below

Getting Started

Install this gulp plugin next to your project's gulpfile with: npm install gulp-email-builder

Then add this line to your project's gulp.js gulp:

var emailBuilder = require('gulp-email-builder');

Documentation

Place this in your gulp file.

  gulp.task('emailBuilder', function() {
    return gulp.src(['./example/html/*.html'])
      .pipe(emailBuilder(options).build())
      .pipe(gulp.dest('./example/dist/'));
  });

Other available methods

Besides the main emailBuilder(options).build() function, the email-builder-core methods are exposed so users can use them on an individual basis.

  • emailBuilder(options).inlineCss()
  • emailBuilder(options).sendEmailTest()
  • emailBuilder(options).sendLitmusTest()

Example

...
.pipe(emailBuilder(options).sendEmailTest())
...

Options

View Email Builder options for all available options.

Complete Example

var EmailBuilder = require('gulp-email-builder');

var options = { encodeSpecialChars: true }
var builder = EmailBuilder(options);

gulp.task('emailBuilder', function() {
  return gulp.src(['./example/html/*.html'])
    .pipe(builder.build())
    .pipe(gulp.dest('./example/dist/'));
});

Troubleshooting

If you're having issues with Litmus taking forever to load a test or the title of the test is showing up as "No Subject", it is most likely an issue with the Litmus API. You can check the Litmus status page to find out if they're having any issues. If that's not the case, submit an issue and we'll look into further.

Contributors

Thanks to all contributors for helping out.

Further Reading

Release History

License

MIT

Keywords

FAQs

Package last updated on 12 Jul 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc