Nine Parsecs from Milwaukee
Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

bulk-mail-cli

0.5.0 • Public • Published

bulk-mail-cli by Kumar Abhirup

Type stage npm Version Prefers Twitter



📦 bulk-mail-cli

Send automated, dynamic and beautifully designed HTML emails to your mailing list. Right from your terminal!



🦋 Introduction

Following YouTube video is a tutorial of using bulk-mail-cli like a PRO!

VIDEO IS STILL BEING EDITED...



👌 Use it in just 3 steps!...

bulk-mail-cli upcoming features

Developer's note: This project is yet an MVP (Minimum Viable Product). Right now, it does not support dynamic content in emails. Doesn't work on Windows machines. Working to make it cross-platoform. CHILL, and WAIT!



💃 Documentation

Install bulk-mail-cli

Assuming that you have node and npm installed... Run the following in your terminal.

$ npm i -g bulk-mail-cli

Get help

Just run bulkmail in your terminal to see what commands and flags you can use to do awesome things.


Generate demo Mail Templates and a CSV file

To generate demo files, paste the following command.

$ bulkmail demo

Writing data in CSV

If you use WordPress, you may just import the CSV file of users by using this plugin.

  • When you use that plugin, just change the user-email column name of the CSV file to just email so that to ensure no errors.

If you are feeding data from any other source or by manual means, please for the GOD's SAKE ensure that you list emails only under the email column.

If the CSV file has emails fed in some other coulumn name (such as user-email, allEmails, etc)... bulk-mail-cli would simply throw an error to not work at all.


Making custom designed HTML Mail Templates

  • For the most use cases, the bulkmail demo served HTML templates will do the work. But if they don't satisfy your needs, you may check for more designs online!
  • When using a bulkmail demo served HTML template, ensure that you edit and tailor the email template file according to your needs.

Shoot the mails after you curate data

If you are to send mails using Gmail, just turn on the less secure apps option here...

Done tweaking with Templates and CSV file? Done doing those configurations? It is time to send the mails!

$ bulkmail mail

Wait, bulkmail mail is not all. The CLI will then ask you for Service Credentials that you need to fill in order to complete the process. It will also ask for the path of the HTML email template and the CSV file.

Somewhat similar to what you see below:

$ bulkmail mail

Service credentials...
service: gmail/yahoo/custom
email: johndoe@example.com
password: •••••••••••••••••

Connection successful! 😀

Path to CSV: <you can use bash's auto navigating feature>
Path to Mail Template: <you can use bash's auto navigating feature>

From text: John Doe <johndoe@example.com>
Subject: Subject of the mail!

Mass Mailer started 👻
[-------------------------------------------------->] 100%

Mails sent to everyone successfully in 9.43 seconds.

Thank you for using bulk-mail-cli 😀

Credentials are asked only for the first time.


Change your Service Credentials

Just type in the given command and see bulk-mail-cli automatically asking for the credentials again!

$ bulkmail config --auth

Upcoming

  • Dynamicism in Mail Templates. Display dynamic names and messages listed in CSV file.
  • Internationalization. Will soon be available in 4-5 major languages.
  • UX and Performance improvement.

LET US DEVELOP THIS PROJECT TOGETHER. WANNA CONTRIBUTE?



👮 Wanna contribute?

bulk-mail-cli upcoming features

Step 1 🍴

Fork this project.

Step 2 🔁

Clone the forked project on your local machine.

Step 3 🗽

Create a new branch in cloned project named PR/{whatever} and work there.

️️️️️️Step 4 ✏️

Run npm i in the project directory.

Step 5 🎩

Do the magic you wanted to.

Step 6 ✏️

Run npm run build to check if everything works good so far.

Step 7 🏹

And if you are done, just shoot a Pull Request at development branch of bulk-mail-cli...

The hurray kinda step 😉 🎉

Get your Pull Request merged...



📝 License

GPL © Kumar Abhirup
Follow me 👋 on TwitterTwitter

install

npm i bulk-mail-cli

Downloadsweekly downloads

175

version

0.5.0

license

GPL-3.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability