UNPKG

@un-dev-suisse/nestjs-mail

Version:

NestJS Mail Service - A simple mail service for NestJS applications

70 lines (47 loc) 1.37 kB
# @un-dev-suisse/nestjs-mail Un service de messagerie simple pour les applications NestJS. ## Installation ```bash npm install @un-dev-suisse/nestjs-mail ``` ## Utilisation ### 1. Importer le module ```typescript import { Module } from '@nestjs/common'; import { MailModule } from '@un-dev-suisse/nestjs-mail'; @Module({ imports: [MailModule], }) export class AppModule {} ``` ### 2. Utiliser le service ```typescript import { Injectable } from '@nestjs/common'; import { MailService } from '@un-dev-suisse/nestjs-mail'; @Injectable() export class MyService { constructor(private readonly mailService: MailService) {} async sendWelcomeEmail(email: string) { await this.mailService.sendEmail({ to: [email], subject: 'Bienvenue !', text: 'Merci de vous être inscrit à notre service.', }); } } ``` ## Configuration Le service nécessite les variables d'environnement suivantes : - `MAIL_SERVICE_URL` : URL du service de messagerie - `MAIL_SERVICE_API_KEY` : Clé API pour l'authentification ## API ### MailService #### sendEmail(data: MailDto) Envoie un email avec les données fournies. **Paramètres :** - `data.to` : Array d'adresses email destinataires - `data.subject` : Sujet de l'email - `data.text` : Contenu textuel de l'email **Retourne :** Promise avec la réponse du service de messagerie ## Licence MIT