📜  swal mail (1)

📅  最后修改于: 2023-12-03 15:35:12.234000             🧑  作者: Mango

swal-mail介绍

swal-mail是一款简单易用的邮件发送模块,它基于Node.js,能够轻松集成在你的项目中,方便快捷地给用户发送邮件。

特点
  • 高度可配置,支持自定义发送邮箱及SMTP服务商配置
  • 简单、易用,提供友好的API
  • 支持错误处理及调试
安装

安装swal-mail:

npm install swal-mail
快速开始

在你的代码中,你可以轻松地导入swal-mail模块并使用它提供的APIs:

const SwalMail = require('swal-mail');

SwalMail.send({
  from: 'sender@example.com',
  to: 'receiver@example.com',
  subject: 'Swal Mail Test',
  text: 'This is a test message sent using Swal Mail.'
}).then(() => console.log('Email has been sent.')).catch(console.error);
API
配置

可以使用SwalMail.config()方法进行模块的基础配置,以下为支持的配置字段及默认值:

SwalMail.config({
  host: 'smtp.gmail.com',
  port: 587,
  secure: false,
  auth: {
    user: 'sender@example.com',
    pass: 'password'
  }
});
发送邮件

使用SwalMail.send()方法可以发送一封邮件,以下为支持的邮件字段:

  • from - 发件人邮箱地址
  • to - 收件人邮箱地址
  • subject - 邮件主题
  • text - 邮件正文(纯文本格式)
  • html - 邮件正文(HTML格式)
SwalMail.send({
  from: 'sender@example.com',
  to: 'receiver@example.com',
  subject: 'Swal Mail Test',
  text: 'This is a test message sent using Swal Mail.'
}).then(() => console.log('Email has been sent.')).catch(console.error);
错误处理

swal-mail中,所有API返回一个Promise对象,可以对发送结果进行捕获及处理:

SwalMail.send({
    ...
}).then(() => {
    console.log('邮件发送成功');
}).catch((error) => {
    console.error(`邮件发送失败:${error}`);
});
结束语

以上就是swal-mail的简介及使用方法,你可以在你的项目中方便地使用它来发送邮件。如果在使用中遇到任何问题,欢迎在GitHub库中提交issue或pull request。