nuxt-nodemailer

将 nodemailer 添加到 Nuxt3
此模块仅可在 Nuxt3 的服务器端用于发送电子邮件。

特性

自动导入服务器组合式函数 useNodeMailer()
添加 sendEmail()，它继承 from 参数
公开 nodemailer 原始实例
使用环境变量进行配置

安装

# Using ni
ni -D nuxt-nodemailer nodemailer

# Using pnpm
pnpm add -D nuxt-nodemailer nodemailer

# Using yarn
yarn add --dev nuxt-nodemailer nodemailer

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

配置

将 nuxt-nodemailer 添加到你的 nuxt.config.js 的 modules 部分。

该配置使用与 nodemailer 相同的选项，你可以在这里找到它们

export default {
  modules: [
    'nuxt-nodemailer'
  ],
  nodemailer: {
    from: '"John Doe" <[email protected]>',
    host: 'smtp.mailtrap.io',
    port: 465,
    secure: true,
    auth: {
      user: '[email protected]',
      pass: '',
    },
  },
}

环境变量

建议对密码等敏感信息使用环境变量。

nodemailer 配置中的每个选项都可以使用环境变量覆盖。它必须以 NUXT_NODEMAILER_ 为前缀，并且是大写形式。

例如，要覆盖 auth.pass 和 from 选项，你可以使用以下环境变量

NUXT_NODEMAILER_AUTH_PASS=yourpassword
NUXT_NODEMAILER_FROM="..."

警告：你只能覆盖 nuxt.config.js 文件中 nodemailer 配置中已存在的选项。

用法

在服务器事件处理程序中，你可以使用 useNodeMailer 组合式函数来发送电子邮件。

export default defineEventHandler(() => {
  const { sendMail } = useNodeMailer()

  return sendMail({ subject: 'Nuxt + nodemailer', text: 'Hello from nuxt-nodemailer!', to: '[email protected]' })
})

使用 sendMail 的好处是它会自动从配置中继承 from 参数，你无需每次都指定它。

你还可以使用带有配置选项的 transport，或者直接使用 nodemailer 实例创建全新的传输。

export default defineEventHandler(() => {
  const { transport, nodemailer } = useNodeMailer()

  // you can create a new transport
  return nodemailer.createTransport(...)

  // or use the existing one
  return transport.sendMail(...)
})