JarCastingemail-plus
邮件增强框架
email-plus-core
邮件增强框架核心包
<dependency>
<groupId>com.github.kancyframework</groupId>
<artifactId>email-plus-core</artifactId>
<version>${version}</version>
</dependency>
发送邮件
-
方式一:（常规）
// 定义一个Email Sender SimpleEmailSender emailSender = new SimpleEmailSender(); emailSender.setHost("smtp.qq.com"); emailSender.setUsername("[email protected]"); emailSender.setPassword("password"); // 定义一封邮件 Email email = new SimpleEmail("[email protected]", "email contents") // 发送邮件 emailSender.send(email);
-
方式二:（快捷）
// 定义一个QQEmail Sender EmailSender qqSimpleEmailSender = new QQSimpleEmailSender("[email protected]", "password"); // 定义一封邮件 Email email = new SimpleEmail("[email protected]", "email contents") // 发送邮件 emailSender.send(email);
-
方式三:（功能增强，邮件池）
// 定义一个Email Sender Pool EmailSender emailSender = new PooledEmailSender(); // 定义一封邮件 Email email = new SimpleEmail("[email protected]", "email contents") // 发送邮件 emailSender.send(email);
功能特点
- 邮件池
- SPI扩展
- 邮件发件人账号配置化
- 邮件密码加密
邮件池
邮件池配置
自动寻找类路径文件：email.properties,META-INF/email.properties文件。
emailplus.sender.name01.host = smtp.qq.com
emailplus.sender.name01.port = 25
emailplus.sender.name01.username = [email protected]
emailplus.sender.name01.password = ENC(02Hz0uEM+qgrf08oQ6jWZuRSyUAga1Z/VyQ=)
emailplus.sender.name02.host = smtp.qq.com
emailplus.sender.name02.port = 25
emailplus.sender.name02.username = [email protected]
emailplus.sender.name02.password = ENC(8nT5wqoL8qM4aft1L4A5/Qdc5b8e7uSsnBm5uRjEGAk=)
emailplus.sender.name03.host = smtp.qq.com
emailplus.sender.name03.port = 25
emailplus.sender.name03.username = [email protected]
emailplus.sender.name03.password = ENC(zXHzmOcN+6I8f1q7JP9cQ0rWW4b4f30StNc=)
- 自定义数据源：实现
EmailSenderPropertiesDataSource接口，基于JDK SPI扩展。
使用邮件池
使用方法和普通EmailSender的一样，都实现了EmailSender接口，内部会自动选择一个可用的EmailSender， 默认选择策略是轮询，可实现EmailSenderSelector接口进行自定义。
// 定义一个Email Sender Pool
EmailSender emailSender = new PooledEmailSender();
// 定义一封邮件
Email email = new SimpleEmail("[email protected]", "email contents")
// 发送邮件
emailSender.send(email);
email-plus-spring-boot-starter
邮件增强框架SpringBoot启动器
<dependency>
<groupId>com.github.kancyframework</groupId>
<artifactId>email-plus-spring-boot-starter</artifactId>
<version>${version}</version>
</dependency>
主要功能
-
邮件定义配置化（通过emailKey唯一标识一封邮件）
- 邮件定义（收件人，抄送人，主题，内容，附件等）
- 异步、同步发送
- 模板化支持
-
内置freemarker邮件模板化
-
邮件通知定义配置化（通过
@EmailNotice注解AOP拦截）- 令牌桶（本地内存，redis）
- 轮询计数器（本地内存，redis）
-
内置Endpoint配置刷新端点
/actuator/refreshEmailSender
使用方式
配置
emailplus:
# 定义一些邮件发送者，注入到邮件池
sender:
name01:
host: smtp.qq.com
port: 25
username: [email protected]
password: ENC(0Xn6xLVRo/JnOaY9e9RwtcFf2mKIw5tmB9W67pVCOR0=)
name02:
host: smtp.qq.com
port: 25
username: [email protected]
password: ENC(0Xn6xLVRo/JnOaY9e9RwtcFf2mKIw5tmB9W67pVCOR0=)
name03:
host: smtp.qq.com
port: 25
username: [email protected]
password: ENC(0Xn6xLVRo/JnOaY9e9RwtcFf2mKIw5tmB9W67pVCOR0=)
#定义一些邮件
email-definitions:
test-simple-email:
to: [email protected]
subject: 测试
content: "ok!"
async: true
test-email-notice:
subject: 测试邮件异常通知
to: [email protected],[email protected]
cc: [email protected]
template: error-notice-email-template.ftl
#定义邮件通知
email-notices:
test-email-notice:
capacity: 3
refillTokens: 2
refillDuration: PT5S
trigger: redisBucketEmailNoticeTrigger
email-key: test-email-notice
async: true
发送邮件
public class EmailplusServiceTest {
@Autowired
private EmailplusService emailplusService;
/**
* 发送邮件
*/
@Test
public void sendSimpleEmail01() {
emailplusService.sendSimpleEmail("test-simple-email");
}
/**
* 发送邮件
*/
@Test
public void sendSimpleEmail02() {
emailplusService.sendSimpleEmail("test-simple-email", "custom email contents");
}
}
邮件通知
/**
* `@EmailNotice`监控getUser()方法执行错误信息
*/
@Service
public class UserServiceImpl implements UserService {
/**
* 当getUser()方法执行错误的次数达到配置的上线，就会进行邮件通知
*/
@EmailNotice("test-email-notice")
@Override
public String getUser() {
throw new UnsupportedOperationException("测试异常");
}
}