📭 Sendix

A powerful and developer-friendly notification scheduler built with TypeScript. Easily schedule and send Emails with full control and flexibility.

✨ Features

• ✅ Custom-built scheduler
• 📦 Dual format support: CommonJS (CJS) + ECMAScript Module (ESM)
• 📧 Email reminder support (via nodemailer)
• 🕒 Flexible time-based message scheduling
• 💡 Beginner-friendly API design
• 🟢 Built with TypeScript (ESM)
• ⚡ Super lightweight and fast
• 📱 SMS support (coming soon)

🚀 Quick Start

📦 Installation

npm

npm install sendix

yarn

yarn add sendix

bun

bun add sendix

Basic Usage

// commonJS
const { sendix } = require("sendix");

or

// ES6
import { sendix } from 'sendix';

// Besic Example

sendix({
    type: "now",
    mail: {
        auth: {
            user: "[email protected]",
            pass: "password"
        },
        from: "[email protected]",
        to: "[email protected]",
        subject: "Scheduled Email",
        message: "This is a scheduled email sent using Sendix.",
    }
})

🔐 Environment Variables (optional)

Sendix uses environment variables to securely manage sensitive credentials like API keys and SMTP login information. Before using the package, make sure to configure your .env file properly. These variables allow Sendix to authenticate your email server, manage access tokens, and set the default sending email.

Create a .env file in your project root and add the following:

[email protected]
SENDIX_SMTP_PASS=wyeundhfftnghfku

Make sure to keep these credentials secure and never commit .env files to version control.

🛠 Loading Environment Variables

If you’re not using a framework that loads .env automatically, you can use dotenv:

npm i dotenv

Then, at the top of your entry file:

import 'dotenv/config';

🧪 Example Usage with Environment

import 'dotenv/config';
import { sendix } from 'sendix';


sendix({
    type: "now",
    mail: {
        auth: {
            user: process.env.SENDIX_SMTP_USER,
            pass: process.env.SENDIX_SMTP_PASS,
        },
        from: "[email protected]",
        to: "[email protected]",
        subject: "Scheduled Email",
        message: "This is a scheduled email sent using Sendix.",
    }
})

📘 Advanced Usage & Full Configuration ("Coming soon...")

Looking for more advanced use-cases like:

• Custom SMTP configuration
• Dynamic template sending
• Schedule emails for future delivery
• Daily, weekly, monthky, yearly or event-based reminders

👉 Visit the official documentation:
🔗 https://sendix.app

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to open an issue or submit a pull request.

🙋 Support & Questions

If you have any questions, feel free to reach out via GitHub Discussions or open an issue.

📜 License

This project is licensed under the MIT License.

Made with ❤️ by Al amin

⭐ Star this repo | 🐛 Report Bug | 💡 Request Feature