MailTools (starry-mail 2.7.7 API)

java.lang.Object
- cn.starrys.mail.MailTools

public class MailTools
extends java.lang.Object

邮件工具。

creationTime: 2023/1/12 13:31 .

构造器概要

构造器
构造器和说明
`MailTools(@NotNull MailProps props)` 最终构造方法
`MailTools(@NotNull java.lang.String host, @NotNull java.lang.Integer port, @NotNull java.lang.String from, @NotNull java.lang.String password)` 最简构造。
`MailTools(@NotNull java.lang.String host, @NotNull java.lang.Integer port, @NotNull java.lang.String from, @NotNull java.lang.String password, java.lang.String nickname)` 重载构造。
`MailTools(@NotNull java.lang.String host, @NotNull java.lang.Integer port, @NotNull java.lang.String from, @NotNull java.lang.String password, java.lang.String nickname, boolean ssl)` 重载构造。
`MailTools(@NotNull java.lang.String host, @NotNull java.lang.Integer port, @NotNull java.lang.String from, @NotNull java.lang.String password, java.lang.String nickname, boolean ssl, boolean debug, java.nio.charset.Charset charset)` 重载构造。
`MailTools(@NotNull java.lang.String host, @NotNull java.lang.Integer port, @NotNull java.lang.String from, @NotNull java.lang.String password, java.lang.String nickname, boolean ssl, boolean debug, java.nio.charset.Charset charset, boolean auth)` 全参构造。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`javax.mail.internet.MimeMessage`	`createMimeMessage(javax.mail.Session session, @NotNull Mail mail)` 创建邮件。
`javax.mail.Session`	`getSession(@NotNull MailProtocol protocol)` 获取 `Session` 对象.
`boolean`	`send(java.util.List<MailAddressee> to, java.lang.String subject, java.lang.String body, java.util.List<java.io.File> attachments)` 发送邮件。
`boolean`	`send(java.util.List<MailAddressee> to, java.lang.String subject, java.lang.String body, java.util.List<java.io.File> attachments, MailType mailType)` 发送邮件。
`boolean`	`send(java.util.List<MailAddressee> to, java.lang.String subject, java.lang.String body, java.util.List<java.io.File> attachments, MailType mailType, java.util.List<MailAddressee> cc, java.util.List<MailAddressee> bcc)` 发送邮件。
`boolean`	`send(Mail mail)` 发送邮件。
`boolean`	`send(javax.mail.internet.MimeMessage msg)` 最终执行发送方法。
`boolean`	`send(java.lang.String addressee, java.lang.String subject, java.lang.String body)` 发送邮件。
`boolean`	`send(java.lang.String addressee, java.lang.String nickname, java.lang.String subject, java.lang.String body)` 发送邮件。
`boolean`	`send(java.lang.String addressee, java.lang.String nickname, java.lang.String subject, java.lang.String body, java.util.List<java.io.File> attachments)` 发送邮件。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

MailTools

public MailTools(@NotNull
                 @NotNull java.lang.String host,
                 @NotNull
                 @NotNull java.lang.Integer port,
                 @NotNull
                 @NotNull java.lang.String from,
                 @NotNull
                 @NotNull java.lang.String password)

最简构造。

参数:: host - 主机。; port - 主机端口。; from - 发件邮箱。; password - 发件邮箱授权码。

MailTools

public MailTools(@NotNull
                 @NotNull java.lang.String host,
                 @NotNull
                 @NotNull java.lang.Integer port,
                 @NotNull
                 @NotNull java.lang.String from,
                 @NotNull
                 @NotNull java.lang.String password,
                 java.lang.String nickname)

重载构造。

参数:: host - 主机。; port - 主机端口。; from - 发件邮箱。; password - 发件邮箱授权码。; nickname - 昵称。

MailTools

public MailTools(@NotNull
                 @NotNull java.lang.String host,
                 @NotNull
                 @NotNull java.lang.Integer port,
                 @NotNull
                 @NotNull java.lang.String from,
                 @NotNull
                 @NotNull java.lang.String password,
                 java.lang.String nickname,
                 boolean ssl)

重载构造。

参数:: host - 主机。; port - 主机端口。; from - 发件邮箱。; password - 发件邮箱授权码。; nickname - 昵称。; ssl - 启用 ssl。

MailTools

public MailTools(@NotNull
                 @NotNull java.lang.String host,
                 @NotNull
                 @NotNull java.lang.Integer port,
                 @NotNull
                 @NotNull java.lang.String from,
                 @NotNull
                 @NotNull java.lang.String password,
                 java.lang.String nickname,
                 boolean ssl,
                 boolean debug,
                 java.nio.charset.Charset charset)

重载构造。

参数:: host - 主机。; port - 主机端口。; from - 发件邮箱。; password - 发件邮箱授权码。; nickname - 昵称。; ssl - 启用 ssl。; debug - 开启debug模式。; charset - 邮件编码。

MailTools

public MailTools(@NotNull
                 @NotNull java.lang.String host,
                 @NotNull
                 @NotNull java.lang.Integer port,
                 @NotNull
                 @NotNull java.lang.String from,
                 @NotNull
                 @NotNull java.lang.String password,
                 java.lang.String nickname,
                 boolean ssl,
                 boolean debug,
                 java.nio.charset.Charset charset,
                 boolean auth)

全参构造。

参数:: host - 主机。; port - 主机端口。; from - 发件邮箱。; password - 发件邮箱授权码。; nickname - 昵称。; ssl - 启用 ssl。; debug - 开启debug模式。; charset - 邮件编码。; auth - 开启鉴权。

MailTools

public MailTools(@NotNull
                 @NotNull MailProps props)

最终构造方法

参数:: props - MailProps 邮件配置。

方法详细资料

getSession

public javax.mail.Session getSession(@NotNull
                                     @NotNull MailProtocol protocol)

获取 Session 对象.

参数:: protocol - 指定协议
返回:: Session 对象。

createMimeMessage

public javax.mail.internet.MimeMessage createMimeMessage(javax.mail.Session session,
                                                         @NotNull
                                                         @NotNull Mail mail)

创建邮件。

参数:: session - Session对象。; mail - Mail 邮件内容。
返回:: 一封邮件。

send

public boolean send(java.lang.String addressee,
                    java.lang.String subject,
                    java.lang.String body)

发送邮件。

参数:: addressee - 收件人。; subject - 邮件主题（标题）。; body - 邮件内容（主体）。
返回:: 发送结果。

send

public boolean send(java.lang.String addressee,
                    java.lang.String nickname,
                    java.lang.String subject,
                    java.lang.String body)

发送邮件。

参数:: addressee - 收件人。; nickname - 收件者昵称。; subject - 邮件主题（标题）。; body - 邮件内容（主体）。
返回:: 发送结果。

send

public boolean send(java.lang.String addressee,
                    java.lang.String nickname,
                    java.lang.String subject,
                    java.lang.String body,
                    java.util.List<java.io.File> attachments)

发送邮件。

参数:: addressee - 收件人。; nickname - 收件者昵称。; subject - 邮件主题（标题）。; body - 邮件内容（主体）。; attachments - 附件。
返回:: 发送结果。

send

public boolean send(java.util.List<MailAddressee> to,
                    java.lang.String subject,
                    java.lang.String body,
                    java.util.List<java.io.File> attachments)

发送邮件。

参数:: to - 收件人(主要收件人)。; subject - 邮件主题（标题）。; body - 邮件内容（主体）。; attachments - 附件。
返回:: 发送结果。

send

public boolean send(java.util.List<MailAddressee> to,
                    java.lang.String subject,
                    java.lang.String body,
                    java.util.List<java.io.File> attachments,
                    MailType mailType)

发送邮件。

参数:: to - 收件人(主要收件人)。; subject - 邮件主题（标题）。; body - 邮件内容（主体）。; attachments - 附件。; mailType - 邮件类型（HTML,TEXT）
返回:: 发送结果。

send

public boolean send(java.util.List<MailAddressee> to,
                    java.lang.String subject,
                    java.lang.String body,
                    java.util.List<java.io.File> attachments,
                    MailType mailType,
                    java.util.List<MailAddressee> cc,
                    java.util.List<MailAddressee> bcc)

发送邮件。

参数:: to - 收件人(主要收件人)。; subject - 邮件主题（标题）。; body - 邮件内容（主体）。; attachments - 附件。; mailType - 邮件类型（HTML,TEXT）; cc - 抄送(carbon copy)收件人。; bcc - 密送(blind carbon copy)收件人。
返回:: 发送结果。

send
```
public boolean send(Mail mail)
```
发送邮件。

参数:

mail - Mail 邮件内容。

返回:

发送结果。

send
```
public boolean send(javax.mail.internet.MimeMessage msg)
```
最终执行发送方法。

参数:

msg - 一封邮件。

返回:

发送结果。

类 MailTools

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

MailTools

MailTools

MailTools

MailTools

MailTools

MailTools

方法详细资料

getSession

createMimeMessage

send

send

send

send

send

send

send

send