[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 Resend. It support send mail only
## 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: ,
});
// To include a friendly name, use the format "Your Name "
await this.resendService.send({
from: 'Your Name ',
to: 'user@gmail.com',
subject: 'hello world',
react: ,
});
}
```
## 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: ,
},
// To include a friendly name, use the format "Your Name "
{
from: 'Your Name ',
to: 'user@gmail.com',
subject: 'hello world',
react: ,
}
]);
}
```
## License
Nestjs-Resend is [MIT licensed](LICENSE).