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

iffr-ticket-mailer

v1.1.0

Published

A small node.js library for sending an email with an e-ticket attachment via [Mailgun](https://www.mailgun.com/).

Downloads

1

Readme

IFFR Ticket Mailer

A small node.js library for sending an email with an e-ticket attachment via Mailgun.

Installation

Installing using npm:

npm i iffr-ticket-mailer

Usage

const ticketMailer = new TicketMailer('my-mailgun-api-key', 'my-domain.com', 'path/to/render/directory/');
ticketMailer.send('path/to/e-ticket/template', 'path/to/email/template', 'email subject', 'SenderName <[email protected]>', '[email protected]', 'myQrCode', {});

Templates

The Handlebars template engine is used for rendering the attachment and email template. The data property that is passed to the send function will be available in the templates.

For display purposes the rendered QR code will be added to the template data on the property ___QRCode. This contains a Data URI representation of the QR Code image. In the attachment template this can be used like <img src="{{___QRCode}}" width="150" height="150">.

API

constructor(apiKey, domain, renderDir)

Property | Type | Description --- | --- | --- apiKey | string | Mailgun api key. domain | string | Mailgun domain. renderDir | string | Path to the directory where attachment pdf's will be rendered to.

.send(subject, from, to, emailTemplatePath, emailTemplateData, attachments)

Send e-ticket by email.

Property | Type | Description --- | --- | --- subject | string | Subject line of the email. from | string | Sender email address. to | string | Recipient email address. emailTemplatePath | string | Path to the email handlebars template. emailTemplateData | string | Template data that will be passed to the email template on render. attachments | string | Collection of attachments that will be send with the email. See description below.

Attachments

Property | Type | Description --- | --- | --- templateFilePath | string | Path to the attachment handlebars template. token | string | QR code that will be rendered on the ticket. data | object | Template data that will be passed to the email and attachment template on render.