mailquick

📬 mailQuick

mailQuick is a versatile email sending module for Node.js that supports multiple email service providers. Whether you use MailerSend, SendGrid, Mailjet, Brevo, or Postmark, mailQuick simplifies sending emails through a unified interface. 🚀

🔧 Installation

To get started with mailQuick, you need to install it via npm:

npm install mailquick

🛠️ Configuration

To use mailQuick, you'll need to initialize it with your email service provider's credentials. Here's a brief guide on how to configure each supported provider:

📧 Supported Providers

• MailerSend
• SendGrid
• Mailjet
• Brevo
• Postmark

📜 Example Configuration

Here's how you can set up mailQuick for different providers:

const mailQuick = require('mailquick');

// Initialize with provider and credentials
const mailer = mailQuick.init({
    provider: 'sendgrid',
    apiKey: 'your-sendgrid-api-key',
    from: '[e-mail]',
    fromName: 'Your Name'
});

// Send an email
mailer.send({
    to: '[e-mail]',
    subject: 'Hello World',
    html: '<p>This is a test email sent using mailQuick!</p>'
}).then(response => {
    console.log(response); // { status: true, message: 'Mail sent' }
}).catch(error => {
    console.error(error); // { status: false, message: 'Mail not sent' }
});

🛠️ Provider-Specific Setup

MailerSend

const mailer = mailQuick.init({
    provider: 'mailersend',
    apiKey: 'your-mailersend-api-key',
    from: '[e-mail]',
    fromName: 'Your Name'
});

SendGrid

const mailer = mailQuick.init({
    provider: 'sendgrid',
    apiKey: 'your-sendgrid-api-key',
    from: '[e-mail]',
    fromName: 'Your Name'
});

Mailjet

const mailer = mailQuick.init({
    provider: 'mailjet',
    apiKey: 'your-mailjet-api-key',
    apiSecret: 'your-mailjet-api-secret',
    from: '[e-mail]',
    fromName: 'Your Name'
});

Brevo

const mailer = mailQuick.init({
    provider: 'brevo',
    apiKey: 'your-brevo-api-key',
    from: '[e-mail]',
    fromName: 'Your Name'
});

Postmark

const mailer = mailQuick.init({
    provider: 'postmark',
    apiKey: 'your-postmark-api-key',
    from: '[e-mail]',
    fromName: 'Your Name'
});

SMTP

const mailer = mailQuick.init({
    provider: 'smtp',
    apiKey: 'your-email-password-or-app-password',
    from: '[e-mail]',
    fromName: 'Your Name',
    server: 'smtp.your-email-provider.com',
    port: 465,
    secure: true
});

🌐 Usage

Use the send method to dispatch an email. The required parameters are:

• to - Recipient email address.
• subject - Email subject.
• html - Email body in HTML format.

Example:

mailer.send({
    to: '[e-mail]',
    subject: 'Welcome!',
    html: '<p>Thanks for signing up with mailQuick!</p>'
}).then(response => {
    console.log(response); // { status: true, message: 'Mail sent' }
}).catch(error => {
    console.error(error); // { status: false, message: 'Mail not sent' }
});

🛡️ Error Handling

If something goes wrong, mailQuick will return an object with status: false and a corresponding error message. Always handle these responses to ensure proper error management.

💬 Contributing

We welcome contributions to mailQuick! If you have suggestions, bug fixes, or improvements, please submit a pull request or open an issue on our GitHub repository.

📝 License

mailQuick is licensed under the MIT License. See LICENSE for more details.

👋 Acknowledgments

Special thanks to the maintainers and contributors of the email service providers' APIs for making this package possible.