Skip to content

ChemicalLuck/mailmeld

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mailmeld

Mailmeld is a simple command-line tool for performing mail merges. It allows you to send personalized emails to a list of recipients by specifying the subject, message, and recipients. You can either preview the emails before sending or directly send them.

Installation

Clone the repository and build the project (if applicable):

git clone https://github.com/yourusername/mailmeld.git
cd mailmeld
cargo install --path .

Usage

Mailmeld is used from the command line. The general syntax is:

mailmeld [OPTIONS] <SUBJECT> <MESSAGE> <COMMAND>

Commands

  • send : Send the emails to the specified recipients.
  • preview : Preview the emails before sending them.

Arguments

  • <SUBJECT> : The subject line for the email.
  • <MESSAGE> : The message body of the email. You can include placeholders like {name} which will be replaced with the recipient's information.

Options

  • --recipients <RECIPIENTS> : A csv file containing a list of recipients, and any additional variables.
  • -h, --help : Print help information and exit.
  • -V, --version : Print the version of Mailmeld and exit.

Environment Variables

  • SMTP_USERNAME: The username for the SMTP server.
  • SMTP_PASSWORD: The password for the SMTP server.
  • SMTP_RELAY: The SMTP relay server address.
  • SMTP_FROM: The email address to send the emails from.
  • SMTP_REPLY_TO: The email address to reply to.

Personalisation

Both Subject and Message can be customised using Tera. fields can be added to the csv file and referenced in the subject and message using the field name in curly braces.

Examples

Send Emails

To send emails with a subject and message:

mailmeld "Important Update" "Hello {{name}},\nWe have an important update for you." send --recipients recipients.txt

Preview Emails

To preview the emails before sending them:

mailmeld "Important Update" "Hello {{name}},\nWe have an important update for you." preview --recipients recipients.txt

Contributing

If you'd like to contribute to Mailmeld, feel free to fork the repository and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages