payload unsend

# ⚠️ Deprecated: Migrated to Usesend

This package has been renamed to **[@rubixstudios/payload-usesend](https://www.npmjs.com/package/@rubixstudios/payload-usesend)**.  
No further development will occur here. Please update your dependency:

```sh
pnpm add @rubixstudios/payload-usesend
```

## PayloadCMS + Unsend.dev Email Adapter

This adapter allows [PayloadCMS](https://payloadcms.com) to send emails using the [Unsend](https://unsend.dev) REST API.

[![npm version](https://img.shields.io/npm/v/@rubixstudios/payload-unsend.svg)](https://www.npmjs.com/package/@rubixstudios/payload-unsend)

## Installation

```sh
pnpm add @rubixstudios/payload-unsend
```

## Usage

- Sign up for a [Unsend](https://unsend.dev) account
- Set up a domain
- Create an API key
- Set API key as UNSEND_API_KEY environment variable
- Set your Unsend base url as UNSEND_URL environment variable
- Configure your Payload config

```ts
// payload.config.js
import { unsendAdapter } from '@rubixstudios/payload-unsend'

export default buildConfig({
  email: unsendAdapter({
    defaultFromAddress: '[email protected]',
    defaultFromName: 'Rubix Studios',
    apiKey: process.env.UNSEND_API_KEY || '',
    unsendurl: process.env.UNSEND_URL || 'https://rubixstudios.com.au'
    // Optional:
    // templateId: 'template-uuid',
    // scheduledAt: '2025-08-01T10:00:00Z',
    // variables: { firstName: 'Vincent' }
  }),
})
```

---

## Project Status

This repository is archived. Future development continues at [payload-usesend](https://github.com/rubix-studios-pty-ltd/payload-usesend).