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

@jamton/nodemailer-mailgun-transport-ts

v1.0.0

Published

Mailgun transport for the nodemailer library

Downloads

74

Readme

Installation

To use nodemailer-mailgun-transport, all you need to do is install the @jamton/nodemailer-mailgun-transport-ts package

$ yarn add @jamton/nodemailer-mailgun-transport-ts

# or

$ npm i @jamton/nodemailer-mailgun-transport-ts

Usage

import nodemailer from 'nodemailer';
import { MailgunTransport } from '@jamton/nodemailer-mailgun-transport-ts';

// This is your options that you retrieve from www.mailgun.com
const options = {
    auth: {
        domain: 'domain-name',
        api_key: '123456789',
    },
    host: 'api.mailgun.net',
};

const nodemailerMailgun = nodemailer.createTransport(new MailgunTransport(options));

nodemailerMailgun.sendMail({
    from: '[email protected]',
    to: '[email protected]', // An array if you have multiple recipients.
    cc:'[email protected]',
    bcc:'[email protected]',
    subject: 'Hey you, awesome!',
    'replyTo': '[email protected]',
    //You can use "html:" to send HTML email content. It's magic!
    html: '<b>Wow Big powerful letters</b>',
    //You can use "text:" to send plain-text content. It's oldschool!
    text: 'Mailgun rocks, pow pow!'
}, (err, info) => {
    if (err) {
        console.log(`Error: ${err}`);
    }
    else {
        console.log(`Response: ${info}`);
    }
});

The "from", "to", "cc", and "bcc" fields support an address object or array of address objects. Each "name" and "address" are converted to "name <address>" format. "name" is optional, "address" is required. Missing or null address in object is skipped.

Example:

 from: {name: 'Sales', address: '[email protected]'},
 to: [{name:'Mary', address:'[email protected]'}, {address:'[email protected]'}]

Is converted to:

 from: 'Sales <[email protected]>',
 to: 'Mary <[email protected]>,[email protected]'

To use consolidate.js templates locally, give the template key an object instead that contains a name key, an engine key and, optionally, a context object. For example, you can use Handlebars templates to generate the HTML for your message like so:

const contextObject = {
  variable1: 'value1',
  variable2: 'value2'
};

nodemailerMailgun.sendMail({
  from: '[email protected]',
  to: '[email protected]', // An array if you have multiple recipients.
  subject: 'Hey you, awesome!',
  template: {
    name: 'email.hbs',
    engine: 'handlebars',
    context: contextObject
  }
}, (err, info) => {
  if (err) {
    console.log(`Error: ${err}`);
  }
  else {
    console.log(`Response: ${info}`);
  }
});