promailer 1.0.0

package/README.md

@@ -0,0 +1,94 @@
+# promailer
+
+![Version](https://img.shields.io/npm/v/promailer.svg)
+![License](https://img.shields.io/npm/l/promailer.svg)
+
+A simple and fast Node.js package to send emails using Nodemailer.
+
+## Installation
+
+```bash
+npm install promailer
+```
+
+## Usage
+
+### mailConfg
+
+This function is used to configure the email transporter with the necessary settings.
+
+```js
+const { mailConfg } = require('promailer');
+
+const mailConfigData = {
+  host: 'your-smtp-host',
+  port: 'your-smtp-port',
+  user: 'your-email@example.com',
+  pass: 'your-email-password',
+  tls: //true , false,
+  secure://true, false
+};
+
+mailConfg(mailConfigData);
+```
+
+### sendMail
+
+This function is used to send an email using the configured transporter.
+
+```js
+const { sendMail } = require('promailer');
+
+// Sample usage
+(async () => {
+  try {
+    const from = 'sender@example.com';
+    const to = ['recipient1@example.com', 'recipient2@example.com'];
+    const subject = 'Test Email';
+    const template = '<h1>Hello, this is a test email!</h1>';
+
+    const result = await sendMail(from, to, subject, template);
+    console.log(result);
+  } catch (error) {
+    console.error(error.message);
+  }
+})();
+```
+
+### Notes
+
+- The `mailConfg` function needs to be called once with valid configuration before using the `sendMail` function.
+- The `sendMail` function requires valid email addresses for both sender and recipients.
+- The package uses Nodemailer under the hood, and it supports TLS.
+
+## API
+
+### mailConfg(data)
+
+This function takes a configuration object as input and sets up the email transporter.
+
+- `data` (Object) - An object containing mail configuration.
+  - `host` (string) - The SMTP host (e.g., "smtp.gmail.com").
+  - `port` (number) - The port number (e.g., 465).
+  - `user` (string) - The username for authentication.
+  - `pass` (string) - The password for authentication.
+  - `tls` (boolean) - Whether to use TLS (optional, defaults to false).
+
+### sendMail(from, to, subject, template)
+
+This function sends an email using the configured transporter.
+
+- `from` (string) - The sender's email address.
+- `to` (string[]) - An array of recipient email addresses.
+- `subject` (string) - The subject of the email.
+- `template` (string) - The HTML content of the email.
+
+Returns a Promise that resolves to a success message with the email message ID if the email is sent successfully.
+
+## License
+
+This project is licensed under the [ISC License](LICENSE).
+
+---
+
+Please note that you can customize the package name, version, author, and description in the `package.json` file based on your preferences. If you have any further questions or need additional customization, feel free to ask!

package/index.js

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

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "promailer",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": {
+    "name": "Kailash Mewada",
+    "email": "kailash.mewada@encoresky.com"
+  },
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kailashencoresky/promailer-Project"
+  },
+  "dependencies": {
+    "nodemailer": "^6.9.4"
+  }
+}

package/sendMail.js

@@ -0,0 +1,110 @@
+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.');
+    }
+     // If tls is provided, make sure it's a boolean
+     if (data.secure !== undefined && typeof data.secure !== 'boolean') {
+      throw new Error('Invalid secure: Please provide a valid boolean value for secure.');
+    }
+  transporter = nodemailer.createTransport({
+    tls: data.tls?data.tls:false,
+    host:data.host, //"smtp.gmail.com"
+    port: data.port,  //465
+    secure: data.secure,
+    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 };