npm 包 k-mailer 使用教程

阅读时长 3 分钟读完

简介

k-mailer 是一个基于 Node.js 开发的邮件发送工具,通过使用 k-mailer 包,您可以快速的在您的 Node.js 程序中集成邮件发送功能。

安装

在使用 k-mailer 之前,需要先安装它。可以通过 npm 直接安装 k-mailer:

本教程使用的 k-mailer 版本为 1.0.0。

使用

在安装 k-mailer 后,k-mailer 可以通过以下代码引入:

1.创建 k-mailer 实例

k-mailer 需要实例化后使用。使用方式如下:

其中 options 是一个对象,它包含了发送邮件的必要信息,包含以下属性:

  • host:必填项,SMTP 服务器地址
  • port:SMTP 服务器端口,默认为 465。
  • secure:加密设置,默认为 true,使用 SSL。
  • auth:认证配置,包括 userpass 两个属性,用于登录 SMTP。
  • from:发送邮件的邮箱地址。
  • to:接收邮件的邮箱地址,多个邮箱地址以 , 分隔。

2.发送邮件

k-mailer 中提供了 send 方法用于发送邮件,示例如下:

其中,subject 表示邮件标题,text 表示邮件正文。

除了 text,还可以发送 html 邮件,示例如下:

3.添加附件

k-mailer 支持添加附件,只需要在 send 方法中添加 attachments 参数即可,如下:

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

其中,filename 表示文件名,path 表示文件路径。

总结

本文介绍了如何使用 k-mailer 在 Node.js 中发送邮件。通过学习本文,您可以快速在您的项目中集成邮件发送功能。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066ef84c49986ca68d8715

纠错
反馈