Nuxt Mailpit

Integrate the Mailpit web UI effortlessly in the Nuxt devtools.

Features

🧙 Devtools integration: Access the Mailpit web UI directly from Nuxt devtools.

Quick Setup

Add nuxt-mailpit dependency to your project

# Using pnpm
pnpm add -D nuxt-mailpit

# Using yarn
yarn add --dev nuxt-mailpit

# Using npm
npm install --save-dev nuxt-mailpit

Add nuxt-mailpit to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-mailpit'
  ]
})

Ensure you have Mailpit installed and running.

That's it! You can now use Mailpit in your Nuxt app ✨

Module options

export default defineNuxtConfig({
  modules: ["nuxt-mailpit"],
  mailpit: {
    // Enable or disable the Mailpit web UI in devtools
    devtools: true,
    // The URL of the Mailpit web UI
    webUiUrl: "http://localhost:8025",
  }
})

Contributing

Suggestions for new features, bug reports and pull requests are welcome!

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release