triggeremailfast 1.0.0

package/README.md

@@ -0,0 +1,71 @@
+# MailSender Email Sender #
+This is a custome module that provides a simple way to send emails using Nodemailer. It allows you to configure the SMTP server and credentials, and then send emails with ease.
+
+Installation
+To use this module, make sure you have Node.js installed on your system. Then, follow these steps:
+
+Clone or download this repository to your project folder.
+Install the required dependencies by running the following command:
+
+npm  install mailsender-1.0.0.tgz 
+
+const { sendMail, mailConfg } = require('./path/to/mailsender');
+
+
+Configure the email transporter with your email credentials:
+
+// Call this function before sending any emails
+mailConfg({
+  user: 'your_email@gmail.com',
+  pass: 'your_email_password',
+});
+
+Send an email using the sendMail function:
+
+const from = 'your_email@gmail.com';
+const to = ['recipient1@example.com', 'recipient2@example.com'];
+const subject = 'Email Subject';
+const template = '<p>This is the email content.</p>';
+
+sendMail(from, to, subject, template)
+  .then(message => {
+    console.log(message);
+  })
+  .catch(error => {
+    console.error(error.message);
+  });
+
+
+**Note**: Ensure that you allow "Less Secure Apps" on your Gmail account if you are using Gmail as your SMTP server. For production use, consider using an application-specific password instead.
+
+API Reference
+mailConfg(config)
+This function sets up the email transporter with the provided configuration.
+
+config: An object containing the email credentials.
+user: Your email address (e.g., 'your_email@gmail.com').
+pass: Your email password or application-specific password.
+sendMail(from, to, subject, template)
+This function sends an email to the specified recipients.
+
+from: The email address of the sender.
+to: An array of email addresses of the recipients.
+subject: The subject of the email.
+template: The HTML content of the email.
+Returns a promise that resolves to a success message containing the sent email's message ID or rejects with an error if the email sending process fails.
+
+**License**
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+Acknowledgments
+This module utilizes the Nodemailer library to facilitate email sending. Nodemailer is a wonderful tool for email communication in Node.js applications.
+
+For more information about Nodemailer, visit their website.
+
+Replace path/to/emailSender in the import statement with the actual path to the emailSender.js file in your project.
+
+Please ensure to replace your_email@gmail.com and your_email_password in the examples with your actual Gmail account and password or application-specific password.
+
+Additionally, you may customize the email content template to suit your specific use case. This template supports HTML, so you can format the email as needed.
+
+Remember to include any additional setup instructions or configuration details that are specific to your application or use case

package/index.js

@@ -0,0 +1,3 @@
+const {sendMail,mailConfg} = require('./sendMail');
+
+module.exports = { sendMail,mailConfg };

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "triggeremailfast",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "Kailash Mewada",
+  "license": "ISC",
+  "dependencies": {
+    "nodemailer": "^6.9.4"
+  }
+}

package/sendMail.js

@@ -0,0 +1,106 @@
+const nodemailer = require('nodemailer');
+let transporter;
+/// @ts-ignore mailConfig method takes a config object and creates a new transporter instance.
+/**
+ * @ts-ignore mailConfig method takes a config object and creates a new transporter instance.
+ * This is a description of your function.
+ *
+ * @param {Object} data - An object containing mail configuration.
+ * @param {string} data.host - The SMTP host (e.g., "smtp.gmail.com").
+ * @param {number} data.port - The port number (e.g., 465).
+ * @param {string} data.user - The username for authentication.
+ * @param {string} data.pass - The password for authentication.
+ * @param {boolean} [data.tls=false] - Whether to use TLS (optional, defaults to false).
+ * @throws {Error} Will throw an error if the input data is invalid.
+ * @returns {void}
+ */
+function mailConfg(data) {
+    // Input validation
+    if (!data || typeof data !== 'object') {
+      throw new Error('Invalid data: Please provide an object containing mail configuration.');
+    }
+  
+    if (!data.host || typeof data.host !== 'string') {
+      throw new Error('Invalid host: Please provide a valid SMTP host.');
+    }
+  
+    if (!data.port || typeof data.port !== 'number') {
+      throw new Error('Invalid port: Please provide a valid port number.');
+    }
+  
+    if (!data.user || typeof data.user !== 'string') {
+      throw new Error('Invalid user: Please provide a valid username.');
+    }
+  
+    if (!data.pass || typeof data.pass !== 'string') {
+      throw new Error('Invalid pass: Please provide a valid password.');
+    }
+  
+    // If tls is provided, make sure it's a boolean
+    if (data.tls !== undefined && typeof data.tls !== 'boolean') {
+      throw new Error('Invalid tls: Please provide a valid boolean value for tls.');
+    }
+  transporter = nodemailer.createTransport({
+    tls: data.tls?data.tls:false,
+    host:data.host, //"smtp.gmail.com"
+    port: data.port,  //465
+    secure: true,
+    auth: {
+      user: data.user,
+      pass: data.pass
+    },
+  });
+}
+/**
+ * Sends an email using Nodemailer.
+ *
+ * @async
+ * @param {string} from - The sender's email address.
+ * @param {string[]} to - An array of recipient email addresses.
+ * @param {string} subject - The subject of the email.
+ * @param {string} template - The HTML content of the email.
+ * @throws {Error} Will throw an error if any of the parameters are invalid or if there's an issue sending the email.
+ * @returns {Promise<string>} A promise that resolves to a success message with the email message ID if the email is sent successfully.
+ */
+async function sendMail(from, to, subject, template) {
+  try {
+    if (typeof from !== 'string' || !isValidEmail(from)) {
+      throw new Error('Invalid sender email address.');
+    }
+  
+    if (!Array.isArray(to) || to.length === 0 || !to.every(isValidEmail)) {
+      throw new Error('Invalid recipient email addresses.');
+    }
+  
+    if (typeof subject !== 'string' || subject.trim() === '') {
+      throw new Error('Invalid email subject.');
+    }
+  
+    if (typeof template !== 'string' || template.trim() === '') {
+      throw new Error('Invalid email template.');
+    }
+  
+    const mailOptions = {
+      from,
+      to:to.join(','),
+      subject,
+      html: template,
+    };
+    const info = await transporter.sendMail(mailOptions);
+    return `Email sent successfully. Message ID: ${info.messageId}`;
+  } catch (error) {
+    throw new Error(`Error sending email: ${error.message}`);
+  }
+
+}
+/**
+ * Validates an email address.
+ *
+ * @param {string} email - The email address to validate.
+ * @returns {boolean} True if the email is valid, false otherwise.
+ */
+function isValidEmail(email) {
+  const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+  return emailRegex.test(email);
+}
+module.exports = { sendMail, mailConfg };