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. 🚀
To get started with mailQuick, you need to install it via npm:
npm install mailquickTo 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:
- MailerSend
- SendGrid
- Mailjet
- Brevo
- Postmark
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: '[email protected]',
fromName: 'Your Name'
});
// Send an email
mailer.send({
to: '[email protected]',
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' }
});const mailer = mailQuick.init({
provider: 'mailersend',
apiKey: 'your-mailersend-api-key',
from: '[email protected]',
fromName: 'Your Name'
});const mailer = mailQuick.init({
provider: 'sendgrid',
apiKey: 'your-sendgrid-api-key',
from: '[email protected]',
fromName: 'Your Name'
});const mailer = mailQuick.init({
provider: 'mailjet',
apiKey: 'your-mailjet-api-key',
apiSecret: 'your-mailjet-api-secret',
from: '[email protected]',
fromName: 'Your Name'
});const mailer = mailQuick.init({
provider: 'brevo',
apiKey: 'your-brevo-api-key',
from: '[email protected]',
fromName: 'Your Name'
});const mailer = mailQuick.init({
provider: 'postmark',
apiKey: 'your-postmark-api-key',
from: '[email protected]',
fromName: 'Your Name'
});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: '[email protected]',
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' }
});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.
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.
mailQuick is licensed under the MIT License. See LICENSE for more details.
Special thanks to the maintainers and contributors of the email service providers' APIs for making this package possible.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent