首页
/ Nodemailer 技术文档

Nodemailer 技术文档

2024-12-23 16:31:44作者:毕习沙Eudora

1. 安装指南

1.1 安装 Node.js

在使用 Nodemailer 之前,请确保你已经安装了 Node.js。Nodemailer 支持 Node.js 6.0.0 及以上版本。你可以通过以下命令检查 Node.js 是否已安装:

node -v

如果未安装,请访问 Node.js 官方网站 下载并安装适合你操作系统的版本。

1.2 安装 Nodemailer

使用 npm 安装 Nodemailer:

npm install nodemailer

2. 项目的使用说明

2.1 基本用法

Nodemailer 是一个用于从 Node.js 发送电子邮件的库。以下是一个简单的示例,展示如何使用 Nodemailer 发送邮件:

const nodemailer = require('nodemailer');

// 创建一个 SMTP 传输对象
let transporter = nodemailer.createTransport({
    host: 'smtp.example.com',
    port: 587,
    secure: false, // true for 465, false for other ports
    auth: {
        user: 'user@example.com',
        pass: 'password'
    }
});

// 定义邮件选项
let mailOptions = {
    from: '"发件人" <user@example.com>',
    to: 'recipient@example.com',
    subject: 'Hello ✔',
    text: '这是一封测试邮件',
    html: '<b>这是一封测试邮件</b>'
};

// 发送邮件
transporter.sendMail(mailOptions, (error, info) => {
    if (error) {
        return console.log(error);
    }
    console.log('Message sent: %s', info.messageId);
});

2.2 使用 Gmail

如果你使用 Gmail 发送邮件,请注意 Gmail 的限制。你可以参考 Gmail 使用指南 获取更多信息。

2.3 处理常见问题

  • SyntaxError: 如果你遇到 SyntaxError,请确保你使用的是 Node.js 6.0.0 及以上版本。
  • ETIMEDOUT 错误: 检查防火墙设置,确保端口未被阻止。
  • TLS 错误: 确保 secure 选项设置正确,并检查 Node.js 的 TLS 支持。

3. 项目 API 使用文档

3.1 createTransport(options)

创建一个 SMTP 传输对象。options 参数包含以下字段:

  • host: SMTP 服务器地址。
  • port: SMTP 服务器端口。
  • secure: 是否使用 SSL/TLS。
  • auth: 认证信息,包含 userpass

3.2 sendMail(mailOptions, callback)

发送邮件。mailOptions 参数包含以下字段:

  • from: 发件人地址。
  • to: 收件人地址。
  • subject: 邮件主题。
  • text: 邮件文本内容。
  • html: 邮件 HTML 内容。

callback 函数在邮件发送完成后调用,包含 errorinfo 参数。

4. 项目安装方式

4.1 通过 npm 安装

使用以下命令安装 Nodemailer:

npm install nodemailer

4.2 手动下载

你也可以从 GitHub 下载源代码,并手动安装依赖。


通过以上文档,你应该能够顺利安装和使用 Nodemailer 发送电子邮件。如果在使用过程中遇到问题,请参考官方文档或访问 Stack Overflow 寻求帮助。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
566
410
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
124
208
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
75
145
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
428
38
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
693
91
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
253
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
298
1.03 K
Dora-SSRDora-SSR
Dora SSR 是一款跨平台的游戏引擎,提供前沿或是具有探索性的游戏开发功能。它内置了Web IDE,提供了可以轻轻松松通过浏览器访问的快捷游戏开发环境,特别适合于在新兴市场如国产游戏掌机和其它移动电子设备上直接进行游戏开发和编程学习。
C++
20
4
CS-BooksCS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
96
13