23154c366d
Deleted CloudflareMailer class and its implementation from the mailers package. Updated dependencies across various packages, converting certain imports to use `type` only, and bumped versions for packages like `react-query`, `lucide-react`, and others.
51 lines
1000 B
Markdown
51 lines
1000 B
Markdown
# Mailers - @kit/mailers
|
|
|
|
This package is responsible for sending emails using a unified interface across the app.
|
|
|
|
The default mailer uses the `nodemailer` package to send emails. You can create custom mailers by extending the `Mailer` class.
|
|
|
|
Make sure the app installs the `@kit/mailers` package before using it.
|
|
|
|
```json
|
|
{
|
|
"name": "my-app",
|
|
"dependencies": {
|
|
"@kit/mailers": "*"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Usage
|
|
|
|
By default, the package uses `nodemailer`.
|
|
|
|
To use [Resend](https:///resend.com)'s HTTP API, please set the environment variable `MAILER_PROVIDER` to `resend`.
|
|
|
|
```
|
|
MAILER_PROVIDER=resend
|
|
```
|
|
|
|
### Send an email
|
|
|
|
```tsx
|
|
import { getMailer } from '@kit/mailers';
|
|
|
|
async function sendEmail() {
|
|
const mailer = await getMailer();
|
|
|
|
return mailer.sendEmail({
|
|
to: '',
|
|
from: '',
|
|
subject: 'Hello',
|
|
text: 'Hello, World!'
|
|
});
|
|
}
|
|
```
|
|
|
|
## Resend
|
|
|
|
If you're using the `resend` provider, please add the following environment variables:
|
|
|
|
```
|
|
RESEND_API_KEY=your-api-key
|
|
``` |