程序包 cn.starrys.mail

类 MailTools

java.lang.Object
cn.starrys.mail.MailTools
public class MailTools extends Object
邮件工具。

creationTime: 2023/1/12 13:31 .

  • 构造器详细资料

    • MailTools

      public MailTools(@NotNull @NotNull String host, @NotNull @NotNull Integer port, @NotNull @NotNull String from, @NotNull @NotNull String password)
      最简构造。
      参数:
      host - 主机。
      port - 主机端口。
      from - 发件邮箱。
      password - 发件邮箱授权码。

    • MailTools

      public MailTools(@NotNull @NotNull String host, @NotNull @NotNull Integer port, @NotNull @NotNull String from, @NotNull @NotNull String password, String nickname)
      重载构造。
      参数:
      host - 主机。
      port - 主机端口。
      from - 发件邮箱。
      password - 发件邮箱授权码。
      nickname - 昵称。

    • MailTools

      public MailTools(@NotNull @NotNull String host, @NotNull @NotNull Integer port, @NotNull @NotNull String from, @NotNull @NotNull String password, String nickname, boolean ssl)
      重载构造。
      参数:
      host - 主机。
      port - 主机端口。
      from - 发件邮箱。
      password - 发件邮箱授权码。
      nickname - 昵称。
      ssl - 启用 ssl。

    • MailTools

      public MailTools(@NotNull @NotNull String host, @NotNull @NotNull Integer port, @NotNull @NotNull String from, @NotNull @NotNull String password, String nickname, boolean ssl, boolean debug, Charset charset)
      重载构造。
      参数:
      host - 主机。
      port - 主机端口。
      from - 发件邮箱。
      password - 发件邮箱授权码。
      nickname - 昵称。
      ssl - 启用 ssl。
      debug - 开启debug模式。
      charset - 邮件编码。

    • MailTools

      public MailTools(@NotNull @NotNull String host, @NotNull @NotNull Integer port, @NotNull @NotNull String from, @NotNull @NotNull String password, String nickname, boolean ssl, boolean debug, 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 jakarta.mail.Session getSession(@NotNull @NotNull MailProtocol protocol)
      获取 Session 对象.
      参数:
      protocol - 指定协议
      返回:
      Session 对象。

    • createMimeMessage

      public jakarta.mail.internet.MimeMessage createMimeMessage(jakarta.mail.Session session, @NotNull @NotNull Mail mail)
      创建邮件。
      参数:
      session - Session对象。
      mail - Mail 邮件内容。
      返回:
      一封邮件。

    • send

      public boolean send(String addressee, String subject, String body)
      发送邮件。
      参数:
      addressee - 收件人。
      subject - 邮件主题（标题）。
      body - 邮件内容（主体）。
      返回:
      发送结果。

    • send

      public boolean send(String addressee, String nickname, String subject, String body)
      发送邮件。
      参数:
      addressee - 收件人。
      nickname - 收件者昵称。
      subject - 邮件主题（标题）。
      body - 邮件内容（主体）。
      返回:
      发送结果。

    • send

      public boolean send(String addressee, String nickname, String subject, String body, List<File> attachments)
      发送邮件。
      参数:
      addressee - 收件人。
      nickname - 收件者昵称。
      subject - 邮件主题（标题）。
      body - 邮件内容（主体）。
      attachments - 附件。
      返回:
      发送结果。

    • send

      public boolean send(List<MailAddressee> to, String subject, String body, List<File> attachments)
      发送邮件。
      参数:
      to - 收件人(主要收件人)。
      subject - 邮件主题（标题）。
      body - 邮件内容（主体）。
      attachments - 附件。
      返回:
      发送结果。

    • send

      public boolean send(List<MailAddressee> to, String subject, String body, List<File> attachments, MailType mailType)
      发送邮件。
      参数:
      to - 收件人(主要收件人)。
      subject - 邮件主题（标题）。
      body - 邮件内容（主体）。
      attachments - 附件。
      mailType - 邮件类型（HTML,TEXT）
      返回:
      发送结果。

    • send

      public boolean send(List<MailAddressee> to, String subject, String body, List<File> attachments, MailType mailType, List<MailAddressee> cc, 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(jakarta.mail.internet.MimeMessage msg)
      最终执行发送方法。
      参数:
      msg - 一封邮件。
      返回:
      发送结果。