https://github.com/mythicapp/mailing

Mailing script to invite everyone from the waitlist to download Mythic via email.
https://github.com/mythicapp/mailing

Last synced: 8 months ago
JSON representation

Mailing script to invite everyone from the waitlist to download Mythic via email.

• Host: GitHub
• URL: https://github.com/mythicapp/mailing
• Owner: MythicApp
• Created: 2024-03-05T16:07:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-03T22:42:32.000Z (about 2 years ago)
• Last Synced: 2025-02-10T21:52:24.694Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://getmythic.app
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Mythic Emailing

This project is a script for sending welcome emails to users based on a CSV file.

## Installation

1. Clone the repository.

2. Install the dependencies by running `bun i`.

## Usage

1. Place your CSV file in the `files` directory.

2. Set the required environment variables by renaming the `.env.example` file to `.env` and filling in the following values:

    - `HOST`: SMTP host for sending emails.

    - `PORT`: SMTP port.

    - `SECURE`: Set to `true` if the connection should be secure.

    - `AUTH_USER`: SMTP username.

    - `AUTH_PASS`: SMTP password.

    - `FROM_EMAIL`: Email address to use as the sender.

3. Run the script by executing `bun index.ts`.

## Email Template

The welcome email template is defined in the `mailOptions` object under `html` in the code. You can customize the HTML content to fit your needs.

## Dependencies

- `fs`: File system module for reading the CSV file.

- `path`: Path module for resolving file paths.

- `csv-parse`: CSV parsing library for parsing the CSV file.

- `nodemailer`: Library for sending emails.