multi-mailer

v1.0.4

Published

8 months ago

A flexible and easy-to-use email sending package supporting multiple providers like Brevo and Mailjet, with support for HTML and Pug templates.

Downloads

0High
0Medium
0Low

mk_lateef

email mailer nodemailer brevo mailjet sendgrid mailgun html pug

Multi-Mailer

Multi-Mailer is a flexible and easy-to-use email sending package that supports multiple providers like Brevo, Mailjet, SendGrid, and Mailgun. It allows you to send emails using HTML and Pug templates with ease.

Features

Support for multiple email providers (e.g., Brevo, Mailjet, SendGrid, Mailgun).
Send emails with dynamic data using HTML or Pug templates.
Easy configuration using environment variables.
Attachments support.

Installation

To install the package, run:

npm install multi-mailer

Configuration

Create a .env file in the root directory of your project and configure the following variables based on your SMTP provider.

For Brevo

MAIL_HOST=smtp-relay.brevo.com
MAIL_PORT=587
MAIL_USERNAME=your_brevo_username
MAIL_PASSWORD=your_brevo_password
MAIL_SECURE=false
[email protected]
TEMPLATE_PATH=src/core/helpers/mails/

For Mailjet

MAIL_HOST=in-v3.mailjet.com
MAIL_PORT=587
MAIL_USERNAME=your_mailjet_public_api_key
MAIL_PASSWORD=your_mailjet_private_api_key
MAIL_SECURE=false
[email protected]
TEMPLATE_PATH=src/core/helpers/mails/

For SendGrid

MAIL_HOST=smtp.sendgrid.net
MAIL_PORT=587
MAIL_USERNAME=apikey # Use "apikey" as the username for SendGrid
MAIL_PASSWORD=your_sendgrid_api_key
MAIL_SECURE=false
[email protected]
TEMPLATE_PATH=src/core/helpers/mails/

For Mailgun

MAIL_HOST=smtp.mailgun.org
MAIL_PORT=587
MAIL_USERNAME=your_mailgun_username
MAIL_PASSWORD=your_mailgun_password
MAIL_SECURE=false
[email protected]
TEMPLATE_PATH=src/core/helpers/mails/

Note: Ensure that the TEMPLATE_PATH environment variable points to the directory containing your email templates. For example, if your template is located at src/core/helpers/mails/welcome.html, set TEMPLATE_PATH=src/core/helpers/mails/.

Usage

Sending an Email

Here's an example of how to send a welcome email:

import {EmailService} from 'multi-mailer';

async function sendWelcomeEmail(recipientEmail: string, userName: string) {
    // Initialize the EmailService with the recipient's email
    const emailService = new EmailService(recipientEmail);

    // Define the template and parameters
    const template = "welcome.html"; // Name of the template file (e.g., welcome.html)
    const params = {
        name: userName, // Dynamic name for the template
    };

    try {
        // Send the email
        await emailService.sendEmail(template, "Welcome to Our Service", params);
        console.log(`Welcome email sent successfully to ${recipientEmail}!`);
    } catch (error) {
        console.error(`Failed to send welcome email to ${recipientEmail}:`, error);
    }
}

// Example usage: Sending a welcome email to a dynamic recipient
const recipientEmail = "[email protected]"; // Replace with the recipient's email
const userName = "John Doe"; // Replace with the user's name
sendWelcomeEmail(recipientEmail, userName);

Templates

Place your email templates in the directory specified by the TEMPLATE_PATH environment variable. Supported formats are .html and .pug.

Example welcome.html:

<html>
  <body>
    <h1>Welcome, {{name}}!</h1>
    <p>Thank you for joining our service.</p>
  </body>
</html>

License

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

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

Author

Abdullateef Mubarak