Skip to content

Node.js 使用 Nodemailer 发送邮件

统计信息：字数 9368 阅读19分钟

nodemaileremailnode.js

阅读约 17 分钟

原文链接：Node.js 使用 Nodemailer 发送邮件

电子邮件是—种用电子手段提供信息交换的通信方式，是互联网应用最广的服务。通过网络的电子邮件系统，用户可以以非常低廉的价格（不管发送到哪里，都只需负担网费）、非常快速的方式（几秒钟之内可以发送到世界上任何指定的目的地），与世界上任何一个角落的网络用户联系。

在很多项目中，我们都会遇到邮件注册，邮件反馈等需求。在 node 中收发电子邮件也非常简单，因为强大的社区有各种各样的包可以供我么直接使用。Nodemailer包就可以帮助我们快速实现发送邮件的功能。

Github 源码：https://github.com/ogilhinn/node-abc/tree/master/lesson10

Nodemailer 简介

Nodemailer 是一个简单易用的 Node.js 邮件发送组件

官网地址：https://nodemailer.com

GitHub 地址：https://github.com/nodemailer/nodemailer

Nodemailer 的主要特点包括：

  • 支持 Unicode 编码
  • 支持 Window 系统环境
  • 支持 HTML 内容和普通文本内容
  • 支持附件(传送大附件)
  • 支持 HTML 内容中嵌入图片
  • 支持 SSL/STARTTLS 安全的邮件发送
  • 支持内置的 transport 方法和其他插件实现的 transport 方法
  • 支持自定义插件处理消息
  • 支持 XOAUTH2 登录验证

安装使用

首先，我们肯定是要下载安装 注意：Node.js v6+

npm install nodemailer --save

打开官网可以看见一个小例子

'use strict';
const nodemailer = require('nodemailer');

// Generate test SMTP service account from ethereal.email
// Only needed if you don't have a real mail account for testing
nodemailer.createTestAccount((err, account) => {

    // create reusable transporter object using the default SMTP transport
    let transporter = nodemailer.createTransport({
        host: 'smtp.ethereal.email',
        port: 587,
        secure: false, // true for 465, false for other ports
        auth: {
            user: account.user, // generated ethereal user
            pass: account.pass  // generated ethereal password
        }
    });

    // setup email data with unicode symbols
    let mailOptions = {
        from: '"Fred Foo ?" <foo@blurdybloop.com>', // sender address
        to: 'bar@blurdybloop.com, baz@blurdybloop.com', // list of receivers
        subject: 'Hello ✔', // Subject line
        text: 'Hello world?', // plain text body
        html: '<b>Hello world?</b>' // html body
    };

    // send mail with defined transport object
    transporter.sendMail(mailOptions, (error, info) => {
        if (error) {
            return console.log(error);
        }
        console.log('Message sent: %s', info.messageId);
        // Preview only available when sending through an Ethereal account
        console.log('Preview URL: %s', nodemailer.getTestMessageUrl(info));

        // Message sent: <b658f8ca-6296-ccf4-8306-87d57a0b4321@blurdybloop.com>
        // Preview URL: https://ethereal.email/message/WaQKMgKddxQDoou...
    });
});

这个小例子是生成了 Ethereal 的账户进行邮件发送演示的。但是这多没意思，我们来使用自己的邮箱来发送邮件

发出个真实的邮件

这里我使用了我的 qq 邮箱给 163 邮箱发送 email。

'use strict';

const nodemailer = require('nodemailer');

let transporter = nodemailer.createTransport({
  // host: 'smtp.ethereal.email',
  service: 'qq', // 使用了内置传输发送邮件 查看支持列表：https://nodemailer.com/smtp/well-known/
  port: 465, // SMTP 端口
  secureConnection: true, // 使用了 SSL
  auth: {
    user: 'xxxxxx@qq.com',
    // 这里密码不是qq密码，是你设置的smtp授权码
    pass: 'xxxxxx',
  }
});

let mailOptions = {
  from: '"JavaScript之禅" <xxxxx@qq.com>', // sender address
  to: 'xxxxxxxx@163.com', // list of receivers
  subject: 'Hello', // Subject line
  // 发送text或者html格式
  // text: 'Hello world?', // plain text body
  html: '<b>Hello world?</b>' // html body
};

// send mail with defined transport object
transporter.sendMail(mailOptions, (error, info) => {
  if (error) {
    return console.log(error);
  }
  console.log('Message sent: %s', info.messageId);
  // Message sent: <04ec7731-cc68-1ef6-303c-61b0f796b78f@qq.com>
});

运行程序，成功将返回 messageId。这是便可以去收件箱查看这个新邮件啦

email

这里我们需要注意，auth.pass 不是邮箱账户的密码而是 stmp 的授权码。

到此我们就掌握了发邮件的基本操作。

更多配置

  • CC: Carbon Copy(抄送)，用于通知相关的人，收件人可以看到都邮件都抄送给谁了。一般回报工作或跨部门沟通时，都会 CC 给收件人的领导一份
  • BCC:Blind Carbon Copy(暗抄送)，也是用于通知相关的人，但是收件人是看不到邮件被密送给谁了。
  • attachments: 附件

更多配置项：https://nodemailer.com/message/

这里我们就不演示 CC、BCC 了，请自行尝试。我们来试试发送附件

// 只需添加attachments配置项即可
attachments: [
    {   // utf-8 string as an attachment
      filename: 'text.txt',
      content: 'hello world!'
    },
    {
      filename: 'ZenQcode.png',
      path: path.resolve(__dirname, 'ZenQcode.png'),
    }
  ]

发送 email，就可以收到一个内容为 hello world 的 text.txt 文件。

好看的 HTML 邮件

HTML Email 编写指南: http://www.ruanyifeng.com/blog/2013/06/html_email.html

这儿，我们使用 Foundation for Emails: https://foundation.zurb.com/emails.html的模板

'use strict';

const nodemailer = require('nodemailer');
const ejs = require('ejs');
const fs  = require('fs');
const path = require('path');

let transporter = nodemailer.createTransport({
  // host: 'smtp.ethereal.email',
  service: 'qq', // 使用内置传输发送邮件 查看支持列表：https://nodemailer.com/smtp/well-known/
  port: 465, // SMTP 端口
  secureConnection: true, // 使用 SSL
  auth: {
    user: 'xxxxxx@qq.com',
    // 这里密码不是qq密码，是你设置的smtp授权码
    pass: 'xxxxxx',
  }
});

let mailOptions = {
  from: '"JavaScript之禅" <xxxxx@qq.com>', // sender address
  to: 'xxxxxxxx@163.com', // list of receivers
  subject: 'Hello', // Subject line
  // 发送text或者html格式
  // text: 'Hello world?', // plain text body
  html: fs.createReadStream(path.resolve(__dirname, 'email.html')) // 流
};

// send mail with defined transport object
transporter.sendMail(mailOptions, (error, info) => {
  if (error) {
    return console.log(error);
  }
  console.log('Message sent: %s', info.messageId);
  // Message sent: <04ec7731-cc68-1ef6-303c-61b0f796b78f@qq.com>
});

运行程序，你将如愿以偿收到如下 Email。样式可能会有细微偏差

屏幕快照 2017-12-01 16.32.41

上面 email 中我们用了外链的图片，我们也可以使用附件的方式，将图片嵌入进去。给附件加个cid属性即可。

let mailOptions = {
  html: '<img src="cid:01">', // html body
  attachments: [
    {
      filename: 'ZenQcode.png',
      path: path.resolve(__dirname, 'ZenQcode.png'),
      cid: '01',
    }
  ]
};

使用模板引擎

邮件信息一般都不是固定的，我们可以引入模板引擎对 HTML 内容进行渲染。

这里我们使用 Ejs：https://github.com/mde/ejs/来做演示

$ npm install ejs --save

ejs 具体语法请参看官方文档

先建立一个 email.ejs 文件

<h1>hello <%= title %></h1>
<p><%= desc %></p>

修改我们的 js 文件

...
const template = ejs.compile(fs.readFileSync(path.resolve(__dirname, 'email.ejs'), 'utf8'));

const html = template({
  title: 'Ejs',
  desc: '使用Ejs渲染模板',
});

let mailOptions = {
  from: '"JavaScript之禅" <xxxxx@qq.com>', // sender address
  to: 'xxxxx@163.com', // list of receivers
  subject: 'Hello', // Subject line
  html: html,// html body
};
...

到此，你的邮箱将收到一个动态渲染的 hello Ejs。

本文到此告一段落，在此基础上你可以实现更多有用的功能

HTML email 框架推荐

左手代码，右手砖，抛砖引玉

如果你知道更多好用 HTML email 资源，留言交流让更多人知道。

最后福利干货来了

Last update: November 9, 2024