# magic-api-plugin-mail

**Repository Path**: KS_snow/magic-api-plugin-mail

## Basic Information

- **Project Name**: magic-api-plugin-mail
- **Description**: 用于magic-api的邮件插件
支持报错接口日志邮件通知，模板邮件发送
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 3
- **Created**: 2022-02-22
- **Last Updated**: 2025-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: magic-api, plugin

## README

# magic-api-plugin-mail

# 介绍
- 用于[magic-api](https://gitee.com/ssssssss-team/magic-api) 的邮件插件
- 支持报错接口日志邮件通知，模板邮件发送


# 部署步骤

## maven编译
```cmd
 mvn clean install
```
## pom引入
```xml
<!-- 邮件 -->
<dependency>
    <groupId>cn.luow</groupId>
    <artifactId>magic-api-plugin-mail</artifactId>
    <version>2.0.0</version>
</dependency>
```
## 配置spring-mail
```yaml
spring:  
  mail:
    host: smtp.exmail.qq.com # 发件服务器
    username: xxx@xx.cn # 账号
    password: xxxx # 密码（163需要授权第三方登录密码，请查看设置-客户端授权码密码开通）
    port: 465
    protocol: smtp
    default-encoding: utf-8
    properties:
      mail:
        smtp:
          auth: true
          ssl:
            enable: true
            socketFactory:
              class: com.fintech.modules.base.util.mail.MailSSLSocketFactory
```

## 配置默认邮箱
```yaml
magic-api:
  mail:
    to: xxxx@qq.com #默认发送邮箱
    duration: 5 #相同错误邮件最短发送间隔（分钟）
    defaultFtl: default #默认模板
    logFtl: error-mail #默认日志模板
    keyword: logMail #标记需要邮件监控的接口的关键字
#    webName: '[残叶小站]' #项目名
#    webUrl: 'https://localhost:9999' #项目地址

```
# 使用说明
## 发送邮件
```javascript
import mail;
//发送普通邮件给默认邮箱
mail.sendSimpleMail("测试","这是一封测试邮件")
//发送普通邮件给xxxx
mail.sendSimpleMail("测试","这是一封测试邮件","xxxx@qq.com")
//使用默认模板发送邮件给默认邮箱
mail.send("测试","这是一封测试邮件")
//使用自定义ftl模板发送邮件给xxxx
mail.send("测试",xxxFtl,{content:xxx,...},"xxxx@qq.com")
```
- 内置了一个默认模板，如需添加新的模板，请放到/templates下
- 内置了一个日志模板，如需添加新的模板，请放到/templates下
- 需要邮件报错提醒的接口，在对应接口的***接口选项***里添加标记
    > logMail : true