@nestjs-modules/mailer 2.1.1 → 2.1.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.1.3
+
+### Patch Changes
+
+- [`292a0f4`](https://github.com/nest-modules/mailer/commit/292a0f41aa147e7cb508d48a012b6645f8be26f5) Thanks [@juandav](https://github.com/juandav)! - Allow all transport types for additional transports and addTransporter method.
+
+## 2.1.2
+
+### Patch Changes
+
+- [`27137db`](https://github.com/nest-modules/mailer/commit/27137dbc165038d2c8b97b610eb646f2f2c5bffc) Thanks [@juandav](https://github.com/juandav)! - Include README.md in published npm package.
+
 ## 2.1.1
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,115 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank">
+    <img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" />
+  </a>
+</p>
+
+<p align="center">
+  A mailer module for <a href="http://nestjs.com/">NestJS</a> using <a href="https://nodemailer.com/">Nodemailer</a>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@nestjs-modules/mailer"><img src="https://img.shields.io/npm/v/@nestjs-modules/mailer.svg" alt="NPM Version" /></a>
+  <a href="https://www.npmjs.com/package/@nestjs-modules/mailer"><img src="https://img.shields.io/npm/l/@nestjs-modules/mailer.svg" alt="Package License" /></a>
+  <a href="https://www.npmjs.com/package/@nestjs-modules/mailer"><img src="https://img.shields.io/npm/dm/@nestjs-modules/mailer.svg" alt="NPM Downloads" /></a>
+</p>
+
+## Features
+
+- **Built on Nodemailer** — Supports SMTP, SES, sendmail, and more.
+- **Multiple Template Engines** — Handlebars, Pug, EJS, Liquid, or MJML.
+- **NestJS Native** — Dependency injection, async configuration, and module patterns.
+- **Multiple Transporters** — Configure multiple SMTP servers and switch per message.
+- **CSS Inlining** — Built-in css-inline ensures emails render correctly across all clients.
+- **Preview Emails** — Preview emails in the browser during development.
+
+## Documentation
+
+Full documentation is available at **[nest-modules.github.io/mailer](https://nest-modules.github.io/mailer/)**.
+
+## Installation
+
+```bash
+pnpm add @nestjs-modules/mailer nodemailer
+```
+
+Install a template engine of your choice:
+
+```bash
+pnpm add handlebars
+# or
+pnpm add pug
+# or
+pnpm add ejs
+```
+
+## Quick Start
+
+```typescript
+// app.module.ts
+import { Module } from '@nestjs/common';
+import { MailerModule } from '@nestjs-modules/mailer';
+import { HandlebarsAdapter } from '@nestjs-modules/mailer/adapters/handlebars.adapter';
+
+@Module({
+  imports: [
+    MailerModule.forRoot({
+      transport: {
+        host: 'smtp.example.com',
+        port: 587,
+        auth: {
+          user: 'username',
+          pass: 'password',
+        },
+      },
+      defaults: {
+        from: '"No Reply" <noreply@example.com>',
+      },
+      template: {
+        adapter: new HandlebarsAdapter(),
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+```typescript
+// example.service.ts
+import { Injectable } from '@nestjs/common';
+import { MailerService } from '@nestjs-modules/mailer';
+
+@Injectable()
+export class ExampleService {
+  constructor(private readonly mailerService: MailerService) {}
+
+  async sendEmail() {
+    await this.mailerService.sendMail({
+      to: 'user@example.com',
+      subject: 'Hello',
+      template: 'welcome',
+      context: {
+        name: 'John',
+      },
+    });
+  }
+}
+```
+
+## Contributing
+
+Contributions are welcome! See the [documentation](https://nest-modules.github.io/mailer/) for details on the monorepo structure and development commands.
+
+### Contributors
+
+- [Cristiam Diaz](https://github.com/cdiaz)
+- [Eduardo Leal](https://github.com/eduardoleal)
+- [Juan Echeverry](https://github.com/juandav)
+- [Pat McGowan](https://github.com/p-mcgowan)
+- [Paweł Partyka](https://github.com/partyka95)
+- [Wasutan Kitijerapat](https://github.com/kitimark)
+- [Alexandre Titeux](https://github.com/GFoniX)
+
+## License
+
+MIT

package/dist/interfaces/mailer-options.interface.d.ts

@@ -12,7 +12,7 @@ export interface MailerOptions {
     defaults?: Options;
     transport?: TransportType;
     transports?: {
-        [name: string]: SMTPTransport | SMTPTransport.Options | string;
+        [name: string]: TransportType;
     };
     template?: {
         dir?: string;

package/dist/mailer.service.d.ts

@@ -1,6 +1,5 @@
 import { SentMessageInfo } from 'nodemailer';
-import * as smtpTransport from 'nodemailer/lib/smtp-transport';
-import { MailerOptions } from './interfaces/mailer-options.interface';
+import { MailerOptions, TransportType } from './interfaces/mailer-options.interface';
 import { MailerTransportFactory as IMailerTransportFactory } from './interfaces/mailer-transport-factory.interface';
 import { ISendMailOptions } from './interfaces/send-mail-options.interface';
 export declare class MailerService {
@@ -18,5 +17,5 @@ export declare class MailerService {
     private verifyTransporter;
     verifyAllTransporters(): Promise<boolean>;
     sendMail(sendMailOptions: ISendMailOptions): Promise<SentMessageInfo>;
-    addTransporter(transporterName: string, config: string | smtpTransport | smtpTransport.Options): string;
+    addTransporter(transporterName: string, config: TransportType): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-modules/mailer",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "private": false,
   "description": "NestJS - a mailer module (@mailer)",
   "keywords": [
@@ -48,7 +48,7 @@
     "Joao vitor FREZYN <00001097715413SP@al.educacao.sp.gov.br>"
   ],
   "scripts": {
-    "prebuild": "rimraf dist",
+    "prebuild": "rimraf dist && cp ../../README.md .",
     "build": "tsc -p tsconfig.json",
     "check": "biome check .",
     "test": "jest"