mailcub 2.0.5

package/README.md

@@ -0,0 +1,71 @@
+# Mailcub Package Documentation
+Version: 2.0.4
+
+## Introduction
+Mailcub is an npm package that enables you to send emails using a simple and straightforward interface. It provides a function to send emails with the following features:
+
+## Sending HTML emails.
+Attaching files to emails.
+Sending emails with a secret key for authentication.
+
+## Installation
+To install the "mailcub" package, use npm:
+
+```bash
+
+npm install mailcub
+
+```
+
+## Usage
+### Import the Package
+You can import the "mailcub" package in your Node.js application as follows:
+
+```javascript
+const mailcub = require('mailcub');
+```
+
+### Sending an Email
+To send an email, use the sendMail function with the following parameters:
+
+- body (Object): An object containing the email details.
+- key (String): The secret key for authentication.
+
+
+```javascript
+const emailBody = {
+  email_from: 'user@yourdomain.com',
+  receiver: 'user@example.com',
+  subject: 'Subject',
+  html: '<h1>Hello</h1>',
+  attachment: 'attachment_path'
+};
+
+const secretKey = 'your-secret-key';
+
+mailcub.sendMail(emailBody, secretKey)
+  .then(() => {
+    console.log('Email sent successfully');
+  })
+  .catch((error) => {
+    console.error('Error sending email:', error);
+  });
+```
+
+## Parameters
+- emailBody (Object):
+    - email_from (String): The sender's email address.
+    - receiver (String): The recipient's email address.
+    - subject (String): The email subject.
+    - html (String): The HTML content of the email.
+    - attachment (String or Array): The file path of a single attachment, or an array of file paths for multiple attachments — e.g., ['path/to/file1', 'path/to/file2', 'path/to/file3'].
+
+- secretKey (String): The secret key for authentication. You can obtain this key from console.mailcub.com.
+
+## Support and Issues
+If you encounter any issues or have questions, please contact our support team at support@mailcub.com.
+
+## License
+This package is distributed under the MIT License. See the LICENSE file for details.
+
+

package/index.js

@@ -0,0 +1,39 @@
+const invokeApi = require("./invoke_api");
+
+const sendMail = async (body, key) => {
+  try {
+    const requestObj = {
+      path: "https://api.mail.mailcub.com/api/send_email",
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "x-sh-key": key,
+      },
+      postData: body,
+    };
+
+    const result = await invokeApi(requestObj);
+
+    if (result.code !== 200) {
+      const error = new Error(result.message || "Unknown error from Mailcub API");
+      error.code = result.code;
+      throw error;
+    }
+
+    return {
+      code: result.code,
+      message: result.message,
+    };
+
+  } catch (err) {
+    throw {
+      code: err.code || 500,
+      message: err.message || "An unexpected error occurred while sending email."
+    };
+  }
+};
+
+module.exports = {
+  sendMail,
+};
+ 

package/invoke_api.js

@@ -0,0 +1,48 @@
+const axios = require("axios");
+axios.defaults.headers.post["Content-Type"] = "application/json";
+
+async function invokeApi({
+  path,
+  method = "GET",
+  headers = {},
+  queryParams = {},
+  postData = {},
+}) {
+  const reqObj = {
+    method,
+    url: path,
+    headers: {...headers},
+    params: queryParams,
+    data: postData,
+  };
+
+  let results;
+
+  try {
+    // console.log("axios requestOBJ ==> ", reqObj);
+    results = await axios(reqObj);
+    // console.log(results, "API results");
+    return results.data;
+  } catch (error) {
+    // console.error(error);
+
+    if (error.response && error.response.status === 401) {
+      // alert(reqObj.url)
+      // localStorage.clear();
+      // window.location.reload();
+    }
+
+    const errorMessage =
+      error.response?.data?.message ||
+      "" ||
+      error.response?.statusText ||
+      "Something went wrong";
+
+    return {
+      code: error.response?.status || 500,
+      message: errorMessage,
+    };
+  }
+}
+
+module.exports = invokeApi;

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "mailcub",
+  "version": "2.0.5",
+  "description": "This package enables users to send emails using their registered domains, providing a professional and branded approach to communication.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "axios": "^1.4.0"
+  },
+  "devDependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:devflips/mailcub.git"
+  },
+  "author": "Devflips",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/devflips/mailcub/issues"
+  },
+  "homepage": "https://github.com/devflips/mailcub#readme"
+}