📦 bulk-mail-cli

The free MailChimp in your terminal!

🦋 Introduction

The YouTube video given below should succesfully enlighten you about what exactly is being developed here.

VIDEO IS STILL BEING EDITED...

👌 What the hell does it do?...

Well, there's so much more being planned under the hood. Will update new developments sooner. You may see a GUI version of bulk-mail-cli in the future!

💃 Some examples of what's upcoming...

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 Template and CSV file

To generate demo files on your Desktop!

$ bulkmail demo

Shoot the mails after you feed 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 to complete the process. It will also ask for the path of the Template and CSV file.

Just like what you see below:

$ bulkmail mail

Please fill in the needed data...
service: gmail/yahoo/custom
email: yourEmail@domain.com
password: •••••••••••••••••

Wow! You are connected 😀

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

From name: John Doe
Subject: Subject of the mail

There you go!.. Now, it is all my task!

Bulk Mail in progress:
[-------------------------------------------------->] 100%

Mails sent 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

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 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 Mail Templates

• Any dynamic value which is listed in the CSV file should only be denoted by {{ <column name> }}.
• For example,, if you have an fname column in the respective CSV file, just write {{ fname }} in the HTML Mail Template to print the first name of the respective recipient.
• You may style your Mail Template using HTML and CSS. Please be sure to use inline styles or a <styles>...</styles> HTML block (Whatever you are convenient with 😉)

Available in 10 major languages

$ bulkmail config --lang

FEW MORE THINGS ARE STILL UNDER DEVELOPMENT. WANNA CONTRIBUTE?

👮 Wanna contribute?

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 Twitter →