Files
GibSend/packages/sdk/README.md
2025-05-17 14:13:32 +10:00

52 lines
804 B
Markdown

# Unsend SDK
## Prerequisites
- [Unsend API key](https://app.unsend.dev/dev-settings/api-keys)
- [Verified domain](https://app.unsend.dev/domains)
## Installation
### NPM
```bash
npm install unsend
```
### Yarn
```bash
yarn add unsend
```
### PNPM
```bash
pnpm add unsend
```
### Bun
```bash
bun add unsend
```
## Usage
```javascript
import { Unsend } from "unsend";
const unsend = new Unsend("us_12345");
// for self-hosted installations you can pass your base URL
// const unsend = new Unsend("us_12345", "https://my-unsend-instance.com");
unsend.emails.send({
to: "hello@acme.com",
from: "hello@company.com",
subject: "Unsend email",
html: "<p>Unsend is the best open source product to send emails</p>",
text: "Unsend is the best open source product to send emails",
});
```