{"_id":"@akshayvg/mailer-npm-package-live","_rev":"3-91482cd03a274cfccdec313fac0aa78b","name":"@akshayvg/mailer-npm-package-live","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@akshayvg/mailer-npm-package-live","version":"1.0.0","author":{"name":"akshay vg"},"license":"ISC","_id":"@akshayvg/mailer-npm-package-live@1.0.0","maintainers":[{"name":"akshayvg","email":"akshayvg@techwarelab.com"}],"dist":{"shasum":"aed8d10031dd6e61016637b7d49bb1daaea0237b","tarball":"https://registry.npmjs.org/@akshayvg/mailer-npm-package-live/-/mailer-npm-package-live-1.0.0.tgz","fileCount":3,"integrity":"sha512-7r2x4COagchkxT8N++Anc5UK6AWjrNI6208MkH8q4iFCuODWcaZOMqmkgZAEIl5+6MPxgYarbSi/XlvzFzAD3A==","signatures":[{"sig":"MEQCIFlu8AS3kLRLW+pG56CB6xggZyAfTga2vOJuk/wVp6UNAiAnFpMcCkFGK7PNWRr4YbsYxPJY0rFKu7Sn3SvlYFJ4Eg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":2206},"main":"mailService.js","module":"mailService.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"node index.js"},"_npmUser":{"name":"akshayvg","email":"akshayvg@techwarelab.com"},"_npmVersion":"10.8.2","description":"an npm package to send emails usin dynamic templates","directories":{},"_nodeVersion":"18.20.5","dependencies":{"axios":"^1.7.9","dotenv":"^16.4.7","express":"^4.21.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/mailer-npm-package-live_1.0.0_1735559997317_0.08252400541574678","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@akshayvg/mailer-npm-package-live","version":"1.0.1","author":{"name":"akshay vg"},"license":"ISC","_id":"@akshayvg/mailer-npm-package-live@1.0.1","maintainers":[{"name":"akshayvg","email":"akshayvg@techwarelab.com"}],"dist":{"shasum":"8ab705b4616cd781bbb4b0668d8669bcf45fc0a3","tarball":"https://registry.npmjs.org/@akshayvg/mailer-npm-package-live/-/mailer-npm-package-live-1.0.1.tgz","fileCount":4,"integrity":"sha512-JqO8O2f75/dNUKzBC6zfYqL2RraTcUKPJhGqVt1bfmlOiHmXkMkv3vDxR7uoxENHnC90QkGcM+NRYepcH7u9Rg==","signatures":[{"sig":"MEUCIB9X9KEU8L88LzYFJa3n1v8jfB7erXQwX6hVfy8il6SbAiEA9HGHSgtej3gNfAqeWtNGvVmWpJ8VVOOH6FSu6x0Mbwc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5295},"main":"mailService.js","module":"mailService.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"node index.js"},"_npmUser":{"name":"akshayvg","email":"akshayvg@techwarelab.com"},"_npmVersion":"10.8.2","description":"an npm package to send emails usin dynamic templates","directories":{},"_nodeVersion":"18.20.5","dependencies":{"axios":"^1.7.9","dotenv":"^16.4.7","express":"^4.21.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/mailer-npm-package-live_1.0.1_1735562919695_0.5519967937079409","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@akshayvg/mailer-npm-package-live","version":"1.0.2","author":{"name":"akshay vg"},"license":"ISC","_id":"@akshayvg/mailer-npm-package-live@1.0.2","maintainers":[{"name":"akshayvg","email":"akshayvg@techwarelab.com"}],"dist":{"shasum":"4ec0bee54933ac3fb5d350713f10926fd88291fd","tarball":"https://registry.npmjs.org/@akshayvg/mailer-npm-package-live/-/mailer-npm-package-live-1.0.2.tgz","fileCount":4,"integrity":"sha512-3CbljtdUfFi7UGPWLBJ1JmxomVqG8euQLDhmyDe4qZsLtgRYq57bw9yf2RVqtrkRx+WaHalvj/L5Es7rBdp5JA==","signatures":[{"sig":"MEUCIHfzmK0O8hKb4kMZlPH8zN7/TpYXdKgeS/Gpego6PeKOAiEAunUU5ZZ73TLhzJj4WXnZHmti/2/9G6XNyuJRAg2fKyc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5278},"main":"mailService.js","module":"mailService.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"node index.js"},"_npmUser":{"name":"akshayvg","email":"akshayvg@techwarelab.com"},"_npmVersion":"10.8.2","description":"an npm package to send emails usin dynamic templates","directories":{},"_nodeVersion":"18.20.5","dependencies":{"axios":"^1.7.9","dotenv":"^16.4.7","express":"^4.21.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/mailer-npm-package-live_1.0.2_1735620484845_0.735701752701873","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"dependencies":{"axios":"^1.7.9","dotenv":"^16.4.7","express":"^4.21.2"},"name":"@akshayvg/mailer-npm-package-live","version":"1.0.3","description":"an npm package to send emails usin dynamic templates","main":"mailService.js","module":"mailService.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"node index.js"},"author":{"name":"akshay vg"},"license":"ISC","_id":"@akshayvg/mailer-npm-package-live@1.0.3","gitHead":"a672eea8dbd28dd5069252569fe5788c82036509","_nodeVersion":"18.20.5","_npmVersion":"10.8.2","dist":{"integrity":"sha512-/7JgNZsk3v4Cujck5BcwdF1IakCtXMoomuDVo15T0tjK6KMp9nJMsbmcXX7GxZGMiW8VBlYV0KltMomcuP8UBQ==","shasum":"79373cf2fc80592867c16cc85444e97ca1b13eed","tarball":"https://registry.npmjs.org/@akshayvg/mailer-npm-package-live/-/mailer-npm-package-live-1.0.3.tgz","fileCount":5,"unpackedSize":5880,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD2dHjJPgPaUJUMb9XYaTQNrM+pUb0yZcPWvS98Xb7gHQIgbydfbvD8qwrsjPZD1hupjZzi8Dav3z5fFR9YVsgGxZU="}]},"_npmUser":{"name":"akshayvg","email":"akshayvg@techwarelab.com"},"directories":{},"maintainers":[{"name":"akshayvg","email":"akshayvg@techwarelab.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mailer-npm-package-live_1.0.3_1736504340341_0.388323272859348"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-30T11:59:57.165Z","modified":"2025-01-10T10:19:00.671Z","1.0.0":"2024-12-30T11:59:57.509Z","1.0.1":"2024-12-30T12:48:39.854Z","1.0.2":"2024-12-31T04:48:05.012Z","1.0.3":"2025-01-10T10:19:00.501Z"},"author":{"name":"akshay vg"},"license":"ISC","description":"an npm package to send emails usin dynamic templates","maintainers":[{"name":"akshayvg","email":"akshayvg@techwarelab.com"}],"readme":"\n# Email Sending NPM Package\n\nThis NPM package allows you to send emails using **dynamic mail templates**.\n\n## Features\n\n- **User Authentication**: Clients can log in with their username and password.\n- **Project & Template Management**: Users can set up projects, email templates, and email configurations.\n- **SMTP Support**: Currently, only SMTP configuration is supported.\n\n---\n\n## Installation\n\nInstall the package via NPM:\n\n```bash\nnpm install your-package-name\n```\n\n---\n\n## Usage\n\n### Class: `Mailer`\nThe package provides a class named `Mailer`, which must be instantiated using a generated API key. The API key is obtained from the application website and is only visible once.\n\n#### Example:\n```javascript\nconst Mailer = require('your-package-name');\n\n// Instantiate the Mailer class with the API key\nconst mailer = new Mailer('your-api-key');\n```\n\n---\n\n### Method: `sendMail`\n\nAfter instantiating the `Mailer` class, you can use the `sendMail` method to send emails.\n\n#### Arguments:\n| **Parameter**    | **Type**    | **Description**                                              |\n|-------------------|-------------|--------------------------------------------------------------|\n| `templateId`      | `number`    | The ID of the email template.                                |\n| `versionId`       | `number`    | The version ID of the email template.                       |\n| `projectId`       | `number`    | The ID of the project under which the email is sent.        |\n| `providerType`    | `string`    | The type of email provider (e.g., \"SMTP\").                  |\n| `recipientEmail`  | `string`    | The recipient's email address.                              |\n| `subject`         | `string`    | The subject of the email.                                   |\n| `templateData`    | `array`     | An array of objects containing dynamic data fields.         |\n\n#### Structure of `templateData` Objects:\n| **Property**  | **Type**   | **Description**                  |\n|---------------|------------|----------------------------------|\n| `fieldName`   | `string`   | The name of the dynamic field.   |\n| `fieldValue`  | `string`   | The value for the dynamic field. |\n\n---\n\n### Example:\n```javascript\nconst mailer = new Mailer('your-api-key');\n\nconst emailDetails = {\n  templateId: 1,\n  versionId: 2,\n  projectId: 101,\n  providerType: 'SMTP',\n  recipientEmail: 'recipient@example.com',\n  subject: 'Welcome Email',\n  templateData: [\n    { fieldName: 'userName', fieldValue: 'John Doe' },\n    { fieldName: 'verificationCode', fieldValue: '123456' },\n  ],\n};\n\nmailer.sendMail(emailDetails)\n  .then(response => console.log('Email sent successfully:', response))\n  .catch(error => console.error('Error sending email:', error));\n```\n\n---\n\n## Notes\n\n- **API Key Visibility**: The API key is displayed only once upon generation.\n- **Supported Configuration**: Only SMTP configurations are supported currently.\n\n---\n\n## License\n\nThis package is licensed under the MIT License. See `LICENSE` for more details.\n\n\n\n\n## Installation\n\n```bash\nnpm install my-npm-package","readmeFilename":"README.md"}