coldmailer

Coldmailer is a light weight tool that redefines email automation with its streamlined command line interface, designed to effortlessly send custom emails to many recipients.

Installation

Clone the this repository

$ git clone https://github.com/Aphrotee/coldmailer.git

Go into the directory:

$ cd coldmailer

You need the latest version of nodejs: Download for windows, download for linux.

$ npm install

Configuration

Create a csv file named data.csv containing the fields name, email and company. A csv file can be created by creating an spreadsheet having the above data fields with microsoft excel or google sheets and then exporting to csv. Make sure the csv file is named data.csv and is located at the root of this folder.

Make sure there are no empty lines in the csv file.

Update the mailconfig.json file with the appropriate details.

email is the email address to be used to send the emails.

password is a 16 - character app password generated on your google account and NOT your google account login password. Here's a guide to generate an app password.

senderName is the name that should apper on the email as stating the sender name.

The config file should look like this: { "email": "johndoe@gmail.com", "password": "bdunpwsaiebyrtom", "senderName": "John Doe" }

For the email subject and email body, the contents are to be put in the subject.txt and message.txt files respectively. The content can be customised for each recipient using the name and company in the csv file.

Here is an example:

Hi {name}, I would love an opportunity at {company} to enhance my skills while solving cmoplex problems in the society.

For a recipient with name: Anderson, company: Google, email: anderson@gmail.com, the above will be translated to:

Hi Anderson, I would love an opportunity at Google to enhance my skills while solving cmoplex problems in the society.

Incase you're wondering how to include an attatchment, yeah you can't (for now).

But what you can do is to upload that attachment to google drive (or whatever cloudstorage service you use) make it available to anyone to access and include a link to it in the email.

Workflow

Here is a diagram detailing the workflow of coldmailer and how the functions communicate and work together to help you send mails.

Usage

There are two ways to use Coldmailer: through the Command Line Interface (CLI) or via the API.

CLI Usage

Run the following commands:

$ npm run build

$ npm start

NOTE: Because of the possible internet issues while the program runs, you are limited to sending 100 emails at a time in order to ensure all emails are sent succesfully, so yor csv file should not have more that 100 rows of data.

All errors come with reasons causing them and ways to resolve such errors.

API Usage

Coldmailer provides an API endpoint to send emails programmatically.

1. Start the server:

First, build the project: $ npm run build

Then, start the API server: $ npm run serve

The server will be running on http://localhost:3000.

2. Send Emails:

Make a POST request to the /send-emails endpoint with a multipart/form-data payload containing the following fields:

• subject (string, required): The subject of the email. You can use {name} and {company} placeholders.
• message (string, required): The body of the email. You can use {name} and {company} placeholders.
• csvFile (file, required): The CSV file containing recipient data with name, email, and company columns.

Example using cURL:

curl -X POST http://localhost:3000/send-emails 
  -F "subject=Invitation for {name}" 
  -F "message=Hello {name}, we are excited to invite you to an event at {company}." 
  -F "csvFile=@/path/to/your/data.csv"

Replace /path/to/your/data.csv with the actual path to your CSV file.

Upon success, the API will respond with a message indicating how many emails were sent successfully. If there are errors (e.g., invalid CSV format, missing fields), the API will return an appropriate error message.