介绍
pivot-mailer 是一个 Node.js 的 npm 包,用于发送 HTML 格式的邮件。它基于 nodemailer 库,为邮件发送提供了更加方便的接口和配置方式。
在前端开发中,向用户发送邮件是一项必不可少的功能,而 pivot-mailer 可以让这项工作更加轻松。在使用 pivot-mailer 之前,我们需要安装 Node.js 和 npm,并创建一个空白的 npm 项目。
安装
安装 pivot-mailer 可以通过 npm 安装,使用以下命令:
--- ------- ------------
快速开始
一些基本的使用方法如下:
----- ----------- - ------------------------ ----- ------ - -------------------------- -------- -------- ----- - ----- -------------------- ----- ---------- - --- ----- ------- - - --- ------------------- -------- ----- ------- ----- ----------- ------------ -- ------------------------ -------- -- - ----------------- ---- ---------------- -- ------------ -- - --------------------- ---
如上所示,我们首先需要创建一个 PivotMailer 实例,并提供发送邮件所需要的 smtp 服务和验证信息(这里以 Gmail 为例)。之后,我们可以通过传入邮件选项来发送邮件。
配置选项
pivot-mailer 的配置选项有以下几个:
- service (string): SMTP 服务名称。目前支持的有 “Gmail”、“Yahoo”、“QQ”、“163”、“126” 等。如果需要使用自己的服务,请参考 nodemailer 文档。
- auth (object): SMTP 账号信息,对象结构如下:
- ----- -------------------- -- ---- ---- ----- ---------- -- ---- ---- -
- host (string): SMTP 服务的地址,默认为 “smtp.gmail.com”,如果选择自己的服务,则需要设置为相应的地址。
- port (number): SMTP 服务的端口号,默认为 465,如果选择自己的服务,则需要设置为相应的端口号。
- secure (boolean): 是否启用 SSL/TLS,默认为 true,如果选择自己的服务,则需要设置为相应的选项。
- ignoreTLS (boolean): 是否忽略 TLS,默认为 false,如果选择自己的服务,则需要设置为相应的选项。
发送邮件
通过 mailer.sendMail(options) 可以发送邮件。其中,options 对象包含以下几个选项:
- from (string): 发件人地址,如果不设置,则用 auth.user 的值替代。
- to (string/array): 收件人地址。可以是以逗号分隔的字符串,也可以是由字符串组成的数组。
- cc (string/array): 抄送地址。可以是以逗号分隔的字符串,也可以是由字符串组成的数组。
- bcc (string/array): 密送地址。可以是以逗号分隔的字符串,也可以是由字符串组成的数组。
- subject (string): 邮件主题。
- text (string): 如果不支持 HTML 内容,则使用此文本。
- html (string): HTML 格式的邮件内容。
- attachments (array): 附件。每个附件是一个对象,包含以下两个属性:
- filename (string): 附件的名称。
- content (string): 附件的内容。
完整示例
以下是一个完整的示例,展示了如何创建一个 Gmail 的 SMTP 服务,并发送带有附件的 HTML 格式的邮件。
----- ----------- - ------------------------ ----- ------ - -------------------------- -------- -------- ----- - ----- -------------------- ----- ---------- - --- ----- ------- - - ----- -------------------- --- ------------------- --- -------------------------- -------- ----- ----- ---- ------------ ----- ----------- ------------- ------------ - - --------- ----------- -------- ----- -- - ------ ------------ - - -- ------------------------ -------- -- - ----------------- ---- ---------------- -- ------------ -- - --------------------- ---
总结
如此,我们就学会了如何使用 pivot-mailer 来发送 HTML 格式的邮件。通过使用它,我们可以更加便捷地完成这项任务,从而使我们的工作效率大大提高。如果您在使用过程中遇到了问题,请及时参考 nodemailer 的文档或提交 issue。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005551981e8991b448d24ef