简介
Egg.js 是一个基于 Node.js 和 Koa 的企业级框架,提供开箱即用的插件体系,可帮助我们快速构建 Node.js 应用程序。其中 egg-email 是一个基于 nodemailer 的 Egg.js 插件,能够快速发送邮件。本文将详细介绍 npm 包 egg-email 的使用教程,并提供示例代码进行演示。
安装和配置
安装
在 Egg.js 项目中,使用 npm 包 egg-email,需要先安装:
$ npm i egg-email
配置
在 Egg.js 项目中,使用 npm 包 egg-email,需要在 config/config.default.js 中配置:
-- -------------------- ---- ------- -------------- - ------- -- - ----- ------ - --- -- --------- -- ------------ - - ------- - -------- ----- ----- ------------- ----- ------ -- -- ------ ------- --
其中:
service
:SMTP 连接配置,如qq、gmail等。user
:邮件发送方邮箱。pass
:邮件发送方的授权码,不是用户名或密码。
使用
发送邮件
在 Egg.js 项目中,使用 npm 包 egg-email,通过 app.email.send
方法发送邮件,主要参数如下:
subject
:邮件主题。to
:收件人,数组或字符串格式均可。html
:邮件正文,可以包含 HTML。
// Sending mail app.email.send({ subject: 'Test mail subject', to: 'test@example.com', html: '<p>Test mail content</p>', });
示例代码
-- -------------------- ---- ------- -- ----------------------- ----- ---------- - -------------------------- ----- --------------- ------- ---------- - ----- ------ - ----- - --- - - ----- ----- - -------- --- ---- - - ----------------- ----- ---- - ----- -------------------- -------- --- ----- --- -------- - - ----- -- - - -------------- - ----------------
// app/router.js module.exports = app => { const { router, controller } = app; router.post('/send', controller.email.send); };
总结
npm 包 egg-email 是一个基于 nodemailer 的 Egg.js 插件,能够快速方便地发送邮件。本文介绍了其的安装和配置,以及如何在 Egg.js 项目中使用该插件发送邮件,并提供了示例代码对其进行演示。相信本文对于初学者有十分详细的指导意义,希望有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600559bb81e8991b448d7469