\n\n## Description\n\n@prymejo/nestjs-sms-and-email-module is a simple package that provides functionalities for sending emails and sms.\n\nThe package works with Nodejs v18 >\n\n# Key features\n\n 1. Send bulk sms\n 2. Send single sms\n 3. Send Email with text\n 4. Send email with template ( templates can be generated on mandrill or mailchimp)\n\n## About\n\nThis is a simple implementation for sending email and sms notifications with nestjs .\nIt uses Mailchimp( Mandrill ) for sending emails and Termii () for sending sms.\n\n**Sample payload for sending sms**\n\n//you will need to set the senderId from the\n\n input: {\n from:\"sender@mail.com\" \n to:\"+2348007910016\"\n sms:\"test message\"\n channel:GENERIC\n type:\"plain\"\n }\n\n**Sample payload for sending email**\n\n//you will need to set the from_mail on the mandrill dashboard\n\n input: {\n message: {\n to: [{ email: \"johndoe@mailreciever.com\" }]\n text: \"testing email\"\n from_email: \"janedoe@mailsender.com\"\n subject:\"testing emails\"\n }\n }\n\n### Initializing the sms module\n\n import {SmsModule} from '@prymejo/nestjs-sms-and-email-module';\n \n @module({\n imports:[SmsModule.register(TERMII_API_KEY)]\n })\n\n### Using the sms service\n\n import {SmsService} from '@prymejo/nestjs-sms-and-email-module';\n \n export class UserService{\n constructor(private readonly smsService:SmsService){\n }\n \n async sendOtp(payload:SendSmsInterface){\n await this.smsService.sendSms(payload)\n }\n\n### Initializing the Email module\n\n import {EmailModule} from '@prymejo/nestjs-sms-and-email-module';\n \n @module({\n imports:[EmailModule.register(MANDRILL_API_KEY)]\n })\n\n### Using the email service\n\n import {EmailService} from '@prymejo/nestjs-sms-and-email-module';\n \n export class UserService{\n constructor(private readonly emailService:EmailService){}\n async sendEmail(payload:MailChimpEmailInterface){\n await this.emailService.sendMail(payload)\n }\n\nPS: Contributions are welcome.\n\n Note : you will need to create accounts on both Mandrill (() docs can be found at ) and Termii(() docs can be found at ) to obtain their api keys.\n\n## Installation\n\n npm install @prymejo/nestjs-sms-and-email-module\n \n yarn add @prymejo/nestjs-sms-and-email-module\n\n- Author - [pryme0] \n\n## License\n\nNest is [MIT licensed](LICENSE).\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}