@feng-j/midwayjs-mailer
v2.0.1
Published
用于发送邮件的MidwayJS的组件
Downloads
10
Readme
MidwayJS-Mailer
用于在MidwayJS项目中快捷使用邮件发送功能。
安装使用
$ npm install nodemailer @types/nodemailer @feng-j/midwayjs-mailer在configuration中引入mailer
import * as mailer from '@feng-j/midwayjs-mailer';
// ......
@Configuration({
imports: [
// ......
malier,
],
importConfigs: [join(__dirname, './config')],
})
export class MainConfiguration {
@App('koa')
app: koa.Application;
async onReady() {
this.app.useMiddleware([ReportMiddleware]);
}
}
在配置文件中添加mailer相关的配置, 配置项直接传给nodemailer, 所以配置与nodemailer createTransport参数一致。
export default {
// ......
mailer: {
host: 'smtp.qq.com',
secure: true,
auth: {
user: '[email protected]',
pass: 'xxx'
}
},
} as MidwayConfig;
然后就可以通过Inject来注入MailerService了
import { Inject, Controller, Get, Query } from '@midwayjs/core';
import { Context } from '@midwayjs/koa';
import { MailerService } from '@feng-j/midwayjs-mailer';
@Controller('/api')
export class APIController {
@Inject()
ctx: Context;
@Inject()
mailerService: MailerService;
@Get('/send')
async sendEmail() {
await this.mailerService.send({
subject: 'custom prefix render',
to: '[email protected]',
text: 'Hello!',
})
}
}
更多使用方法可以见nodemailer 文档
模板渲染
除了基本文本内容邮件的发送，还可以在邮件中嵌入HTML内容，通过模板引擎渲染，目前支持ejs、pug和nunjucks模板引擎的渲染。(如果要是用其他的模板引擎，可以将渲染完成的htmlStr手动传入, 后期可以支持自定义渲染）
以ejs模板引擎为例，在配置文件中开启模板渲染的支持
export default {
// ......
mailer: {
host: 'smtp.qq.com',
secure: true,
auth: {
user: '[email protected]',
pass: 'xxx'
},
template: 'ejs', // 指定模板引擎
},
} as MidwayConfig;
需要额外安装ejs的依赖库
$ pnpm i ejs然后准备一个模板文件，例如：
<!doctype html>
<html lang="zh">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Order</title>
</head>
<body>
<h3>
感谢您订购我们的服务，当前订单（<%= orderId %>）已经生效。
</h3>
祝您使用愉快
</body>
</html>
然后在发送邮件的时候传入模板文件路径，以及模板数据，例如：
import { Inject, Controller, Get, Query } from '@midwayjs/core';
import { Context } from '@midwayjs/koa';
import { MailerService } from '@feng-j/midwayjs-mailer';
import { join } from 'path';
@Controller('/api')
export class APIController {
@Inject()
ctx: Context;
@Inject()
mailerService: MailerService;
@Get('/send')
async sendEmail() {
await mailerService.send(
{
subject: 'templateMail',
from: '小枫 <[email protected]>',
to: '[email protected]',
},
{
path: join(__dirname, './fixtures/templateMail/src/template/order.ejs'),
record: { orderId: 'BL20241208160753' },
}
);
}
}
发送邮件效果如下：
