Nuxt

Send emails using Nuxt and the MailChannels Node.js SDK.

Prerequisites

• Create a MailChannels account
• Create an API key

1. Install

Add the mailchannels-sdk package dependency to your Nuxt project.

npm

npm i mailchannels-sdk

yarn

yarn add mailchannels-sdk

pnpm

pnpm add mailchannels-sdk

bun

bun add mailchannels-sdk

deno

deno add npm:mailchannels-sdk

2. Configure your API key

Add your MailChannels API key to your .env file.

.env

NUXT_MAILCHANNELS_API_KEY=your-api-key

Then, add the mailchannels object and apiKey property to the runtimeConfig in your nuxt.config.ts. The value of apiKey should be an empty string, which will be automatically set at runtime using the value of process.env.NUXT_MAILCHANNELS_API_KEY.

nuxt.config.ts

export default defineNuxtConfig({
  runtimeConfig: {
    mailchannels: {
      apiKey: '' // This should be an empty string here
    }
  }
})

3. Send email using HTML

Register a Server handler under server/api/send.post.ts.

Use the html property to send an email with HTML content.

server/api/send.post.ts

import { MailChannels } from 'mailchannels-sdk'

export default defineEventHandler(async (event) => {
  const config = useRuntimeConfig(event)

  const mailchannels = new MailChannels(config.mailchannels.apiKey)

  const { data, error } = await mailchannels.emails.send({
    from: 'Name <from@example.com>',
    to: 'to@example.com',
    subject: 'Test email',
    html: '<p>Hello World</p>'
  })

  if (error) {
    throw createError({
      status: error.statusCode || 400,
      message: error.message
    })
  }

  return data
})

Examples

Send

Send a predefined email using the API route