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

bulk-gmail

v1.1.2

Published

Send bulk emails using Gmail

Downloads

5

Readme

Bulk Gmail

Version Discord Server Patreon

This is a CLI tool for sending bulk emails using Gmail.

It was originally created for Hack the Hill to send emails to all of the applicants.

Bulk Gmail is a CLI that reads from a CSV file for the lists of recipients and a directory of Handlebars email templates. It then sends emails to the recipients using the email templates.

Usage

You can send emails using the npx bulk-gmail command. The CLI will prompt you for which email template to use, the for a path to the CSV file containing the list of recipients, and your Gmail credentials. The CSV file should have the following columns:

  • id: The ID of the recipient
  • name: The name of the recipient
  • email: The email address of the recipient
  • language: The language of the recipient (en or fr)

The chosen email templates directory should contain folders for each template. Inside of those folders, there should be a text.hbs file for the text version of the email and a html.hbs file for the HTML version of the email. The email templates are written in Handlebars and they are compiled with the language data from the corresponding language.json file (in addition to name and email variables with the recipient's info).

The language.json file can also have from, subject, and meta keys. meta will be parsed as email List headers.

Here is an example of a language.json file:

{
    "en": {
        "from": "Your name",
        "subject": "Subject here",

        // These are optional free-form fields (they can be anything you want) that can be used in the email templates
        "greeting": "Hello",
        "message": [
            "This is a message",
            "It has multiple lines"
        ],
        "signature": "Your signature",
        "closing": "Your name",
        "unsubscribe": "Unsubscribe",

        // These are optional fields that will be parsed as email List headers
        "meta": {
            "help": "[email protected]?subject=Help with mailing list",
            "unsubscribe": {
                // The `{{email}}` variable will be replaced with the recipient's email address
                "url": "https://example.com/unsubscribe?email={{email}}",
                "comment": "Unsubscribe from further emails"
            },
            "id": {
                "url": "https://example.com",
                "comment": "2023 mailing list"
            }
        }
    },
    "fr": {
        "from": "Votre nom",
        "subject": "Sujet ici",

        // etc.
    }
}

Here is an example of a text.hbs file:

{{greeting}}, {{name}}!

{{#each message as |paragraph|}}
    {{paragraph}}
{{/each}}

{{signature}}

{{closing}}

{{unsubscribe}}: https://example.com/unsubscribe?email={{email}}

Here is an example of a html.hbs file:

<p>{{greeting}}, {{name}}!</p>

{{#each message as |paragraph|}}
    <p>{{paragraph}}</p>
{{/each}}

<p>{{signature}}</p>

<p>{{closing}}</p>

<a href="https://example.com/unsubscribe?email={{email}}">{{unsubscribe}}</a>

Support

Please consider supporting me on my Patreon if you like my work. You can see a list of all my projects on my website.

Bugs

You can submit bugs via Github Issues or on my Discord server.

Contact me

Come hang out on my my Discord server.

License

Copyright © 2022 arcanist

This package is under an MIT license.