📧 FastForwardIt

A lightweight, flexible mailing utility built on top of Nodemailer

Send direct, bulk, templated emails, manage groups, schedule delivery, and handle attachments — all with a simple, customizable API.

📚 Documentation • 🚀 Quick Start • 💡 Installation • 🤝 Open For Contribution

📊 Package Stats & Trends

📈 Real-time NPM Statistics

🔗 NPM Package Stats (npm-stat.com)
🔗 Download Trends (npmtrends.com)

📌 Metric	🔢 Current Value
📦 Current Version
📥 Total Downloads
📅 Weekly Downloads
📦 Bundle Size
📄 License

📊 View detailed analytics:
npm-stat • npmtrends • bundlephobia

---

✨ Features

📮 Email Types ✉️ Direct emails (text & HTML) 📝 Template-based emails with variables 📢 Bulk personalized emails 📎 Attachment support (files, images, PDFs)

⚙️ Advanced Features 👥 Group management for teams & bulk sends ⏰ Scheduled & recurring emails 🔄 Retry mechanism with exponential backoff 🧪 Built-in test method for quick verification

---

📦 Installation

Choose your preferred package manager:

# Using npm
npm install fastforwardit

# Using yarn
yarn add fastforwardit

# Using pnpm
pnpm add fastforwardit

---

⚡ Quick Start

Send your first email in just a few lines:

import { Mail } from "fastforwardit";

async function main() {
  const mailer = new Mail({
    transporterOptions: {
      service: "gmail",
      auth: {
        user: process.env.EMAIL_USER,   // your email
        pass: process.env.EMAIL_PASS,   // your app password
      },
    },
    defaultFrom: process.env.EMAIL_USER,
  });

  await mailer.send({
    to: "receiver@example.com",
    subject: "Hello from FastForwardIt 👋",
    text: "This is a test email sent using FastForwardIt library.",
  });

  console.log("✅ Email sent successfully!");
}

main().catch(console.error);

💡 Tip: For more advanced examples, check out our Getting Started Guide

---

🔧 Key Use Cases

📝 Template-based Emails

await mailer.sendTemplate({
  to: "user@example.com",
  template: "welcome",
  variables: { 
    name: "John Doe", 
    company: "Acme Corp" 
  }
});

👥 Group Management

// Create groups and send bulk emails
await mailer.createGroup("team", ["john@company.com", "jane@company.com"]);
await mailer.sendToGroup("team", {
  subject: "Weekly Update",
  html: "<h1>Hello Team!</h1>"
});

⏰ Scheduled Emails

// Schedule email for later
await mailer.schedule({
  to: "client@example.com",
  subject: "Scheduled Reminder",
  text: "This is your scheduled reminder!",
  sendAt: new Date("2024-12-25T10:00:00Z")
});

---

🔑 Requirements

Requirement	Version	Notes
Node.js	≥ 16.x	LTS recommended
Email Provider	Any SMTP	Gmail, Outlook, custom SMTP
Gmail Users	App Password	Required if 2FA is enabled

---

📚 Documentation

📖 Guide	📄 Description
Getting Started	Complete setup and basic usage
Installation Guide	Detailed installation instructions
Documentation	Full method documentation

---

🌟 Why FastForwardIt?

Simple & Intuitive Easy-to-use API that gets you started in minutes

High Performance Built on Nodemailer with optimized bulk sending

Flexible Templates Support for dynamic templates and variables

Production Ready Built-in retry mechanisms and error handling

---

🤝 Contributing

We welcome contributions! Here's how you can help:

1. 🍴 Fork the repository
2. 🌿 Create a feature branch (git checkout -b feature/amazing-feature)
3. 💻 Make your changes and add tests
4. ✅ Run tests (npm test)
5. 📝 Commit your changes (git commit -m 'Add amazing feature')
6. 🚀 Push to your branch (git push origin feature/amazing-feature)
7. 🔄 Open a Pull Request

🐛 Found a Bug?

Please open an issue with:

• Bug description
• Steps to reproduce
• Expected vs actual behavior
• Environment details

💡 Feature Requests

We'd love to hear your ideas! Open an issue and tell us about the feature you'd like to see.

---

📄 License

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

---

💝 Built with ❤️ to make emailing faster & simpler

⭐ Star this repo • 📦 NPM Package • 📊 Package Analytics • 🐦 Follow us on Twitter

---

Made with 🚀 by Saish