https://github.com/zapal-tech/payload-email-sendgrid
Payload CMS SendGrid Email Adapter
https://github.com/zapal-tech/payload-email-sendgrid
Last synced: 9 months ago
JSON representation
Payload CMS SendGrid Email Adapter
- Host: GitHub
- URL: https://github.com/zapal-tech/payload-email-sendgrid
- Owner: zapal-tech
- License: mit
- Created: 2024-08-14T13:56:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T09:11:17.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T10:25:25.552Z (over 1 year ago)
- Language: TypeScript
- Size: 89.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SendGrid REST Email Adapter for Payload CMS
This adapter allows you to send emails using the [SendGrid](https://sendgrid.com) REST API.
## Installation
```sh
pnpm add @zapal/payload-email-sendgrid
```
## Usage
- Sign up for a [SendGrid](https://sendgrid.com) account
- Create an API key
- Set API key as SENDGRID_API_KEY environment variable
- Configure your Payload config
```ts
// payload.config.js
import { sendGridAdapter } from '@zapal/payload-email-sendgrid'
export default buildConfig({
email: sendGridAdapter({
defaultFromAddress: 'hello@zapal.tech',
defaultFromName: 'Zapal',
apiKey: process.env.SENDGRID_API_KEY || '',
}),
})
```