nuxt-lettermint

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

nuxt-lettermint

★ 13 Open GitHub ↗

Official Lettermint Nuxt module

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Nuxt Lettermint](https://lettermint.co/images/nuxt-lettermint.png)

# Nuxt Lettermint Module

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Join our Discord server](https://img.shields.io/discord/1305510095588819035?logo=discord&logoColor=eee&label=Discord&labelColor=464ce5&color=0D0E28&cacheSeconds=43200)](https://lettermint.co/r/discord)

A Nuxt module for sending emails using the [Lettermint](https://lettermint.co) email service. This module provides a seamless integration with Lettermint's Node.js SDK for both server-side and client-side email sending capabilities.

Lettermint is a European transactional email service provider focused on simplicity, reliability, and developer experience. Visit [Lettermint.co](https://lettermint.co) for more information about our email platform.

## Features

- 🚀 Full TypeScript support
- 🔒 Secure API key management
- 📧 Simple composable for client-side usage
- 🛠️ Direct server-side SDK access
- ⚙️ Flexible configuration via environment variables or `nuxt.config.ts`
- 🎯 Compatible with Nuxt 3 and Nuxt 4

## Quick Setup

### 1. Install the module

Using the Nuxt CLI (recommended):

```bash
npx nuxi module add lettermint
```

Or install manually:

```bash
# npm
npm install nuxt-lettermint

# pnpm
pnpm add nuxt-lettermint

# yarn
yarn add nuxt-lettermint
```

### 2. Add to your Nuxt config

```javascript
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-lettermint']
})
```

### 3. Configure your API key

First, get your API key from Lettermint:
1. Go to [https://dash.lettermint.co/projects](https://dash.lettermint.co/projects)
2. Select your project
3. Find your API token

Then set your API key in one of two ways:

**Option A:** Create a `.env` file in your project root (recommended):

```bash
NUXT_LETTERMINT_API_KEY=your-lettermint-api-key
```

**Option B:** Add it directly to your `nuxt.config.ts`:

```javascript
export default defineNuxtConfig({
  modules: ['nuxt-lettermint'],
  lettermint: {
    apiKey: 'your-api-key'
  }
})
```

## Configuration

The module accepts the following configuration options:

```typescript
export default defineNuxtConfig({
  modules: ['nuxt-lettermint'],
  lettermint: {
    // Your Lettermint API key (see step 3 above for configuration options)
    apiKey: 'your-api-key',
    
    // Enable/disable the auto-generated /api/lettermint/send endpoint (default: true)
    // Set to false if you want to create your own custom endpoints
    autoEndpoint: true
  }
})
```

### Disabling the Auto-Generated Endpoint

By default, the module creates an endpoint at `/api/lettermint/send` for sending emails. If you prefer to create your own custom endpoints, you can disable this behavior:

```typescript
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-lettermint'],
  lettermint: {
    autoEndpoint: false
  }
})
```

**Note:** When you disable the auto-generated endpoint:
- You can still send emails directly from your server code using the `sendEmail` function
- The client-side `useLettermint()` composable will not work unless you create a custom endpoint at `/api/lettermint/send`
- Only create a custom endpoint if you need specific routing, additional logic, or client-side email sending:

```typescript
// server/api/custom-send.post.ts (optional)
import { sendEmail } from '#imports'

export default defineEventHandler(async (event) => {
  const body = await readBody(event)
  // Add your custom logic here
  return await sendEmail(body)
})
```

## Usage

### Client-Side

```vue
<script setup>
const { send, sending, error } = useLettermint()

await send({
  from: 'sender@example.com',
  to: 'ok@testing.lettermint.co',
  subject: 'Hello!',
  html: '<h1>Hello World</h1>'
})
</script>
```

### Server-Side

```typescript
// server/api/send.post.ts
import { sendEmail } from '#imports'

export default defineEventHandler(async () => {
  return await sendEmail({
    from: 'hello@example.com',
    to: 'ok@testing.lettermint.co',
    subject: 'Welcome',
    html: '<h1>Welcome!</h1>',
    tags: ['welcome']
  })
})
```

### Advanced Usage

```typescript
import { useLettermint } from '#imports'

const lettermint = useLettermint()
await lettermint.email
  .from('sender@example.com')
  .to('ok@testing.lettermint.co')
  .subject('Hello')
  .html('<h1>Hello</h1>')
  .tag('campaign')
  .send()
```

## Links

- [Lettermint](https://lettermint.co)
- [Lettermint Documentation](https://docs.lettermint.co)
- [Lettermint Node.js SDK](https://www.npmjs.com/package/lettermint)

## License

[npm-version-src]: https://img.shields.io/npm/v/nuxt-lettermint/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nuxt-lettermint

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-lettermint.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npm.chart.dev/nuxt-lettermint

[license-src]: https://img.shields.io/npm/l/nuxt-lettermint.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nuxt-lettermint

[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com

nuxt-lettermint

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README