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

grunt-mailgun

v2.0.1

Published

Send emails though mailgun as part of your build. Created to test our email template builds.

Downloads

359

Readme

NOTE: MAILGUN CHANGED THEIR API

Mailgun changed their API and released an official SDK. I'm porting this, and my other mailgun packages to the new SDK.

grunt-mailgun Code Climate Dependency Status

NPM

Send emails though mailgun as part of your build. Created to test our email template builds.

Abstract

We have a build pipeline that compiles jade and sass into inline-styled HTML pages for email msgs.

The final step is to shoot out tests of each template to make sure nothing looks wonky.

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-mailgun --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-mailgun');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade

Usage

src: is one or more files to be used as an email body. A new email will be sent for each file.

mailgun: {
  marketingTemplates: {
    options: {
      key: 'key-yourmailgunapikey',
      domain: 'example.com',
      sender: '[email protected]',
      recipient: '[email protected]',
      subject: 'This is a test email'
    },
    src: ['templates/marketing/*.html']
  }
}

mailgun task

Run this task with the grunt mailgun command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

Required:

  • key (string) - Your Mailgun API key
  • domain (string) - Your Mailgun email domain
  • sender (string) - The 'from' name and address. Acceptable domains may be restricted by your mailgun account settings
  • recipient (string | array) - One or more email addresses to send your msg to. Multiple addresses should be entered as an array.

Optional:

  • subject (string) - The subject of your email. Defaults to 'grunt-mailgun'
  • body (string) - The body content. If no files are specified in src:, the mailgun task will send a plaintext email using body for the msg content. Defaults to 'grunt-mailgun'.