lsm/hutool
1
0
Fork 0
mirror of https://gitee.com/dromara/hutool.git synced 2025-10-07 23:24:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

add SMTPMessage

Browse Source
This commit is contained in:
Looly
2025-09-13 19:16:13 +08:00
parent 7a34175318
commit 705872eeda
6 changed files with 506 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
hutool-core/src/main/java/cn/hutool/v7/core/net/UserPassAuthenticator.java
View File

@@ -47,7 +47,16 @@ public class UserPassAuthenticator extends Authenticator {
* @param pass 密码
*/
public UserPassAuthenticator(final String user, final char[] pass) {
auth = new PasswordAuthentication(user, pass);
this(new PasswordAuthentication(user, pass));
}
/**
* 构造
*
* @param auth 账号密码
*/
public UserPassAuthenticator(final PasswordAuthentication auth) {
this.auth = auth;
}
@Override

180
hutool-extra/src/main/java/cn/hutool/v7/extra/mail/Mail.java
View File

@@ -16,33 +16,20 @@
package cn.hutool.v7.extra.mail;
import cn.hutool.v7.core.lang.builder.Builder;
import cn.hutool.v7.core.io.file.FileUtil;
import cn.hutool.v7.core.array.ArrayUtil;
import cn.hutool.v7.core.io.IORuntimeException;
import cn.hutool.v7.core.io.IoUtil;
import cn.hutool.v7.core.text.StrUtil;
import cn.hutool.v7.core.array.ArrayUtil;
import cn.hutool.v7.core.io.file.FileUtil;
import cn.hutool.v7.core.lang.builder.Builder;
import cn.hutool.v7.core.util.ObjUtil;
import jakarta.activation.DataHandler;
import jakarta.activation.DataSource;
import jakarta.activation.FileDataSource;
import jakarta.activation.FileTypeMap;
import jakarta.mail.Address;
import jakarta.mail.MessagingException;
import jakarta.mail.Multipart;
import jakarta.mail.SendFailedException;
import jakarta.mail.Session;
import jakarta.mail.Transport;
import jakarta.mail.internet.MimeBodyPart;
import jakarta.mail.internet.MimeMessage;
import jakarta.mail.internet.MimeMultipart;
import jakarta.mail.internet.MimeUtility;
import jakarta.mail.util.ByteArrayDataSource;
import java.io.*;
import java.nio.charset.Charset;
import java.util.Date;
/**
* 邮件发送客户端
@@ -87,9 +74,9 @@ public class Mail implements Builder<MimeMessage> {
*/
private boolean isHtml;
/**
* 正文、附件和图片的混合部分
* 附件或图片
*/
private final Multipart multipart = new MimeMultipart();
private DataSource[] attachments;
/**
* 是否使用全局会话，默认为false
*/
@@ -251,7 +238,7 @@ public class Mail implements Builder<MimeMessage> {
* @param files 附件文件列表
* @return this
*/
public Mail setFiles(final File... files) {
public Mail addFiles(final File... files) {
if (ArrayUtil.isEmpty(files)) {
return this;
}
@@ -260,7 +247,7 @@ public class Mail implements Builder<MimeMessage> {
for (int i = 0; i < files.length; i++) {
attachments[i] = new FileDataSource(files[i]);
}
return setAttachments(attachments);
return addAttachments(attachments);
}
/**
@@ -292,7 +279,7 @@ public class Mail implements Builder<MimeMessage> {
throw new IORuntimeException(e);
}
imgSource.setName(cid);
return setAttachments(imgSource);
return addAttachments(imgSource);
}
/**
@@ -320,30 +307,12 @@ public class Mail implements Builder<MimeMessage> {
* @return this
* @since 4.0.9
*/
public Mail setAttachments(final DataSource... attachments) {
if (ArrayUtil.isNotEmpty(attachments)) {
final Charset charset = this.mailAccount.getCharset();
MimeBodyPart bodyPart;
String nameEncoded;
try {
for (final DataSource attachment : attachments) {
bodyPart = new MimeBodyPart();
bodyPart.setDataHandler(new DataHandler(attachment));
nameEncoded = attachment.getName();
if (this.mailAccount.isEncodefilename()) {
nameEncoded = InternalMailUtil.encodeText(nameEncoded, charset);
}
// 普通附件文件名
bodyPart.setFileName(nameEncoded);
if (StrUtil.startWith(attachment.getContentType(), "image/")) {
// 图片附件，用于正文中引用图片
bodyPart.setContentID(nameEncoded);
bodyPart.setDisposition(MimeBodyPart.INLINE);
}
this.multipart.addBodyPart(bodyPart);
}
} catch (final MessagingException e) {
throw new MailException(e);
public Mail addAttachments(final DataSource... attachments) {
if(ArrayUtil.isNotEmpty(attachments)){
if(null == this.attachments){
this.attachments = attachments;
}else{
this.attachments = ArrayUtil.addAll(this.attachments, attachments);
}
}
return this;
@@ -387,12 +356,20 @@ public class Mail implements Builder<MimeMessage> {
// --------------------------------------------------------------- Getters and Setters end
@Override
public MimeMessage build() {
try {
return buildMsg();
} catch (final MessagingException e) {
throw new MailException(e);
}
public SMTPMessage build() {
return SMTPMessage.of(this.mailAccount, this.useGlobalSession, this.debugOutput)
// 标题
.setTitle(this.title)
// 收件人
.setTos(this.tos)
// 抄送人
.setCcs(this.ccs)
// 密送人
.setBccs(this.bccs)
// 回复地址(reply-to)
.setReply(this.reply)
// 内容和附件
.setContent(this.content, this.isHtml);
}
/**
@@ -402,105 +379,6 @@ public class Mail implements Builder<MimeMessage> {
* @throws MailException 邮件发送异常
*/
public String send() throws MailException {
try {
return doSend();
} catch (final MessagingException e) {
if (e instanceof SendFailedException) {
// 当地址无效时，显示更加详细的无效地址信息
final Address[] invalidAddresses = ((SendFailedException) e).getInvalidAddresses();
final String msg = StrUtil.format("Invalid Addresses: {}", ArrayUtil.toString(invalidAddresses));
throw new MailException(msg, e);
}
throw new MailException(e);
}
return build().send();
}
// --------------------------------------------------------------- Private method start
/**
* 执行发送
*
* @return message-id
* @throws MessagingException 发送异常
*/
private String doSend() throws MessagingException {
final MimeMessage mimeMessage = buildMsg();
Transport.send(mimeMessage);
return mimeMessage.getMessageID();
}
/**
* 构建消息
*
* @return {@link MimeMessage}消息
* @throws MessagingException 消息异常
*/
private MimeMessage buildMsg() throws MessagingException {
final Charset charset = this.mailAccount.getCharset();
final MimeMessage msg = new MimeMessage(getSession());
// 发件人
final String from = this.mailAccount.getFrom();
if (StrUtil.isEmpty(from)) {
// 用户未提供发送方，则从Session中自动获取
msg.setFrom();
} else {
msg.setFrom(InternalMailUtil.parseFirstAddress(from, charset));
}
// 标题
msg.setSubject(this.title, (null == charset) ? null : charset.name());
// 发送时间
msg.setSentDate(new Date());
// 内容和附件
msg.setContent(buildContent(charset));
// 收件人
msg.setRecipients(MimeMessage.RecipientType.TO, InternalMailUtil.parseAddressFromStrs(this.tos, charset));
// 抄送人
if (ArrayUtil.isNotEmpty(this.ccs)) {
msg.setRecipients(MimeMessage.RecipientType.CC, InternalMailUtil.parseAddressFromStrs(this.ccs, charset));
}
// 密送人
if (ArrayUtil.isNotEmpty(this.bccs)) {
msg.setRecipients(MimeMessage.RecipientType.BCC, InternalMailUtil.parseAddressFromStrs(this.bccs, charset));
}
// 回复地址(reply-to)
if (ArrayUtil.isNotEmpty(this.reply)) {
msg.setReplyTo(InternalMailUtil.parseAddressFromStrs(this.reply, charset));
}
return msg;
}
/**
* 构建邮件信息主体
*
* @param charset 编码，{@code null}则使用{@link MimeUtility#getDefaultJavaCharset()}
* @return 邮件信息主体
* @throws MessagingException 消息异常
*/
private Multipart buildContent(final Charset charset) throws MessagingException {
final String charsetStr = null != charset ? charset.name() : MimeUtility.getDefaultJavaCharset();
// 正文
final MimeBodyPart body = new MimeBodyPart();
body.setContent(content, StrUtil.format("text/{}; charset={}", isHtml ? "html" : "plain", charsetStr));
this.multipart.addBodyPart(body, 0);
return this.multipart;
}
/**
* 获取默认邮件会话<br>
* 如果为全局单例的会话，则全局只允许一个邮件帐号，否则每次发送邮件会新建一个新的会话
*
* @return 邮件会话 {@link Session}
*/
private Session getSession() {
final Session session = MailUtil.getSession(this.mailAccount, this.useGlobalSession);
if (null != this.debugOutput) {
session.setDebugOut(debugOutput);
}
return session;
}
// --------------------------------------------------------------- Private method end
}

2
hutool-extra/src/main/java/cn/hutool/v7/extra/mail/MailAccount.java
View File

@@ -23,6 +23,7 @@ import cn.hutool.v7.core.util.ObjUtil;
import cn.hutool.v7.core.text.StrUtil;
import cn.hutool.v7.setting.Setting;
import java.io.Serial;
import java.io.Serializable;
import java.nio.charset.Charset;
import java.util.HashMap;
@@ -35,6 +36,7 @@ import java.util.Properties;
* @author Luxiaolei
*/
public class MailAccount implements Serializable {
@Serial
private static final long serialVersionUID = -6937313421815719204L;
private static final String MAIL_PROTOCOL = "mail.transport.protocol";

19
hutool-extra/src/main/java/cn/hutool/v7/extra/mail/MailUtil.java
View File

@@ -16,16 +16,15 @@
package cn.hutool.v7.extra.mail;
import jakarta.mail.Authenticator;
import jakarta.mail.PasswordAuthentication;
import jakarta.mail.Session;
import cn.hutool.v7.core.collection.CollUtil;
import cn.hutool.v7.core.collection.ListUtil;
import cn.hutool.v7.core.io.IoUtil;
import cn.hutool.v7.core.map.MapUtil;
import cn.hutool.v7.core.text.CharUtil;
import cn.hutool.v7.core.text.StrUtil;
import cn.hutool.v7.core.text.split.SplitUtil;
import cn.hutool.v7.core.text.CharUtil;
import jakarta.mail.Authenticator;
import jakarta.mail.Session;
import java.io.File;
import java.io.InputStream;
@@ -379,15 +378,7 @@ public class MailUtil {
public static Session getSession(final MailAccount mailAccount, final boolean isSingleton) {
Authenticator authenticator = null;
if (mailAccount.isAuth()) {
authenticator = new Authenticator() {
@Override
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication(
mailAccount.getUser(),
String.valueOf(mailAccount.getPass())
);
}
};
authenticator = new UserPassMailAuthenticator(mailAccount);
}
return isSingleton ? Session.getDefaultInstance(mailAccount.getSmtpProps(), authenticator) //
@@ -429,7 +420,7 @@ public class MailUtil {
mail.setTitle(subject);
mail.setContent(content);
mail.setHtml(isHtml);
mail.setFiles(files);
mail.addFiles(files);
// 图片
if (MapUtil.isNotEmpty(imageMap)) {

398
hutool-extra/src/main/java/cn/hutool/v7/extra/mail/SMTPMessage.java Normal file
View File

@@ -0,0 +1,398 @@
/*
* Copyright (c) 2025 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 cn.hutool.v7.extra.mail;
import cn.hutool.v7.core.array.ArrayUtil;
import cn.hutool.v7.core.date.DateUtil;
import cn.hutool.v7.core.io.IORuntimeException;
import cn.hutool.v7.core.io.IoUtil;
import cn.hutool.v7.core.io.file.FileUtil;
import cn.hutool.v7.core.text.StrUtil;
import cn.hutool.v7.core.util.ObjUtil;
import jakarta.activation.DataHandler;
import jakarta.activation.DataSource;
import jakarta.activation.FileDataSource;
import jakarta.activation.FileTypeMap;
import jakarta.mail.*;
import jakarta.mail.internet.MimeBodyPart;
import jakarta.mail.internet.MimeMessage;
import jakarta.mail.internet.MimeMultipart;
import jakarta.mail.internet.MimeUtility;
import jakarta.mail.util.ByteArrayDataSource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.nio.charset.Charset;
/**
* SMTP消息封装
*
* @author looly
* @since 7.0.0
*/
public class SMTPMessage extends MimeMessage {
/**
* 创建SMTP消息
*
* @param mailAccount 邮件账户
* @param useGlobalSession 是否使用全局Session
* @param debugOutput 输出调试信息
* @return this
*/
public static SMTPMessage of(final MailAccount mailAccount, final boolean useGlobalSession, final PrintStream debugOutput){
final Session session = MailUtil.getSession(mailAccount, useGlobalSession);
if (null != debugOutput) {
session.setDebugOut(debugOutput);
}
return new SMTPMessage(mailAccount, session);
}
/**
* 邮件账户
*/
private final MailAccount mailAccount;
/**
* 正文、附件和图片的混合部分
*/
private final Multipart multipart;
/**
* 构造
*
* @param mailAccount 邮件账户
* @param session Session
*/
public SMTPMessage(final MailAccount mailAccount, final Session session) {
super(session);
this.mailAccount = mailAccount;
multipart = new MimeMultipart();
init();
}
/**
* 初始化
*/
private void init() {
// 发件人
final String from = this.mailAccount.getFrom();
try {
if (StrUtil.isEmpty(from)) {
// 用户未提供发送方，则从Session中自动获取
super.setFrom();
} else {
super.setFrom(InternalMailUtil.parseFirstAddress(from, this.mailAccount.getCharset()));
}
// 默认发送时间
super.setSentDate(DateUtil.now());
} catch (final MessagingException e) {
throw new MailException(e);
}
}
/**
* 设置标题
*
* @param title 标题
* @return this
*/
public SMTPMessage setTitle(final String title) {
try {
super.setSubject(title, ObjUtil.apply(mailAccount.getCharset(), Object::toString));
} catch (final MessagingException e) {
throw new MailException(e);
}
return this;
}
// region ----- setRecipients
/**
* 设置收件人
*
* @param tos 收件人列表
* @return this
*/
public SMTPMessage setTos(final String... tos) {
return this.setRecipients(Message.RecipientType.TO, tos);
}
/**
* 设置抄送
*
* @param ccs 抄送列表
* @return this
*/
public SMTPMessage setCcs(final String... ccs) {
return this.setRecipients(Message.RecipientType.CC, ccs);
}
/**
* 设置密送
*
* @param bccs 密送列表
* @return this
*/
public SMTPMessage setBccs(final String... bccs) {
return this.setRecipients(Message.RecipientType.BCC, bccs);
}
/**
* 设置收件人，支持收件人、密送、抄送
*
* @param type 收件人类型
* @param addresses 收件人列表
* @return this
*/
public SMTPMessage setRecipients(final Message.RecipientType type, final String... addresses) {
try {
super.setRecipients(type, InternalMailUtil.parseAddressFromStrs(addresses, this.mailAccount.getCharset()));
} catch (final MessagingException e) {
throw new MailException(e);
}
return this;
}
// endregion
/**
* 设置回复地址
*
* @param reply 回复地址列表
* @return this
*/
public SMTPMessage setReply(final String... reply) {
try {
super.setReplyTo(InternalMailUtil.parseAddressFromStrs(reply, this.mailAccount.getCharset()));
} catch (final MessagingException e) {
throw new MailException(e);
}
return this;
}
/**
* 设置邮件内容
*
* @param content 内容
* @param isHtml 是否为HTML
* @return this
*/
public SMTPMessage setContent(final String content, final boolean isHtml) {
try {
super.setContent(buildContent(this.mailAccount.getCharset(), isHtml));
} catch (final MessagingException e) {
throw new MailException(e);
}
return this;
}
// region ----- addAttachments
/**
* 增加图片，图片的键对应到邮件模板中的占位字符串，图片类型默认为"image/jpeg"
*
* @param cid 图片与占位符，占位符格式为cid:${cid}
* @param imageStream 图片文件
* @return this
*/
public SMTPMessage addImage(final String cid, final InputStream imageStream) {
return addImage(cid, imageStream, null);
}
/**
* 增加图片，图片的键对应到邮件模板中的占位字符串
*
* @param cid 图片与占位符，占位符格式为cid:${cid}
* @param imageFile 图片文件
* @return this
*/
public SMTPMessage addImage(final String cid, final File imageFile) {
InputStream in = null;
try {
in = FileUtil.getInputStream(imageFile);
return addImage(cid, in, FileTypeMap.getDefaultFileTypeMap().getContentType(imageFile));
} finally {
IoUtil.closeQuietly(in);
}
}
/**
* 增加图片，图片的键对应到邮件模板中的占位字符串
*
* @param cid 图片与占位符，占位符格式为cid:${cid}
* @param imageStream 图片流，不关闭
* @param contentType 图片类型，null赋值默认的"image/jpeg"
* @return this
*/
public SMTPMessage addImage(final String cid, final InputStream imageStream, final String contentType) {
final ByteArrayDataSource imgSource;
try {
imgSource = new ByteArrayDataSource(imageStream, ObjUtil.defaultIfNull(contentType, "image/jpeg"));
} catch (final IOException e) {
throw new IORuntimeException(e);
}
imgSource.setName(cid);
return addAttachments(imgSource);
}
/**
* 设置文件类型附件，文件可以是图片文件，此时自动设置cid（正文中引用图片），默认cid为文件名
*
* @param files 附件文件列表
* @return this
*/
public SMTPMessage addFiles(final File... files) {
if (ArrayUtil.isEmpty(files)) {
return this;
}
final DataSource[] attachments = new DataSource[files.length];
for (int i = 0; i < files.length; i++) {
attachments[i] = new FileDataSource(files[i]);
}
return addAttachments(attachments);
}
/**
* 增加附件或图片，附件使用{@link DataSource} 形式表示，可以使用{@link FileDataSource}包装文件表示文件附件
*
* @param attachments 附件列表
* @return this
* @since 4.0.9
*/
public SMTPMessage addAttachments(final DataSource... attachments) {
if (ArrayUtil.isNotEmpty(attachments)) {
final Charset charset = this.mailAccount.getCharset();
for (final DataSource attachment : attachments) {
addBodyPart(buildBodyPart(attachment, charset));
}
}
return this;
}
// endregion
/**
* 添加邮件信息主体
*
* @param bodyPart 邮件信息主体
* @return this
*/
public SMTPMessage addBodyPart(final BodyPart bodyPart) {
try {
this.multipart.addBodyPart(bodyPart);
} catch (final MessagingException e) {
throw new MailException(e);
}
return this;
}
/**
* 添加邮件信息主体
*
* @param bodyPart 邮件信息主体
* @param index 插入位置，0表示插入到开头
* @return this
*/
public SMTPMessage addBodyPart(final BodyPart bodyPart, final int index) {
try {
this.multipart.addBodyPart(bodyPart, index);
} catch (final MessagingException e) {
throw new MailException(e);
}
return this;
}
/**
* 发送
*
* @return message-id
* @throws MailException 邮件发送异常
*/
public String send() throws MailException {
try {
return doSend();
} catch (final MessagingException e) {
if (e instanceof SendFailedException) {
// 当地址无效时，显示更加详细的无效地址信息
final Address[] invalidAddresses = ((SendFailedException) e).getInvalidAddresses();
final String msg = StrUtil.format("Invalid Addresses: {}", ArrayUtil.toString(invalidAddresses));
throw new MailException(msg, e);
}
throw new MailException(e);
}
}
/**
* 构建邮件信息主体
*
* @param charset 编码，{@code null}则使用{@link MimeUtility#getDefaultJavaCharset()}
* @param isHtml 是否为HTML
* @return 邮件信息主体
* @throws MessagingException 消息异常
*/
private Multipart buildContent(final Charset charset, final boolean isHtml) throws MessagingException {
final String charsetStr = null != charset ? charset.name() : MimeUtility.getDefaultJavaCharset();
// 正文
final MimeBodyPart body = new MimeBodyPart();
body.setContent(content, StrUtil.format("text/{}; charset={}", isHtml ? "html" : "plain", charsetStr));
addBodyPart( body, 0);
return this.multipart;
}
/**
* 执行发送
*
* @return message-id
* @throws MessagingException 发送异常
*/
private String doSend() throws MessagingException {
Transport.send(this);
return getMessageID();
}
/**
* 构建邮件信息主体
*
* @param attachment 附件
* @param charset 编码
* @return 邮件信息主体
*/
private MimeBodyPart buildBodyPart(final DataSource attachment, final Charset charset) {
final MimeBodyPart bodyPart = new MimeBodyPart();
try {
bodyPart.setDataHandler(new DataHandler(attachment));
String nameEncoded = attachment.getName();
if (this.mailAccount.isEncodefilename()) {
nameEncoded = InternalMailUtil.encodeText(nameEncoded, charset);
}
// 普通附件文件名
bodyPart.setFileName(nameEncoded);
if (StrUtil.startWith(attachment.getContentType(), "image/")) {
// 图片附件，用于正文中引用图片
bodyPart.setContentID(nameEncoded);
bodyPart.setDisposition(MimeBodyPart.INLINE);
}
} catch (final MessagingException e) {
throw new MailException(e);
}
return bodyPart;
}
}

62
hutool-extra/src/main/java/cn/hutool/v7/extra/mail/UserPassMailAuthenticator.java Normal file
View File

@@ -0,0 +1,62 @@
/*
* Copyright (c) 2025 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 cn.hutool.v7.extra.mail;
import jakarta.mail.Authenticator;
import jakarta.mail.PasswordAuthentication;
/**
* 用户名密码授权
*
* @author looly
*/
public class UserPassMailAuthenticator extends Authenticator {
private final PasswordAuthentication auth;
/**
* 构造
*
* @param mailAccount 邮箱账号信息
*/
public UserPassMailAuthenticator(final MailAccount mailAccount) {
this.auth = new PasswordAuthentication(mailAccount.getUser(), String.valueOf(mailAccount.getPass()));
}
/**
* 构造
*
* @param userName 用户名
* @param password 密码
*/
public UserPassMailAuthenticator(final String userName, final String password) {
this.auth = new PasswordAuthentication(userName, password);
}
/**
* 构造
*
* @param auth 密码授权信息
*/
public UserPassMailAuthenticator(final PasswordAuthentication auth) {
this.auth = auth;
}
@Override
protected PasswordAuthentication getPasswordAuthentication() {
return this.auth;
}
}