npm包 Good-Mail 使用教程-JavaScript中文网-JavaScript教程资源分享门户

介绍

NPM（Node.js包管理器）是 Node.js 的包管理器，Good-Mail是一款基于 Node.js 的邮件发送模块。它可以用于在 Node.js 应用程序中快速方便地发送电子邮件。Good-Mail 提供了一些强大而灵活的功能，使得邮件发送变得非常容易。

本文将带您深入了解 Good-Mail 的功能与使用，教您如何快速发送邮件。

安装

运行以下命令进行安装：

npm install good-mail --save

在项目中引入 Good-Mail：

const GoodMail = require('good-mail');

发送邮件

Good-Mail发送邮件需要使用SMTP协议。在发送邮件之前您需要准备好：

SMTP服务器地址
SMTP服务器端口号
发送邮件的邮箱地址和密码

以下是定义 smtp 服务器的配置：

-- -------------------- ---- -------
----- -------------- - -
    ----- -----------------
    ----- ----
    ----------------- -----
    ----- -
        ----- -----------------------
        ----- ---------------
    -
-

接下来，就可以实例化Good-Mail了：

const goodMail = new GoodMail(smtpConnection);

现在我们可以开始邮件发送了。以下是Good-Mail发送邮件的基本语法：

goodMail.sendMail(mailOptions, callback);

其中：

mailOptions：包含邮件配置信息的一个JSON对象。
callback：回调函数会在邮件发送成功或失败时被调用。

以下是一个邮件配置的示例：

const mailOptions = {
    from: 'your-email@gmail.com',
    to: 'recipient@domain.com',
    subject: '测试邮件',
    html: '<p>这是一封测试邮件！</p>'
};

Good-Mail API

sendMail( mailOptions[, callback])

mailOptions (Object)：必填项，包含发件人、邮件接收人、邮件主题以及邮件内容等信息的对象。
callback (function)：回调函数。该函数将作为发送邮件操作的结果，它接收两个参数：err 和 response。其中，err 参数存储任何错误信息，而response 参数存储服务器响应结果。

以下是一个使用 sendMail 方法的示例：

-- -------------------- ---- -------
-------------------
    ----- -----------------------
    --- -----------------------
    -------- -------
    ----- ------------------
-- ------------- --------- -
    -- ----- -
        ---------------------- -----
    - ---- -
        ---------------------- ----------
    -
---

setSmtpConnection( smtpConnection )

smtpConnection：必填项，SMTP服务器配置对象。smtpConnection对象包含 SMTP服务器地址、SMTP服务器端口号、发送邮件的邮箱地址和密码等信息。

-- -------------------- ---- -------
----------------------------
    ----- -----------------
    ----- ----
    ----------------- -----
    ----- -
        ----- -----------------------
        ----- ---------------
    -
---

setMailOptions( mailOptions )

mailOptions (Object)：必填项，包含发件人、邮件接收人、邮件主题以及邮件内容等信息的对象。

以下是一个 mailOptions 对象的示例：

goodMail.setMailOptions({
    from: 'your-email@gmail.com',
    to: 'recipient@domain.com',
    subject: '测试邮件',
    html: '<p>这是一封测试邮件！</p>'
});

Good-Mail 配置管理

goodMail.setSmtpConnection(smtpConnection);
goodMail.setMailOptions(mailOptions);
goodMail.sendMail(callback);

以上是 Good-Mail 的基本操作，您可以根据业务需求进行灵活地调整。通过 Good-Mail，您可以快速、方便地在 Node.js 应用程序中发送电子邮件。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600572c981e8991b448e8f68