\n ๐จ Build and send emails in Nest framework using React.js\n
\n\n
\n \n \n \n
\n\n## Features\n\n- ๐ฆพ Write your email templates in [React](https://github.com/facebook/react/) and [TypeScript](https://www.typescriptlang.org/)\n\n- ๐ฌ No more template not found / sending blank emails.\n\n- ๐ฐ No more missing context / variables from template.\n\n- ๐งช Write testable templates intended for email clients.\n\n- ๐ Built on top of [`react-email`](https://github.com/resendlabs/react-email) โ the next generation of writing emails.\n\n## Installation\n\n> This library is an adapter for the [`@nestjs-modules/mailer`](https://github.com/nest-modules/mailer) module, so we'll install the dependencies alongside by running the command below.\n\n```sh\nnpm i @webtre/nestjs-mailer-react-adapter @nestjs-modules/mailer nodemailer\n```\n\n### Getting Started\n\nTo add support for `React` to your project, modify `tsconfig.json`\n\n```javascript\n{\n \"compilerOptions\": {\n // add this line\n \"jsx\": \"react-jsx\"\n }\n}\n```\n\n### Configuration\n\n```javascript\n// src/app.module.ts\nimport { Module } from \"@nestjs/common\";\nimport { MailerModule } from \"@nestjs-modules/mailer\";\nimport { ReactAdapter } from \"@webtre/nestjs-mailer-react-adapter\";\n\n@Module({\n imports: [\n MailerModule.forRoot({\n transport: {\n host: \"smtp.domain.com\",\n port: 2525,\n secure: false,\n auth: {\n user: \"user@domain.com\",\n pass: \"password\",\n },\n },\n defaults: {\n from: '\"Webtre Technologies\" ',\n },\n template: {\n dir: __dirname + \"/templates\",\n // Use the adapter\n adapter: new ReactAdapter(),\n\n // Or with optional config\n adapter: new ReactAdapter({\n pretty: false,\n plainText: true,\n htmlToTextOptions: {\n wordwrap: 130,\n limits: {\n ellipsis: \"...\",\n },\n },\n }),\n },\n }),\n ],\n})\nexport class AppModule {}\n```\n\nTo see more options that can be passed to the `htmlToTextOptions` object, [click here](https://github.com/html-to-text/node-html-to-text/tree/master/packages/html-to-text#options).\n\n### Service Provider\n\n```javascript\nimport { Injectable } from '@nestjs/common';\nimport { MailerService } from '@nestjs-modules/mailer';\n\n@Injectable()\nexport class ExampleService {\n constructor(private readonly mailerService: MailerService) {}\n\n async public example(): Promise {\n await this.mailerService\n .sendMail({\n to: 'john@domain.com',\n subject: 'Testing react template',\n template: 'welcome', // The compiled extension is appended automatically.\n context: { // Data to be passed as props to your template.\n code: '123456',\n name: 'John Doe',\n },\n });\n }\n}\n```\n\n### React Template\n\n```javascript\n// src/templates/welcome.tsx\ninterface Props {\n code: string;\n name: string;\n}\n\nexport default function Welcome({ name, code }: Props) {\n return (\n
\n Hi {name}, thanks for signing up. Your code is {code}\n
\n );\n}\n```\n\n## Examples\n\nYou could also check the [examples folder](./examples) in this repo for a working usage example and how to set it up with [SWC](https://docs.nestjs.com/recipes/swc) using [gulp](https://gulpjs.com/).\n\n## Credits\n\n- [`react-email`](https://github.com/resendlabs/react-email) โ build and send emails using React\n- [`@nestjs-modules/mailer`](https://github.com/nest-modules/mailer) โ a mailer module for Nest framework (node.js)\n\n## License\n\n[MIT](./LICENSE) License ยฉ 2022 [Webtre Technologies](https://github.com/webtretech)\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n \n![\"NPM](\"https://img.shields.io/npm/v/@webtre/nestjs-mailer-react-adapter.svg\")
\n ![\"Package](\"https://img.shields.io/npm/l/@webtre/nestjs-mailer-react-adapter.svg\")
\n ![\"NPM](\"https://img.shields.io/npm/dm/@webtre/nestjs-mailer-react-adapter.svg\")
\n