1.0.1 • Published 10 months ago
@nithin-sivakumar/mail-sender v1.0.1
Nodemailer Mail Sender
A simple utility for sending emails using Gmail's SMTP server via Nodemailer.
Installation
You can install this package using npm:
npm install nodemailer-mail-sender
Usage
- Configure the transporter with your Gmail credentials:
import { config, sendMail } from "nodemailer-mail-sender";
// Configure with your Gmail email and app password
config("your-email@gmail.com", "your-app-password");
Note: You can generate an App Password for Gmail if you have 2-Step Verification enabled on your Google account.
- Send an email:
Once the transporter is configured, you can use the sendMail
function to send an email.
sendMail(
"recipient@example.com", // Recipient's email address
"Email Subject", // Email Subject
"<h1>Welcome!</h1><p>This is a test email.</p>" // HTML content of the email
);
Default Parameters
- Subject: The default subject is
"Sent using Mail Sender"
. - Content: The default content is
"Test Email"
.
You can override these parameters when calling sendMail
.
Example
Here is a full example showing how to send an email:
import { config, sendMail } from "nodemailer-mail-sender";
// Configure the transporter with your Gmail credentials
config("your-email@gmail.com", "your-app-password");
// Send an email with custom subject and content
sendMail(
"recipient@example.com",
"Welcome to My Service",
"<h1>Hello!</h1><p>This is your welcome email.</p>"
);
Features
- Simple configuration using Gmail email and app password.
- Uses Nodemailer to send emails over secure connections (TLS).
- Easily configurable to send emails using any SMTP service.