《Mail-Dev 项目使用指南》-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00017/article/details/147411606

《Mail-Dev 项目使用指南》

mail-dev Cross-platform, Local SMTP Server For Email Testing/Debugging 项目地址: https://gitcode.com/gh_mirrors/ma/mail-dev

1. 项目介绍

Mail-Dev 是一个开源项目，旨在提供一个简单易用的开发环境，用于快速搭建邮件服务开发原型。该项目提供了一套完整的邮件发送、接收和调试的工具链，能够帮助开发者减少邮件服务开发的复杂度，提高开发效率。

2. 项目快速启动

环境准备

在开始之前，请确保您的系统中已安装以下依赖：

Node.js（建议版本 LTS）
Git

克隆项目

首先，使用 Git 克隆项目到本地：

git clone https://github.com/samirdjelal/mail-dev.git

安装依赖

进入项目目录，安装项目依赖：

cd mail-dev
npm install

启动服务

安装完成后，启动 Mail-Dev 服务：

npm start

服务启动后，您可以通过浏览器访问 http://localhost:8080 来使用邮件服务。

3. 应用案例和最佳实践

发送邮件

以下是一个使用 Mail-Dev 发送邮件的简单示例：

const nodemailer = require('nodemailer');
const { createTransport } = require('nodemailer');

const transporter = createTransport({
  host: 'smtp.example.com',
  port: 587,
  secure: false, // true for 465, false for other ports
  auth: {
    user: 'your-email@example.com', // generated ethereal user
    pass: 'your-email-password' // generated ethereal password
  }
});

let info = await transporter.sendMail({
  from: '"Example" <your-email@example.com>', // sender address
  to: 'recipient@example.com', // list of receivers
  subject: 'Hello World',
  text: 'Hello world?',
  html: '<b>Hello world?</b>'
});

console.log('Message sent: %s', info.messageId);

接收邮件

您可以使用 IMAP 或 POP3 协议来接收邮件，以下是一个使用 IMAP 接收邮件的示例：

const Imap = require('imap');
const fs = require('fs');

const imap = new Imap({
  user: 'your-email@example.com',
  password: 'your-email-password',
  host: 'imap.example.com',
  port: 993,
  tls: true
});

imap.once('ready', function() {
  console.log('IMAP connected');
  const box = imap.openBox('INBOX', false);
});

imap.once('error', function(err) {
  console.log(err);
});

imap.once('end', function() {
  console.log('Connection ended');
});

imap.connect();