npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nodemailer-plugin-file2inline

v1.0.3

Published

Nodemailer plugin that will inline external files

Downloads

11

Readme

Nodemailer plugin for converting external images to email attachments

This plugin will convert external images in your nodemailer email to be inline ("CID-referenced") attachments within the email. Inline attachments are useful because they embed the image inside the actual email, so it's viewable even if the user is checking their email without an internet connection.

Local files will not be accessible with html alone. This Nodemailer plugin will take images in your email html in the form:

<img src="path/to/file.jpg">

and replace it with a CID-referenced attachment that works in all email clients.

Install

yarn add nodemailer-plugin-file2inline

or

npm install nodemailer-plugin-file2inline --save

Usage

1. Load the nodemailer-plugin-file2inline plugin:

var file2InlinePlugin = require('nodemailer-plugin-file2inline');

2. Attach it as a 'compile' handler for a nodemailer transport object

//Without options
nodemailerTransport.use('compile', file2InlinePlugin())

//With options
nodemailerTransport.use('compile', file2InlinePlugin({
	cidPrefix: "prefix_",
	htmlFilePath: "path/relative/to/the/html/file",
	maxWidth: 600
))

Options are:

  • cidPrefix: allows to set CID prefix1 {cidPrefix: 'somePrefix_'}, then all inline images will have prefix in cid, i.e.: cid:somePrefix_5fe3b631c651bdb1.
  • htmlFilePath: path to the folder where the html file is, relative to the current working folder
  • maxWidth: if this options is set, all images will have the "width" attribute set to the value

Example

var nodemailer = require('nodemailer');
var file2InlinePlugin = require('nodemailer-plugin-file2inline');

let transporter = nodemailer.createTransport({
    sendmail: true,
    newline: 'unix',
});
transporter.use('compile', file2InlinePlugin({cidPrefix: 'somePrefix_'}));
transporter.sendMail({
    from: '[email protected]',
    to: '[email protected]',
    html: '<img src="external/image.png">'
});

Changelog

  • 1.0.0 Initial release

References

1 It might be useful for reply email processing, example with MailParser

mp.on("attachment", function(attachment, mail){
    if (!attachment.contentId.includes('somePrefix')) { // process only images attached by user in reply
        // ...
    }
});

License

MIT