java邮件发送工具类（MailUtils）

Java 邮件发送工具类（MailUtils）

在 Java 开发中，邮件发送是一个常见的功能需求，例如发送注册确认邮件、通知邮件或报表等。JavaMail API 是 Java 提供的一个用于发送和接收电子邮件的标准库，具有强大的邮件处理功能。为了简化邮件发送的过程，可以封装一个邮件发送工具类 MailUtils，提供简单易用的方法来发送文本邮件、HTML 邮件、带附件的邮件等。本文将介绍如何设计和实现一个基于 JavaMail API 的 MailUtils 工具类，并包含常见的邮件发送场景。

一、JavaMail API 简介

JavaMail API 是 Java 标准库的一部分，它支持发送和接收基于 SMTP、IMAP、POP3 等协议的电子邮件。JavaMail API 提供的核心类包括：

• Session：表示与邮件服务器的会话，通过该对象可以配置邮件服务器信息。
• Message：代表一封邮件，通过设置收件人、主题、内容等属性构建邮件。
• Transport：负责邮件的传输，通过该类将邮件发送到服务器。

二、MailUtils 工具类设计

MailUtils 工具类旨在简化邮件发送的操作，支持发送文本邮件、HTML 邮件、带附件的邮件等。以下是工具类的基本结构和实现。

1. 工具类的基本结构

工具类通常由静态方法组成，且构造函数设为私有以防止实例化：

import javax.mail.*;
import javax.mail.internet.*;
import java.util.Properties;

public class MailUtils {

    // 私有构造函数，防止实例化
    private MailUtils() {
        throw new UnsupportedOperationException("Utility class");
    }

    // 其他实用方法将在下文详述
}

2. 配置邮件会话

邮件发送需要与邮件服务器建立会话，这里定义一个方法来配置邮件会话：

// 获取邮件会话
private static Session getSession(String host, String port, final String username, final String password) {
    Properties props = new Properties();
    props.put("mail.smtp.auth", "true");
    props.put("mail.smtp.starttls.enable", "true");
    props.put("mail.smtp.host", host);
    props.put("mail.smtp.port", port);

    return Session.getInstance(props, new Authenticator() {
        protected PasswordAuthentication getPasswordAuthentication() {
            return new PasswordAuthentication(username, password);
        }
    });
}

3. 发送文本邮件

发送简单的文本邮件：

// 发送文本邮件
public static void sendTextEmail(String host, String port, String username, String password,
                                 String toAddress, String subject, String message) throws MessagingException {
    Session session = getSession(host, port, username, password);
    Message msg = new MimeMessage(session);

    msg.setFrom(new InternetAddress(username));
    msg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(toAddress));
    msg.setSubject(subject);
    msg.setText(message);

    Transport.send(msg);
}

4. 发送 HTML 邮件

发送支持 HTML 格式的邮件：

// 发送 HTML 邮件
public static void sendHtmlEmail(String host, String port, String username, String password,
                                 String toAddress, String subject, String htmlContent) throws MessagingException {
    Session session = getSession(host, port, username, password);
    Message msg = new MimeMessage(session);

    msg.setFrom(new InternetAddress(username));
    msg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(toAddress));
    msg.setSubject(subject);

    // 设置 HTML 内容
    msg.setContent(htmlContent, "text/html; charset=utf-8");

    Transport.send(msg);
}

5. 发送带附件的邮件

发送带附件的邮件：

import java.io.File;
import javax.activation.DataHandler;
import javax.activation.DataSource;
import javax.activation.FileDataSource;

// 发送带附件的邮件
public static void sendEmailWithAttachment(String host, String port, String username, String password,
                                           String toAddress, String subject, String message, File attachment) throws MessagingException {
    Session session = getSession(host, port, username, password);
    Message msg = new MimeMessage(session);

    msg.setFrom(new InternetAddress(username));
    msg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(toAddress));
    msg.setSubject(subject);

    // 创建消息部分
    MimeBodyPart messageBodyPart = new MimeBodyPart();
    messageBodyPart.setText(message);

    // 创建附件部分
    MimeBodyPart attachPart = new MimeBodyPart();
    DataSource source = new FileDataSource(attachment);
    attachPart.setDataHandler(new DataHandler(source));
    attachPart.setFileName(attachment.getName());

    // 创建多部分内容
    Multipart multipart = new MimeMultipart();
    multipart.addBodyPart(messageBodyPart);
    multipart.addBodyPart(attachPart);

    // 设置邮件内容
    msg.setContent(multipart);

    Transport.send(msg);
}

三、MailUtils 工具类完整示例

以下是完整的 MailUtils 工具类代码示例：

import javax.mail.*;
import javax.mail.internet.*;
import javax.activation.*;
import java.io.File;
import java.util.Properties;

public class MailUtils {

    private MailUtils() {
        throw new UnsupportedOperationException("Utility class");
    }

    private static Session getSession(String host, String port, final String username, final String password) {
        Properties props = new Properties();
        props.put("mail.smtp.auth", "true");
        props.put("mail.smtp.starttls.enable", "true");
        props.put("mail.smtp.host", host);
        props.put("mail.smtp.port", port);

        return Session.getInstance(props, new Authenticator() {
            protected PasswordAuthentication getPasswordAuthentication() {
                return new PasswordAuthentication(username, password);
            }
        });
    }

    public static void sendTextEmail(String host, String port, String username, String password,
                                     String toAddress, String subject, String message) throws MessagingException {
        Session session = getSession(host, port, username, password);
        Message msg = new MimeMessage(session);

        msg.setFrom(new InternetAddress(username));
        msg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(toAddress));
        msg.setSubject(subject);
        msg.setText(message);

        Transport.send(msg);
    }

    public static void sendHtmlEmail(String host, String port, String username, String password,
                                     String toAddress, String subject, String htmlContent) throws MessagingException {
        Session session = getSession(host, port, username, password);
        Message msg = new MimeMessage(session);

        msg.setFrom(new InternetAddress(username));
        msg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(toAddress));
        msg.setSubject(subject);
        msg.setContent(htmlContent, "text/html; charset=utf-8");

        Transport.send(msg);
    }

    public static void sendEmailWithAttachment(String host, String port, String username, String password,
                                               String toAddress, String subject, String message, File attachment) throws MessagingException {
        Session session = getSession(host, port, username, password);
        Message msg = new MimeMessage(session);

        msg.setFrom(new InternetAddress(username));
        msg.setRecipients(Message.RecipientType.TO, InternetAddress.parse(toAddress));
        msg.setSubject(subject);

        MimeBodyPart messageBodyPart = new MimeBodyPart();
        messageBodyPart.setText(message);

        MimeBodyPart attachPart = new MimeBodyPart();
        DataSource source = new FileDataSource(attachment);
        attachPart.setDataHandler(new DataHandler(source));
        attachPart.setFileName(attachment.getName());

        Multipart multipart = new MimeMultipart();
        multipart.addBodyPart(messageBodyPart);
        multipart.addBodyPart(attachPart);

        msg.setContent(multipart);

        Transport.send(msg);
    }
}

四、使用示例

以下是 MailUtils 工具类的使用示例：

import javax.mail.MessagingException;
import java.io.File;

public class TestMailUtils {

    public static void main(String[] args) {
        String host = "smtp.example.com";
        String port = "587";
        String username = "your-email@example.com";
        String password = "your-email-password";
        String toAddress = "recipient@example.com";

        try {
            // 发送文本邮件
            MailUtils.sendTextEmail(host, port, username, password, toAddress,
                    "Test Subject", "Hello, this is a test email.");

            // 发送 HTML 邮件
            MailUtils.sendHtmlEmail(host, port, username, password, toAddress,
                    "HTML Email Subject", "<h1>Hello!</h1><p>This is a test HTML email.</p>");

            // 发送带附件的邮件
            File attachment = new File("path/to/attachment.txt");
            MailUtils.sendEmailWithAttachment(host, port, username, password, toAddress,
                    "Email with Attachment", "Please see the attached file.", attachment);

            System.out.println("Emails sent successfully!");
        } catch (MessagingException e) {
            e.printStackTrace();
        }
    }
}

结论

MailUtils 工具类为 Java 中的邮件发送提供了一个简单而强大的接口，支持发送文本邮件、HTML 邮件和带附件的邮件。通过封装 JavaMail API 的功能，MailUtils 工具类使邮件发送变得更加简单和易于维护。在实际项目

中，开发者可以根据需要扩展工具类的功能，例如添加 CC/BCC 支持、自定义邮件头等，以满足更复杂的邮件发送需求。

总结

 Java邮件发送工具类（MailUtils）是一个封装了发送邮件功能的工具类。它提供了简单使用的方法，可以方便地发送邮件。

该工具类使用JavaMail API来发送邮件，需要提供邮件服务器的信息（如SMTP地址、端口号、用户名、密码等），以及邮件的基本信息（如发件人、收件人、主题、内容等）。

使用该工具类发送邮件的步骤如下：

1. 创建一个MailUtils对象，并初始化邮件服务器的信息。
2. 创建一个MimeMessage对象作为邮件的实例。
3. 设置邮件的发件人、收件人、主题等基本信息。
4. 创建一个MimeMultipart对象，并将内容部分添加到其中。
5. 将MimeMultipart对象设置为邮件的内容。
6. 调用Transport类的send方法发送邮件。

该工具类还提供了一些辅助方法，可以方便地添加附件、设置邮件的优先级等。

使用MailUtils发送邮件可以方便地集成进Java应用程序中，实现自动化发送邮件的功能。它适用于各种场景，例如系统监控报警、日志通知、定时任务结果通知等。