nestjs-resend

KO | EN

gitlite — search

#php #dotfiles #ios #swift #database #react #python #macos #golang #api #hacktoberfest #atom

★ 82 Open GitHub ↗

NestJS provider for sending emails with resend

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest

A simple nestjs wrapper of <a href="https://resend.com" target="_blank">Resend</a>. It support send mail only
 
<a href="https://www.npmjs.com/nestjs-resend" target="_blank"><img src="https://img.shields.io/npm/v/nestjs-resend.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/nestjs-resend" target="_blank"><img src="https://img.shields.io/npm/l/nestjs-resend.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/nestjs-resend" target="_blank"><img src="https://img.shields.io/npm/dm/nestjs-resend.svg" alt="NPM Downloads" /></a>

## Features

1. send email
2. send batch emails

## Installation

```bash
# npm
$ npm install nestjs-resend

# yarn
$ yarn add nestjs-resend

# pnpm
$ pnpm add nestjs-resend
```

## Usage

### Importing module

```typescript
import { ResendModule } from 'nestjs-resend';

@Module({
  imports: [
    ResendModule.forRoot({
      apiKey: 'your resend api key',
    }),
  ],
  providers: [],
  exports: [],
})
```

### Importing module async

```typescript
import { ResendModule } from 'nestjs-resend';

@Module({
  imports: [
    ResendModule.forRootAsync({
      useFactory: async () => ({
        apiKey: 'your resend api key',
      })
    }),
  ],
  providers: [],
  exports: [],
})
```

## Interfaces

```typescript
interface Options {
  apiKey: string
}
```

## Send Email

```typescript
import { ResendService } from 'nestjs-resend';

@Injectable()
export class YourService {
  constructor(private readonly resendService: ResendService) {

// text
    await this.resendService.send({
      from: 'you@example.com',
      to: 'user@gmail.com',
      subject: 'hello world',
      text: 'it works!',
    });

// html
 await this.resendService.send({
 from: 'you@example.com',
 to: 'user@gmail.com',
 subject: 'hello world',
 html: 'it works!',
 });

// react
 await this.resendService.send({
 from: 'you@example.com',
 to: 'user@gmail.com',
 subject: 'hello world',
 react: <EmailTemplate firstName="John" product="MyApp" />,
 });

// To include a friendly name, use the format "Your Name <sender@domain.com>"
 await this.resendService.send({
 from: 'Your Name <you@example.com>',
 to: 'user@gmail.com',
 subject: 'hello world',
 react: <EmailTemplate firstName="John" product="MyApp" />,
 });
 }
```

## Send Batch Emails

```typescript
import { ResendService } from 'nestjs-resend';

@Injectable()
export class YourService {
  constructor(private readonly resendService: ResendService) {

await this.resendService.sendBatch([
 // text
 {
 from: 'you@example.com',
 to: 'user@gmail.com',
 subject: 'hello world',
 text: 'it works!',
 },
 // html
 {
 from: 'you@example.com',
 to: 'user@gmail.com',
 subject: 'hello world',
 html: 'it works!',
 },
 // react
 {
 from: 'you@example.com',
 to: 'user@gmail.com',
 subject: 'hello world',
 react: <EmailTemplate firstName="John" product="MyApp" />,
 },
 // To include a friendly name, use the format "Your Name <sender@domain.com>"
 {
 from: 'Your Name <you@example.com>',
 to: 'user@gmail.com',
 subject: 'hello world',
 react: <EmailTemplate firstName="John" product="MyApp" />,
 }
 ]);
 }
```

## License

Nestjs-Resend is [MIT licensed](LICENSE).

nestjs-resend

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README