Sending personal emails to LOTS of people should not be a pain in the ass. Helot lets you send an email to a CSV list of recipients, based on a Markdown template.
This project was developed entirely in my browser using SourceLair.
To install Helot just run npm install -g helot.
To send an email to a CSV list of recipients with Helot, run the following command in your terminal:
helot --template=/path/to/template.md --recipients=/path/to/recipients.csv
The Command Line Interface of Helot can be configured using the following options:
The path to the front-matter enabled Markdown template that Helot should parse and render with each recipient's data.
---
subject: Party next week
---
Hello {{ name }},
Next week we are throwing a party at **Awesome Place**. What about leaving {{ address }} and coming over?
It would be awesome to meet there and have fun.
Looking forward to seeing you.
Cheers,
Paris
The path to the recipients file that will be used to send the emails and render each template.
name,email,address
John Doe,john@example.com,1 Sesame str.
Bob,bob@example.com,1024 Public Rd.
Alice,alice@example.com,2048 Private Rd.
Path to a file to which output should be written instead of stderr.
Don't send any email. Just print the output.
Path to a file that contains environment variables to load. Default value: .env
SMTP_SERVER=smtp.gmail.com
SMTP_PORT=465
SMTP_LOGIN=youremail@gmail.com
SMTP_PASSWORD=your email password
HELOT_FROM=Your name <youremail@gmail.com>
Helot should be configured to send emails through an SMTP server. Configuration should happen using the environment variables documented below.
This is the address of the SMTP server that will send the emails. Example value: smtp.gmail.com.
This is the port used to access the SMTP server that will send the emails. Example value: 465.
This is the login (username) used to authenticate with the SMTP server that will send the emails. Example value: youremail@gmail.com.
This is the password used to authenticate with the SMTP server that will send the emails, along with the given SMTP login/username. Example value: your email password.
This is the address from which the emails will be sent. Example value: Paris Kasidiaris <paris@sourcelair.com>.
Default value: If this environment variable is not configured it will fall back to the value of SMTP_LOGIN.
Helot is licensed under the MIT License. Detailed license info can be found at the LICENSE file.
FAQs
Painless personal email sending to LOTS of people
The npm package helot receives a total of 1 weekly downloads. As such, helot popularity was classified as not popular.
We found that helot demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.