org.dromara.hutool.extra.mail

Class MailUtil

java.lang.Object

org.dromara.hutool.extra.mail.MailUtil

public class MailUtil
extends Object

邮件工具类，基于jakarta.mail封装

Since:

6.0.0

Author:

looly

Constructor Summary

Constructors

Constructor and Description
MailUtil()

Method Summary

Modifier and Type	Method and Description
static jakarta.mail.Session	getSession(MailAccount mailAccount, boolean isSingleton) 根据配置文件，获取邮件客户端会话
static String	send(Collection<String> tos, Collection<String> ccs, Collection<String> bccs, String subject, String content, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送给多人
static String	send(Collection<String> tos, Collection<String> ccs, Collection<String> bccs, String subject, String content, Map<String,InputStream> imageMap, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送给多人
static String	send(Collection<String> tos, String subject, String content, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送给多人
static String	send(Collection<String> tos, String subject, String content, Map<String,InputStream> imageMap, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送给多人
static String	send(MailAccount mailAccount, Collection<String> tos, Collection<String> ccs, Collection<String> bccs, String subject, String content, boolean isHtml, File... files) 发送邮件给多人
static String	send(MailAccount mailAccount, Collection<String> tos, Collection<String> ccs, Collection<String> bccs, String subject, String content, Map<String,InputStream> imageMap, boolean isHtml, File... files) 发送邮件给多人
static String	send(MailAccount mailAccount, Collection<String> tos, String subject, String content, boolean isHtml, File... files) 发送邮件给多人
static String	send(MailAccount mailAccount, Collection<String> tos, String subject, String content, Map<String,InputStream> imageMap, boolean isHtml, File... files) 发送邮件给多人
static String	send(MailAccount mailAccount, String to, String subject, String content, boolean isHtml, File... files) 发送邮件给多人
static String	send(MailAccount mailAccount, String to, String subject, String content, Map<String,InputStream> imageMap, boolean isHtml, File... files) 发送邮件给多人
static String	send(String to, String subject, String content, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送单个或多个收件人 多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔
static String	send(String to, String subject, String content, Map<String,InputStream> imageMap, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送单个或多个收件人 多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔
static String	send(String to, String cc, String bcc, String subject, String content, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送单个或多个收件人 多个收件人、抄送人、密送人可以使用逗号“,”分隔，也可以通过分号“;”分隔
static String	send(String to, String cc, String bcc, String subject, String content, Map<String,InputStream> imageMap, boolean isHtml, File... files) 使用配置文件中设置的账户发送邮件，发送单个或多个收件人 多个收件人、抄送人、密送人可以使用逗号“,”分隔，也可以通过分号“;”分隔
static String	sendHtml(Collection<String> tos, String subject, String content, File... files) 使用配置文件中设置的账户发送HTML邮件，发送给多人
static String	sendHtml(Collection<String> tos, String subject, String content, Map<String,InputStream> imageMap, File... files) 使用配置文件中设置的账户发送HTML邮件，发送给多人
static String	sendHtml(String to, String subject, String content, File... files) 使用配置文件中设置的账户发送HTML邮件，发送给单个或多个收件人 多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔
static String	sendHtml(String to, String subject, String content, Map<String,InputStream> imageMap, File... files) 使用配置文件中设置的账户发送HTML邮件，发送给单个或多个收件人 多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔
static String	sendText(Collection<String> tos, String subject, String content, File... files) 使用配置文件中设置的账户发送文本邮件，发送给多人
static String	sendText(String to, String subject, String content, File... files) 使用配置文件中设置的账户发送文本邮件，发送给单个或多个收件人 多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailUtil

public MailUtil()

Method Detail

sendText

public static String sendText(String to,
                              String subject,
                              String content,
                              File... files)

使用配置文件中设置的账户发送文本邮件，发送给单个或多个收件人
多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Parameters:

to - 收件人

subject - 标题

content - 正文

files - 附件列表

Returns:

message-id

Since:

3.2.0

sendHtml

public static String sendHtml(String to,
                              String subject,
                              String content,
                              File... files)

使用配置文件中设置的账户发送HTML邮件，发送给单个或多个收件人
多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Parameters:

to - 收件人

subject - 标题

content - 正文

files - 附件列表

Returns:

message-id

Since:

3.2.0

send

public static String send(String to,
                          String subject,
                          String content,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送单个或多个收件人
多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Parameters:

to - 收件人

subject - 标题

content - 正文

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

send

public static String send(String to,
                          String cc,
                          String bcc,
                          String subject,
                          String content,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送单个或多个收件人
多个收件人、抄送人、密送人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Parameters:

to - 收件人，可以使用逗号“,”分隔，也可以通过分号“;”分隔

cc - 抄送人，可以使用逗号“,”分隔，也可以通过分号“;”分隔

bcc - 密送人，可以使用逗号“,”分隔，也可以通过分号“;”分隔

subject - 标题

content - 正文

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

Since:

4.0.3

sendText

public static String sendText(Collection<String> tos,
                              String subject,
                              String content,
                              File... files)

使用配置文件中设置的账户发送文本邮件，发送给多人

Parameters:

tos - 收件人列表

subject - 标题

content - 正文

files - 附件列表

Returns:

message-id

sendHtml

public static String sendHtml(Collection<String> tos,
                              String subject,
                              String content,
                              File... files)

使用配置文件中设置的账户发送HTML邮件，发送给多人

Parameters:

tos - 收件人列表

subject - 标题

content - 正文

files - 附件列表

Returns:

message-id

Since:

3.2.0

send

public static String send(Collection<String> tos,
                          String subject,
                          String content,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送给多人

Parameters:

tos - 收件人列表

subject - 标题

content - 正文

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

send

public static String send(Collection<String> tos,
                          Collection<String> ccs,
                          Collection<String> bccs,
                          String subject,
                          String content,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送给多人

Parameters:

tos - 收件人列表

ccs - 抄送人列表，可以为null或空

bccs - 密送人列表，可以为null或空

subject - 标题

content - 正文

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

Since:

4.0.3

send

public static String send(MailAccount mailAccount,
                          String to,
                          String subject,
                          String content,
                          boolean isHtml,
                          File... files)

发送邮件给多人

Parameters:

mailAccount - 邮件认证对象

to - 收件人，多个收件人逗号或者分号隔开

subject - 标题

content - 正文

isHtml - 是否为HTML格式

files - 附件列表

Returns:

message-id

Since:

3.2.0

send

public static String send(MailAccount mailAccount,
                          Collection<String> tos,
                          String subject,
                          String content,
                          boolean isHtml,
                          File... files)

发送邮件给多人

Parameters:

mailAccount - 邮件帐户信息

tos - 收件人列表

subject - 标题

content - 正文

isHtml - 是否为HTML格式

files - 附件列表

Returns:

message-id

send

public static String send(MailAccount mailAccount,
                          Collection<String> tos,
                          Collection<String> ccs,
                          Collection<String> bccs,
                          String subject,
                          String content,
                          boolean isHtml,
                          File... files)

发送邮件给多人

Parameters:

mailAccount - 邮件帐户信息

tos - 收件人列表

ccs - 抄送人列表，可以为null或空

bccs - 密送人列表，可以为null或空

subject - 标题

content - 正文

isHtml - 是否为HTML格式

files - 附件列表

Returns:

message-id

Since:

4.0.3

sendHtml

public static String sendHtml(String to,
                              String subject,
                              String content,
                              Map<String,InputStream> imageMap,
                              File... files)

使用配置文件中设置的账户发送HTML邮件，发送给单个或多个收件人
多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Parameters:

to - 收件人

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

files - 附件列表

Returns:

message-id

Since:

3.2.0

send

public static String send(String to,
                          String subject,
                          String content,
                          Map<String,InputStream> imageMap,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送单个或多个收件人
多个收件人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Parameters:

to - 收件人

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

send

public static String send(String to,
                          String cc,
                          String bcc,
                          String subject,
                          String content,
                          Map<String,InputStream> imageMap,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送单个或多个收件人
多个收件人、抄送人、密送人可以使用逗号“,”分隔，也可以通过分号“;”分隔

Parameters:

to - 收件人，可以使用逗号“,”分隔，也可以通过分号“;”分隔

cc - 抄送人，可以使用逗号“,”分隔，也可以通过分号“;”分隔

bcc - 密送人，可以使用逗号“,”分隔，也可以通过分号“;”分隔

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

Since:

4.0.3

sendHtml

public static String sendHtml(Collection<String> tos,
                              String subject,
                              String content,
                              Map<String,InputStream> imageMap,
                              File... files)

使用配置文件中设置的账户发送HTML邮件，发送给多人

Parameters:

tos - 收件人列表

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

files - 附件列表

Returns:

message-id

Since:

3.2.0

send

public static String send(Collection<String> tos,
                          String subject,
                          String content,
                          Map<String,InputStream> imageMap,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送给多人

Parameters:

tos - 收件人列表

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

send

public static String send(Collection<String> tos,
                          Collection<String> ccs,
                          Collection<String> bccs,
                          String subject,
                          String content,
                          Map<String,InputStream> imageMap,
                          boolean isHtml,
                          File... files)

使用配置文件中设置的账户发送邮件，发送给多人

Parameters:

tos - 收件人列表

ccs - 抄送人列表，可以为null或空

bccs - 密送人列表，可以为null或空

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

isHtml - 是否为HTML

files - 附件列表

Returns:

message-id

Since:

4.0.3

send

public static String send(MailAccount mailAccount,
                          String to,
                          String subject,
                          String content,
                          Map<String,InputStream> imageMap,
                          boolean isHtml,
                          File... files)

发送邮件给多人

Parameters:

mailAccount - 邮件认证对象

to - 收件人，多个收件人逗号或者分号隔开

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

isHtml - 是否为HTML格式

files - 附件列表

Returns:

message-id

Since:

3.2.0

send

public static String send(MailAccount mailAccount,
                          Collection<String> tos,
                          String subject,
                          String content,
                          Map<String,InputStream> imageMap,
                          boolean isHtml,
                          File... files)

发送邮件给多人

Parameters:

mailAccount - 邮件帐户信息

tos - 收件人列表

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

isHtml - 是否为HTML格式

files - 附件列表

Returns:

message-id

Since:

4.6.3

send

public static String send(MailAccount mailAccount,
                          Collection<String> tos,
                          Collection<String> ccs,
                          Collection<String> bccs,
                          String subject,
                          String content,
                          Map<String,InputStream> imageMap,
                          boolean isHtml,
                          File... files)

发送邮件给多人

Parameters:

mailAccount - 邮件帐户信息

tos - 收件人列表

ccs - 抄送人列表，可以为null或空

bccs - 密送人列表，可以为null或空

subject - 标题

content - 正文

imageMap - 图片与占位符，占位符格式为cid:$IMAGE_PLACEHOLDER

isHtml - 是否为HTML格式

files - 附件列表

Returns:

message-id

Since:

4.6.3

getSession

public static jakarta.mail.Session getSession(MailAccount mailAccount,
                                              boolean isSingleton)

根据配置文件，获取邮件客户端会话

Parameters:

mailAccount - 邮件账户配置

isSingleton - 是否单例（全局共享会话）

Returns:

Session

Since:

5.5.7