It sends automated, dynamic and beautifully designed HTML emails to your mailing list via your terminal! 😎
Ever felt a quick need to shoot a fabulous mail to your subscribers? Without any inconvenience of creating complex campaigns with MailChimp and MailGun? Just open your terminal, input the CSV and HTML file with dynamic text, and just shoot the mails with bulk-mail-cli!
Following YouTube video is a tutorial of using bulk-mail-cli like a PRO!
Note: This project is yet an MVP (Minimum Viable Product). Right now, it doesn't work on Windows machines. Working to make it cross-platform. SORRY TO KEEP YOU WAITING!
Assuming that you have node and npm installed... Run the following in your terminal.
$ npm i -g --only=prod bulk-mail-cli
Just run bulkmail in your terminal to see what commands and flags you can use to do awesome things.
To generate demo files, paste the following command.
$ bulkmail demo
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-emailcolumn name of the CSV file to justemailso 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.
This feature was introduced in v0.9.0
You may add any other column featuring custom data. Namely fname, lname, address, etc... to use in the Subject and Body of your campaign mail.
- For most use cases, the
bulkmail demoserved 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 demoserved HTML template, ensure that you edit and tailor the email template file according to your needs.
- Wanna display the
fnamefield of the user you listed in CSV file? Just add({#fname#})anywhere you want in the HTML template! - You may add any fieldname that exists in the CSV file, or else the dynamic text won't render.
❌ ({# customfield#})
❌ ({#customfield #})
❌ ({# customfield #})
❌ ({customfield})
✅ ({#customfield#})
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: Hi ({#fname#})! Here's your 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.
Just type in the given command and see bulk-mail-cli automatically asking for the credentials again!
$ bulkmail config --auth
- Time Interval after every mail.
- Internationalization. Will soon be available in 4-5 major languages.
- UX and Performance improvement.
LET US DEVELOP THIS PROJECT TOGETHER. WANNA CONTRIBUTE?
Fork this project.
Clone the forked project on your local machine.
Create a new branch in cloned project named PR/{whatever} and work there.
Run npm i in the project directory.
Do the magic you wanted to.
Run npm run build to check if everything works good so far.
And if you are done, just shoot a Pull Request at development branch of bulk-mail-cli...
Get your Pull Request merged...
GPL © Kumar Abhirup
Follow me 👋 on Twitter →