Java中使用Java Mail实现邮件服务功能示例

2025-01-30 04:50

本文主要是介绍Java中使用Java Mail实现邮件服务功能示例,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《Java中使用JavaMail实现邮件服务功能示例》:本文主要介绍Java中使用JavaMail实现邮件服务功能的相关资料,文章还提供了一个发送邮件的示例代码,包括创建参数类、邮件类和执行结...

前言

Java Mail是一个处理邮件服务的编程接口,提供给开发者处理电子邮件相关的编程接口。它是Sun发布的用来处理email的API,支持多种协议,如 SMTP、POP3 和 IMAP。它可以方便地执行一些常用的邮件传输。最近项目中刚好有邮件服务的需求,之前有用过但是一直没有总结,借此机会正好总结一下邮件服务的实现,如果大家项目中有邮件需求可以直接看本篇文章,后面有例子可以直接复制使用。

一、历史背景

Java Mail早期api是javax.mail,而现在新版本的api是jakarta.mail,jakarta.mail 旨在与 javax.mail 保持向后兼容,但是会有一些api不同,如果你的新项目或现有项目需要最新的功能和改进,建议使用 jakarta.mail,关于两者的区别如下:

(1)javax.mail 是 JavaMail API 的早期版本,由 oracle 维护。
(2)jakarta.mail 是 JavaMail API 的新版本,由 Eclipse Foundation 维护。
(3)javax.mail 使用 javax.mail 命名空间,jakarta.mail 使用 jakarta.mail 命名空间。
(4)jakarta.mail是javax.mail的替代品,大部分功能和api是一致的

二、pom依赖

javax.mail依赖

<dependency>
        <groupId>com.sun.mail</groupId>
        <artifactId>javax.mail</artifactId>
        <version>1.6.2</version>
    </dependency>

jakarta.mail依赖,在处理附件时候还需要多引入一个依赖jakarta.activation

  <dependency>
        <groupId>com.sun.mail</groupId>
        <artifactId>jakarta.mail</artifactId>
        <version>2.0.1</version>
    </dependency>
    <dependency>python
        <groupId>com.sun.activation</groupId>
        <artifactId>jakarta.activation</artifactId>
   js     <version>2.0.1</version>
     </dependency>

Java Mail发送邮件的核心类是Transport,其中封装了发送邮件的多个静态重载方法,如send(Message msg)、send(Message msg, Address[] addresses)、send(Message msg, String user, String password)、send(Message msg, Address[] addresses, String user, String password)、

三、API说明

(一)Session (会话)

Session用于创建和管理邮件会话。Session.getInstance() 方法用于获取一个 Session 实例,该实例可以用来发送和接收电子邮件。Session.getInstance() 方法接受两个参数:
Properties props:一个包含邮件会话配置属性的 Properties 对象。
Authenticator authenticator:一个 Authenticator 对象,用于提供邮件服务器的身份验证信息(可选)。
参数详解
1. Properties props
Properties 对象用于设置邮件会话的各种属性。这些属性通常包括邮件服务器的主机名、端口号、是否启用身份验证等。以下是一些常用的属性:
mail.smtp.host:SMTP 服务器的主机名。
mail.smtp.port:SMTP 服务器的端口号。
mail.smtp.auth:是否需要身份验证,值为 true 或 false。
mail.smtp.starttls.enable:是否启用 STARTTLS 安全连接,值为 true 或 false。
mail.smtp.socketFactory.class:用于创建套接字的类,通常设置为 javax.net.ssl.SSLSocketFactory。
mail.smtp.socketFactory.fallback:是否允许回退到非安全连接,值为 true 或 false。
mail.smtp.socketFactory.port:用于 SSL 连接的端口号。
2. Authenticator authenticator
Authenticator 对象用于提供邮件服务器的身份验证信息。如果需要身份验证,可以创建一个 Authenticator 子类并重写 getPasswordAuthentication 方法。
 

(二)Message(消息)

1.通过session创建消息
Message message = new MimeMessage(session)
2.消息发送的主题
message.setSubject(邮件标题);
3.消息的发送者
message.setFrom(new InternetAddress(发件人地址,发件人名称));
4.设置回复邮件地址,一般是发件人
message.setReplyTo(InternetAddress.parse(发件人地址));
5.创建邮件的接收者地址,并设置到邮件消息中。其中Message.RecipientType.TO 主送,Message.RecipientType.BCC 密送,Message.RecipientType.CC 抄送
message.addRecipient(Message.RecipientType.TO, 收件人地址);
6.消息发送的时间,一般new Date()取当前时间
message.setSentDate(new Date());
7.将MiniMultipart对象设置为邮件内容
message.setContent(multipart对象);

(三)Multipart(容器类)

1.MiniMultipart类是一个容器类,包含MimeBodyPart类型的对象
 Multipart multipart = new MimeMultipart();
2.创建一个包含html内容的MimeBodyPart设置HTML内容
BodyPart html = new MimeBodyPart();
html.setContent(info.getContent(), "text/html; charset=utf-8");
multipart.addBodyPart(html);

(四)Transport(发送电子邮件)

1.通过session创建Transport对象
Transport transport = session.getTransport("smtp");
2.连接邮件服务器
transport.connect(host, user, password);

(五)TransportListener(邮件监听)

1.通过transport添加邮件监听器,内置三种监听方式
        transport.addTransportListener(new TransportListener() {
            @Override
            public void messageDelivered(TransportEvent transportEvent) {//全部成功
                System.out.println("消息全部发送成功");
            }
            @Override
            public void messageNotDelivered(TransportEvent transportEvent) {//全部失败
                System.out.println("消息全部发送失败");
            }
            @Override
            public void messagePartiallyDelivered(TransportEvent transportEvent) {//部分成功
                System.out.println("消息部分发送成功");
            }
        });
2.发送邮件
Address[] allRecipients = message.getAllRecipients();
transport.sendMessage(message, message.getAllRecipients());

四、示例

以下示例大家可以直接复制到项目中使用,其中注释写的也很明白,一看就懂

(一)创建一个参数类

import lombok.Data;
@Data
public class MailInfo {
    //发送地址
    private String toAddress ;
    //邮件主题
    private String subject ;
    //邮件内容
    private String content ;
    //附件地址
    private String fileUrl ;
    //附件名称
    private String fileName ;
}

(二)邮件类

import jakarta.activation.DataHandler;
import jakarta.activation.URLDataSource;
import jakarta.mail.*;
import jakarta.mail.event.TransportEvent;
import jakarta.mail.event.TransportListener;
import jakarta.mail.internet.*;
import lombok.extern.slf4j.Slf4j;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Arrays;
import java.util.Date;
import java.util.Properties;
/**
 * @Author: 你住过的屋檐
 * @Date: 2024/11/12
 * @aphorism You are lucky to have someone to help you.No one to help you, is just fate.No one should do anything for you, because life is your own, you are responsible for yourself
 */
@Slf4j
public class MailUtils {

    private final static String host = "smtp.exmail.qq.com"; //主机名,根据所选邮件服务定
    private final static String user = "替换成你们发件用户邮箱";//发件用户邮箱
    private final static String password = "替换成你们的授权码"; //授权码
    private final static String personal = "XXX责任有限公司"; //授权码

    public static void sendMail(MailInfo info)throws Exception{
        Properties p = System.getProperties() ;
        p.setProperty("mail.smtp.host", host);//主机名
        p.setProperty("mail.smtp.auth", "true");//是否需要身份验证
        // 根据邮件会话属性和密码验证器构造一个发送邮件的session
        Session session = Session.getInstance(p, new Authenticator(){
            protected PasswordAuthentication getPasswordAuthentication() {
                return new PasswordAuthentication(user,password);//身份信息
            }
        });
        // 设置是否 debug
        //session.setDebug(true);
        //创建消息
        Message message = new MimeMessage(session);
        //消息发送的主题
        message.setSubject(info.getSubject());
        //消息的发送者
        message.setFrom(new InternetAddress(user,personal));
        // 解析多个密送收件地址
        InternetAddress[] toAddresses = InternetAddress.parse(info.getToAddress());
        //设置回复邮件地址,一般是发件人
        message.setReplyTo(InternetAddress.parse(user));
        // 创建邮件的接收者地址,并设置到邮件消息中。
        // Message.RecipientType.TO 主送,Message.RecipientType.BCC 密送,Message.RecipientType.CC 抄送
        for (InternetAddress address : toAddresses) {
            message.addRecipient(Message.RecipientType.TO, address);
        }
        // 消息发送的时间
        message.setSentDate(new Date());
        // MiniMultipart类是一个容器类,包含MimeBodyPart类型的对象
        Multipart multipart = new MimeMultipart();
        // 创建一个包含HTML内容的MimeBodyPart
        BodyPart html = new MimeBodyPart();
        // 设置HTML内容
        html.setContent(info.getContent(), "text/html; charset=utf-8");
        multipart.addBodyPart(html);
        // 验证链接是否有效获取文件流
        InputStream attachmentInputStream = downloadAttachment(info.getFileUrl());
        //流存在,验证通过,添加附件
        if (attachmentInputStream != null) {
            // 创建附件部分
            MimeBodyPart attachmentPart = new MimeBodyPart();
            //通过链接生成URLDataSource
            URLDataSource dataSource = new URLDataSource(new URL(info.getFileUrl()));
            //添加数据处理器
            attachmentPart.setDataHandler(new DataHandler(dataSource));
            //附件名称编码
            String fileName = MimeUtility.encodeText(info.getFileName()+new URL(info.getFileUrl()).getPath().substring(new URL(info.getFileUrl()).getPath().lastIndexOf('.') ), "UTF-8", "B");//B:base64
            //设置附件名称
            attachmentPart.setFileName(fileName);
            //添加附件
            multipart.addBodyPart(attachmentPart);
        }
        //将MiniMultipart对象设置为邮件内容
        message.setContent(multipart);
        Transport transport = session.getTransport("smtp");
        transport.connect(host, user, password);
        //添加邮件监听器,内置三种监听方式
        transport.addTransportListener(new TransportListener() {
            @Override
            public void messageDelivered(TransportEvent transportEvent) {//全部成功
                Address[] validSentAddresses = transportEvent.getValidSentAddresses();
                System.out.println("有效发送成功的邮件:"+ Arrays.toString(validSentAddresses));
                Address[] validUnsentAddresses = transportEvent.getValidUnsentAddresses();
                System.out.println("有效未发送成功的邮件:"+ Arrays.toString(validUnsentAddresses));
                Address[] invalidAddresses = transportEvent.getInvalidAddresses();
                System.out.println("无效的邮件"+ Arrays.toString(invalidAddresses));
                System.out.println("消息全部发送成功");

            }

            @Override
            public void messageNotDelivered(TransportEvent transportEvent) {//全部失败
                Address[] validSentAddresses = transportEvent.getValidSentAddresses();
                System.out.println("有效发送成功的邮件:"+ Arrays.toString(validSentAddresses));
                Address[] validUnsentAddresses = transportEvent.getValidUnsentAddresses();
                System.out.println("有效未发送成功的邮件:"+ Arrays.toString(validUnsentAddresses));
                Address[] invalidAddresses = transportEvent.getInvalidAddresses();
                System.out.println("无效的邮件"+ Arrays.toString(invalidAddresses));
                System.out.println("消息全部发送失败");
            }

            @Override
            public void messagePartiallyDelivered(TransportEvent transportEvent) {//部分成功
                Address[] validSentAddresses = transportEvent.getValidSentAddresses();
                System.out.println("有效发送成功的邮件:"+ Arrays.toString(validSentAddresses));
                Address[] validUnsentAddresses = transportEvent.getValidUnsentAddresses();
                System.out.println("有效未发送成功的邮件:"+ Arrays.toString(validUnsentAddresses));
                Address[] invalidAddresses = transportEvent.getInvalidAddresses();
                System.out.println("无效的邮件"+ Arrays.toString(invalidAddresses));
                System.out.println("消息部分发送成功");
            }
        });
        Address[] allRecipients = message.getAllRecipients();
        transport.sendMessage(message, message.getAllRecipients());
        System.out.println("收件人:"+ Arrays.toString(allRecipients));
    }

    /**
     * 获取文件输入流
     * @param url
     * @return
     * @throws Exception
     */
    private static InputStream downloadAttachment(String url) throws Exception {
        URL urlObj = new URL(url);
        HttpURLConnection connection = (HttpURLConnection) urlObj.openConnection();
        connection.setRequestMethod("GET");
        int responseCode = connection.getResponseCode();
        if (responseCode == HttpURLConnection.HTTP_OK) {
            return connection.getInputStream();
        } else {
            throw new RuntimeException("文件地址异常,code码: " + responseCode);
        }
    }

    public static void main(String[] args) {
        String mail = "xxx@qq.com"; //收件人地址,多个按照英文逗号分割就是群发
        String title = "一封有技术的邮件";
        String fileUrl="https://xxx.pdf";
        String fileName="附件";
        String content ="<!DOCTYPE html>\n" +
                                        "<html lang=\"zh-CN\">\n" +
                                        "<head>\n" +
                       编程                 "    <meta charset=\"UTF-8\">\n" +
                                        "    <style>        \n" +
                                        "\t\tbody {\n" +
                                        "            font-family: Arial;\n" +
                                        "            line-height: 1.5;\n" +
                                        "            margin: 0;\n" +
                                        "        }\n" +
                                        "        .container {\n" +
                                        "            margin: auto;\n" +
                                        "\t\t\tfont-size:12px;\n" +
                                        "        }\n" +
                                        "        .signature {\n" +
                                        "            margin-top: 20px;\n" +
                                        "        }\n" +
                                        "        .date {\n" +
                                        "            text-align: right;\n" +
                                        "            margin-top: 20px;\n" +
                                        "        }\n" +
                                        "\t\t.content{text-indent: 2em;}\n" +
                                        "    </style>\n" +
                                        "</head>\n" +
                                        "<body>\n" +
                                        "    <div class=\"container\">\n" +
                                        "        <p>尊敬的先生:</p>\n" +
                                        "        <p class='content'>您好!</p>\n" +
                                        "        <p class='content'>我代表XXX公司,给您发送一封邮件。希望您开心。</p>\n" +
                                        "        <div class=\"signature\">\n" +
                                        "            <p class='content'>敬请查收,恭祝商祺。</p>\n" +
                                        "            <p style='text-align: right;'>XXX有限公司</p>\n" +
                                        "        </div>\n" +
                                        "        <div class=\"date\">\n" +
                                        "            <p>2024-11-12</p>\n" +
                                        "        </div>\n" +
                                        "    </div>\n" +
                                        "</body>\n" +
                                        "</html>";
        MailInfo info = new MailInfo();
        info.setToAddress(mail);
        info.setSubject(title);
        info.setContent(content);
        info.setFileUrl(fileUrl);
        info.setFileName(fileName);
        try {
            MailUtils.sendMail(info);
        } catch (Exception e) {
            System.out.print("'"+title+"'的邮件发送失败!");
            e.printStackTrace();
        }
    }
}

(三)main执行结果

收件人:[xxx@qq.com]
有效发送成功的邮件:[xxx@qq.com]
有效未发送成功的邮件:null
无效的邮件null
消息全部发送成功

进程已结束,退出代码为 0

(四)收件结果

Java中使用Java Mail实现邮件服务功能示例

总结 

到此这篇关于Java中使用Java Mail实现邮件服务功能示例的文章就介绍到这了,更多相关Java Mail实现邮件服务内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于Java中使用Java Mail实现邮件服务功能示例的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1153272

相关文章

Pandas使用SQLite3实战

《Pandas使用SQLite3实战》本文主要介绍了Pandas使用SQLite3实战,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1 环境准备2 从 SQLite3VlfrWQzgt 读取数据到 DataFrame基础用法:读

JSON Web Token在登陆中的使用过程

《JSONWebToken在登陆中的使用过程》:本文主要介绍JSONWebToken在登陆中的使用过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录JWT 介绍微服务架构中的 JWT 使用结合微服务网关的 JWT 验证1. 用户登录,生成 JWT2. 自定义过滤

Java中StopWatch的使用示例详解

《Java中StopWatch的使用示例详解》stopWatch是org.springframework.util包下的一个工具类,使用它可直观的输出代码执行耗时,以及执行时间百分比,这篇文章主要介绍... 目录stopWatch 是org.springframework.util 包下的一个工具类,使用它

Java进行文件格式校验的方案详解

《Java进行文件格式校验的方案详解》这篇文章主要为大家详细介绍了Java中进行文件格式校验的相关方案,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、背景异常现象原因排查用户的无心之过二、解决方案Magandroidic Number判断主流检测库对比Tika的使用区分zip

Java实现时间与字符串互相转换详解

《Java实现时间与字符串互相转换详解》这篇文章主要为大家详细介绍了Java中实现时间与字符串互相转换的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、日期格式化为字符串(一)使用预定义格式(二)自定义格式二、字符串解析为日期(一)解析ISO格式字符串(二)解析自定义

opencv图像处理之指纹验证的实现

《opencv图像处理之指纹验证的实现》本文主要介绍了opencv图像处理之指纹验证的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录一、简介二、具体案例实现1. 图像显示函数2. 指纹验证函数3. 主函数4、运行结果三、总结一、

SpringKafka消息发布之KafkaTemplate与事务支持功能

《SpringKafka消息发布之KafkaTemplate与事务支持功能》通过本文介绍的基本用法、序列化选项、事务支持、错误处理和性能优化技术,开发者可以构建高效可靠的Kafka消息发布系统,事务支... 目录引言一、KafkaTemplate基础二、消息序列化三、事务支持机制四、错误处理与重试五、性能优

SpringIntegration消息路由之Router的条件路由与过滤功能

《SpringIntegration消息路由之Router的条件路由与过滤功能》本文详细介绍了Router的基础概念、条件路由实现、基于消息头的路由、动态路由与路由表、消息过滤与选择性路由以及错误处理... 目录引言一、Router基础概念二、条件路由实现三、基于消息头的路由四、动态路由与路由表五、消息过滤

Java使用Curator进行ZooKeeper操作的详细教程

《Java使用Curator进行ZooKeeper操作的详细教程》ApacheCurator是一个基于ZooKeeper的Java客户端库,它极大地简化了使用ZooKeeper的开发工作,在分布式系统... 目录1、简述2、核心功能2.1 CuratorFramework2.2 Recipes3、示例实践3

Springboot处理跨域的实现方式(附Demo)

《Springboot处理跨域的实现方式(附Demo)》:本文主要介绍Springboot处理跨域的实现方式(附Demo),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录Springboot处理跨域的方式1. 基本知识2. @CrossOrigin3. 全局跨域设置4.