mirror of
https://github.com/continew-org/continew-starter.git
synced 2025-09-09 04:59:21 +08:00
feat: 新增 Mail 自动配置（消息模块）
This commit is contained in:
@@ -221,6 +221,13 @@
|
||||
<version>${revision}</version>
|
||||
</dependency>
|
||||
|
||||
<!-- 消息模块 - 邮件 -->
|
||||
<dependency>
|
||||
<groupId>top.charles7c.continew</groupId>
|
||||
<artifactId>continew-starter-messaging-mail</artifactId>
|
||||
<version>${revision}</version>
|
||||
</dependency>
|
||||
|
||||
<!-- 验证码模块 - 图形验证码 -->
|
||||
<dependency>
|
||||
<groupId>top.charles7c.continew</groupId>
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>top.charles7c.continew</groupId>
|
||||
<artifactId>continew-starter-messaging</artifactId>
|
||||
<version>${revision}</version>
|
||||
</parent>
|
||||
|
||||
<artifactId>continew-starter-messaging-mail</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<name>${project.artifactId}</name>
|
||||
<description>ContiNew Starter 消息模块 - 邮件</description>
|
||||
|
||||
<dependencies>
|
||||
<!-- Java 邮件支持 -->
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-mail</artifactId>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</project>
|
||||
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
|
||||
* <p>
|
||||
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.gnu.org/licenses/lgpl.html
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package top.charles7c.continew.starter.messaging.mail.autoconfigure;
|
||||
|
||||
import jakarta.annotation.PostConstruct;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||
import org.springframework.context.annotation.PropertySource;
|
||||
import top.charles7c.continew.starter.core.handler.GeneralPropertySourceFactory;
|
||||
|
||||
/**
|
||||
* 邮件自动配置
|
||||
*
|
||||
* @author Charles7c
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Slf4j
|
||||
@AutoConfiguration
|
||||
@PropertySource(value = "classpath:default-messaging-mail.yml", factory = GeneralPropertySourceFactory.class)
|
||||
public class MailAutoConfiguration {
|
||||
|
||||
@PostConstruct
|
||||
public void postConstruct() {
|
||||
log.info("[ContiNew Starter] - Auto Configuration 'Mail' completed initialization.");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,241 @@
|
||||
/*
|
||||
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
|
||||
* <p>
|
||||
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.gnu.org/licenses/lgpl.html
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package top.charles7c.continew.starter.messaging.mail.util;
|
||||
|
||||
import cn.hutool.core.collection.CollUtil;
|
||||
import cn.hutool.core.lang.Assert;
|
||||
import cn.hutool.core.util.ArrayUtil;
|
||||
import cn.hutool.core.util.StrUtil;
|
||||
import cn.hutool.extra.spring.SpringUtil;
|
||||
import jakarta.mail.MessagingException;
|
||||
import jakarta.mail.internet.MimeMessage;
|
||||
import lombok.AccessLevel;
|
||||
import lombok.Data;
|
||||
import lombok.NoArgsConstructor;
|
||||
import org.springframework.mail.javamail.JavaMailSender;
|
||||
import org.springframework.mail.javamail.MimeMessageHelper;
|
||||
import top.charles7c.continew.starter.core.constant.StringConstants;
|
||||
|
||||
import java.io.File;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* 邮件工具类
|
||||
*
|
||||
* @author Charles7c
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Data
|
||||
@NoArgsConstructor(access = AccessLevel.PRIVATE)
|
||||
public class MailUtils {
|
||||
|
||||
private static final JavaMailSender MAIL_SENDER = SpringUtil.getBean(JavaMailSender.class);
|
||||
|
||||
/**
|
||||
* 发送文本邮件给单个人
|
||||
*
|
||||
* @param subject
|
||||
* 主题
|
||||
* @param content
|
||||
* 内容
|
||||
* @param to
|
||||
* 收件人
|
||||
* @throws MessagingException
|
||||
* /
|
||||
*/
|
||||
public static void sendText(String to, String subject, String content) throws MessagingException {
|
||||
send(splitAddress(to), null, null, subject, content, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* 发送 HTML 邮件给单个人
|
||||
*
|
||||
* @param subject
|
||||
* 主题
|
||||
* @param content
|
||||
* 内容
|
||||
* @param to
|
||||
* 收件人
|
||||
* @throws MessagingException
|
||||
* /
|
||||
*/
|
||||
public static void sendHtml(String to, String subject, String content) throws MessagingException {
|
||||
send(splitAddress(to), null, null, subject, content, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* 发送 HTML 邮件给单个人
|
||||
*
|
||||
* @param subject
|
||||
* 主题
|
||||
* @param content
|
||||
* 内容
|
||||
* @param to
|
||||
* 收件人
|
||||
* @param files
|
||||
* 附件列表
|
||||
* @throws MessagingException
|
||||
* /
|
||||
*/
|
||||
public static void sendHtml(String to, String subject, String content, File... files) throws MessagingException {
|
||||
send(splitAddress(to), null, null, subject, content, true, files);
|
||||
}
|
||||
|
||||
/**
|
||||
* 发送 HTML 邮件给多个人
|
||||
*
|
||||
* @param subject
|
||||
* 主题
|
||||
* @param content
|
||||
* 内容
|
||||
* @param tos
|
||||
* 收件人列表
|
||||
* @param files
|
||||
* 附件列表
|
||||
* @throws MessagingException
|
||||
* /
|
||||
*/
|
||||
public static void sendHtml(Collection<String> tos, String subject, String content, File... files)
|
||||
throws MessagingException {
|
||||
send(tos, null, null, subject, content, true, files);
|
||||
}
|
||||
|
||||
/**
|
||||
* 发送 HTML 邮件给多个人
|
||||
*
|
||||
* @param subject
|
||||
* 主题
|
||||
* @param content
|
||||
* 内容
|
||||
* @param tos
|
||||
* 收件人列表
|
||||
* @param ccs
|
||||
* 抄送人列表
|
||||
* @param files
|
||||
* 附件列表
|
||||
* @throws MessagingException
|
||||
* /
|
||||
*/
|
||||
public static void sendHtml(Collection<String> tos, Collection<String> ccs, String subject, String content,
|
||||
File... files) throws MessagingException {
|
||||
send(tos, ccs, null, subject, content, true, files);
|
||||
}
|
||||
|
||||
/**
|
||||
* 发送 HTML 邮件给多个人
|
||||
*
|
||||
* @param subject
|
||||
* 主题
|
||||
* @param content
|
||||
* 内容
|
||||
* @param tos
|
||||
* 收件人列表
|
||||
* @param ccs
|
||||
* 抄送人列表
|
||||
* @param bccs
|
||||
* 密送人列表
|
||||
* @param files
|
||||
* 附件列表
|
||||
* @throws MessagingException
|
||||
* /
|
||||
*/
|
||||
public static void sendHtml(Collection<String> tos, Collection<String> ccs, Collection<String> bccs, String subject,
|
||||
String content, File... files) throws MessagingException {
|
||||
send(tos, ccs, bccs, subject, content, true, files);
|
||||
}
|
||||
|
||||
/**
|
||||
* 发送邮件给多个人
|
||||
*
|
||||
* @param tos
|
||||
* 收件人列表
|
||||
* @param ccs
|
||||
* 抄送人列表
|
||||
* @param bccs
|
||||
* 密送人列表
|
||||
* @param subject
|
||||
* 主题
|
||||
* @param content
|
||||
* 内容
|
||||
* @param isHtml
|
||||
* 是否是 HTML
|
||||
* @param files
|
||||
* 附件列表
|
||||
* @throws MessagingException
|
||||
* /
|
||||
*/
|
||||
public static void send(Collection<String> tos, Collection<String> ccs, Collection<String> bccs, String subject,
|
||||
String content, boolean isHtml, File... files) throws MessagingException {
|
||||
Assert.isTrue(CollUtil.isEmpty(tos), "请至少指定一名收件人");
|
||||
MimeMessage mimeMessage = MAIL_SENDER.createMimeMessage();
|
||||
MimeMessageHelper messageHelper =
|
||||
new MimeMessageHelper(mimeMessage, true, StandardCharsets.UTF_8.displayName());
|
||||
|
||||
// 设置基本信息
|
||||
messageHelper.setFrom(SpringUtil.getProperty("spring.mail.username"));
|
||||
messageHelper.setSubject(subject);
|
||||
messageHelper.setText(content, isHtml);
|
||||
|
||||
// 设置收信人
|
||||
// 抄送人
|
||||
if (CollUtil.isNotEmpty(ccs)) {
|
||||
messageHelper.setCc(ccs.toArray(String[]::new));
|
||||
}
|
||||
// 密送人
|
||||
if (CollUtil.isNotEmpty(bccs)) {
|
||||
messageHelper.setBcc(bccs.toArray(String[]::new));
|
||||
}
|
||||
// 收件人
|
||||
messageHelper.setTo(tos.toArray(String[]::new));
|
||||
|
||||
// 设置附件
|
||||
if (ArrayUtil.isNotEmpty(files)) {
|
||||
for (File file : files) {
|
||||
messageHelper.addAttachment(file.getName(), file);
|
||||
}
|
||||
}
|
||||
|
||||
// 发送邮件
|
||||
MAIL_SENDER.send(mimeMessage);
|
||||
}
|
||||
|
||||
/**
|
||||
* 将多个联系人转为列表，分隔符为逗号或者分号
|
||||
*
|
||||
* @param addresses
|
||||
* 多个联系人，如果为空返回null
|
||||
* @return 联系人列表
|
||||
*/
|
||||
private static List<String> splitAddress(String addresses) {
|
||||
if (StrUtil.isBlank(addresses)) {
|
||||
return new ArrayList<>(0);
|
||||
}
|
||||
|
||||
List<String> result;
|
||||
if (StrUtil.contains(addresses, StringConstants.COMMA)) {
|
||||
result = StrUtil.splitTrim(addresses, StringConstants.COMMA);
|
||||
} else if (StrUtil.contains(addresses, StringConstants.SEMICOLON)) {
|
||||
result = StrUtil.splitTrim(addresses, StringConstants.SEMICOLON);
|
||||
} else {
|
||||
result = CollUtil.newArrayList(addresses);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
top.charles7c.continew.starter.messaging.mail.autoconfigure.MailAutoConfiguration
|
||||
@@ -0,0 +1,3 @@
|
||||
--- ### 邮件配置
|
||||
spring.mail:
|
||||
default-encoding: utf-8
|
||||
@@ -17,6 +17,7 @@
|
||||
|
||||
<modules>
|
||||
<module>continew-starter-messaging-sms</module>
|
||||
<module>continew-starter-messaging-mail</module>
|
||||
</modules>
|
||||
|
||||
<dependencies>
|
||||
|
||||
Reference in New Issue
Block a user