脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot JavaMailSender发邮件

Spring Boot集成JavaMailSender发送邮件功能的实现

 更新时间：2022年05月06日 10:19:00   作者：剑圣无痕  
spring提供了发送邮件的接口JavaMailSender,通过JavaMailSender可以实现后端发送邮件,下面这篇文章主要给大家介绍了关于Spring Boot集成JavaMailSender发送邮件功能的相关资料,需要的朋友可以参考下

前言

项目中邮件发送为常用功能之一，例如注册成功后需要发送激活邮件，账号的会员到期提示，每日报表统计等功能都需要自动发送邮件，本文将讲解Spring Boot如何实现邮件发送功能。

集成步骤

添加依赖

  <dependency>
	  <groupId>org.springframework.boot</groupId>
	  <artifactId>spring-boot-starter-mail</artifactId>
    </dependency>

邮件配置信息

在resource目录下新增mail.properties内容如下：

#企业邮件配置
mail.host=smtp.exmail.qq.com
#端口
mail.port=587
mail.userName=xxx.com
mail.password=yyy
mail.smtp.timeou=15000
mail.smtp.auth=false
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

加载属性文件

@Component
@ConfigurationProperties(prefix = "mail")
@PropertySource(value = { "classpath:mail.properties" })
public class MailSenderConfig implements Serializable
{
    private static final long serialVersionUID = -4558468113448742143L;

    /**
     * 主机
     */
    private String host;

    /**
     * 端口
     */
    private int port;

    /**
     * 用户名
     */
    private String userName;

    /***
     * 密码
     */
    private String password;
    
    //省略get、set方法
  }

通过@PropertySource注解加载外部属性文件，不熟悉的朋友可以查看这篇文章。

邮件配置类

@Configuration
public class MailConfig
{
   @Autowired
   private MailSenderConfig mailSenderConfig;
   
   @Bean
   public JavaMailSenderImpl createMailSender()
   {
       JavaMailSenderImpl javaMailSender =new JavaMailSenderImpl();
       javaMailSender.setDefaultEncoding("UTF-8");
       javaMailSender.setHost(mailSenderConfig.getHost());
       javaMailSender.setPort(mailSenderConfig.getPort());
       javaMailSender.setProtocol(JavaMailSenderImpl.DEFAULT_PROTOCOL);
       javaMailSender.setUsername(mailSenderConfig.getUserName());
       javaMailSender.setPassword(mailSenderConfig.getPassword());
       Properties p = new Properties();
       p.setProperty("mail.smtp.timeout", "25000");
       p.setProperty("mail.smtp.auth", "true");
       p.setProperty("mail.smtp.socketFactory.class", "javax.net.ssl.SSLSocketFactory");
       javaMailSender.setJavaMailProperties(p);
       return javaMailSender;
   }
}

注意：JavaMailSenderImpl是JavaMailSender的实现。

代码实现

发送简单邮件

邮件实体类

public class Mail implements Serializable
{
    private static final long serialVersionUID = -1001194001681838276L;
    /**
     * 发送者
     */
    private String from;
    /**
     * 接收者
     */
    private String to;
    private String cc;
    private String bcc;
    /**
     * 主题
     */
    private String subject;
    /**
     * 内容
     */
    private String body;
    private String fileName;
    /**
     * 文件路径
     */
    private String filePath;
   //
  }

业务实现类

public interface MailService
{
    /**
     * 发送简单邮件
     * @param mail
     */
  void sendSimpleMail(Mail mail);
 }
 
 // 实现类
 @Component
public class MailServiceImpl implements MailService
{
    private Logger logger = LoggerFactory.getLogger(MailServiceImpl.class);
    
    @Autowired
    private JavaMailSenderImpl mailSender;
    
    @Autowired
    private SpringTemplateEngine templateEngine;
    
    public void sendSimpleMail(Mail mail)
    {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom(mail.getFrom());
        message.setTo(mail.getTo());
        message.setSubject(mail.getSubject());
        message.setText(mail.getBody());
        mailSender.send(message);
        logger.info("发送完毕");
    }
 }

测试类

@RestController
@RequestMapping("mail")
public class MailController
{
    @Autowired
    private MailService mailService;
    
    @Async
    @GetMapping("sendSimplEmail")
    public String sendSimplEmail() 
    {
        Mail mail = new Mail();
        mail.setFrom("xx@qq.com);
        mail.setTo("yyy@qq.com");
        mail.setSubject("测试邮件");
        mail.setBody("这是一封测试邮件");
        mailService.sendSimpleMail(mail);
        
        return "发送成功";
    }

注意：邮件功能需要异步发送，所以采用的@Async注解来实现。

至此简单的邮件发送功能已经完成。

扩展功能

发送Html内容的邮件

发送简单的邮件,有时候无法满足业务的需求，我们需要至此发送带HTMl内容格式的邮件。

业务实现类

 public void sendHtmlMail(Mail mail)
    {
        MimeMessage message =mailSender.createMimeMessage();
        MimeMessageHelper messageHelper=null;
        try
        {
            // 设置编码utf-8
            messageHelper = new MimeMessageHelper(message, true, "UTF-8");
            messageHelper.setFrom(mail.getFrom());
            messageHelper.setTo(mail.getTo());
            messageHelper.setSubject(mail.getSubject());
            //转换html
            messageHelper.setText(mail.getBody(),true);
            mailSender.send(message);
        }
        catch (MessagingException e)
        {
            logger.error("发送邮件失败");
            throw new RuntimeException("发送邮件失败",e);
        }
        logger.info("发送完毕");
    }

注意事项： 1.采用html格式的邮件需要注意内容的格式，采用UTF-8格式否则中文会出现乱码。 2.设置邮件内容时，需要将设置为true，否则html内容会原本输出。

测试类

   @Async
    @GetMapping("sendHtmlEmail")
    public String sendHtmlEmail() 
    {
        Mail mail = new Mail();
        mail.setFrom("xx@qq.com);
        mail.setTo("yyy@qq.com");
        mail.setSubject("测试html格式邮件");
        String content = "<html>\n" +
                "<body>\n" +
                "<h3>hello! 这是测试html内容邮件!</h3>\n" +
                "</body>\n" +
                "</html>";
        
        mail.setBody(content);
        mailService.sendHtmlMail(mail);
        
        return "发送成功";
    }

发送带附件邮件

业务实现类

   public void sendAttachmentsMail(Mail mail)
    {
        MimeMessage message =mailSender.createMimeMessage();
        MimeMessageHelper messageHelper=null;
        try
        {
            // 设置编码utf-8
            messageHelper = new MimeMessageHelper(message, true, "UTF-8");
            messageHelper.setFrom(mail.getFrom());
            messageHelper.setTo(mail.getTo());
            messageHelper.setSubject(mail.getSubject());
            //转换html
            messageHelper.setText(mail.getBody(),true);
            
            // 附件
            FileSystemResource resourse = new FileSystemResource(new File(mail.getFilePath()));
            // 附件名称和路径
            messageHelper.addAttachment(mail.getFileName(), resourse);
            mailSender.send(message);
        }
        catch (MessagingException e)
        {
            logger.error("发送邮件失败");
            throw new RuntimeException("发送邮件失败",e);
        }
        logger.info("发送完毕");
    }

测试类

    @Async
    @GetMapping("sendAttachmentsMail")
    public String sendAttachmentsMail() 
    {
        Mail mail = new Mail();
        mail.setFrom("xx@qq.com);
        mail.setTo("yyy@qq.com");
        mail.setSubject("测试附件邮件");
        mail.setBody("测试附件邮件,有附件请下载");
        mail.setFilePath("E:\\cfg\\test.png");
        mail.setFileName("test.png");
        mailService.sendAttachmentsMail(mail);
        return "发送成功";
    }

注意：设置附件的路径和附件的名称。

发送模板邮件

有些特殊需要，我们需要采用固定的邮件模板发送邮件。

邮件的模板可以采用thymeleaf和freemark来实现，本文将采用thymeleaf来实现邮件模板发送。

添加依赖

<!-- thymeleaf 模板 -->
	<dependency>
	    <groupId>org.springframework.boot</groupId>
	    <artifactId>spring-boot-starter-thymeleaf</artifactId>
	</dependency>
	
	<dependency>
	    <groupId>ognl</groupId>
	    <artifactId>ognl</artifactId>
	    <version>3.2.14</version>
	</dependency>

模板内容

模板路径:src/main/resources/templates/emailTemplate.html

模板内容:

<!DOCTYPE html>
<html lang="en"
      xmlns="http://www.w3.org/1999/xhtml"
      xmlns:th="http://www.thymeleaf.org">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    <title>mail</title>
</head>
<body>

<table align="center" cellpadding="0" cellspacing="0" width="600px" style="margin-bottom:20px">
    <tr>
        <td>
            <table align="center" border="0" cellpadding="0" cellspacing="0" width="600"
                   style="border-collapse: collapse;">

                <tr>
                    <td bgcolor="#ffffff">
                        <h3>邮件模板</h3>

                        <table border="0" cellpadding="0" cellspacing="0" width="100%">
                            <tr>
                                <td colspan="2" style="padding: 0 0 3px 0">
                                         公司名称：<span th:text="${emailParam.companyName}"></span>
                                </td>
                            </tr>
                            <tr>
                                <td style="padding: 12px 0 3px 0">
                                    地址：<span th:text="${emailParam.address}"></span>
                                </td>
                            </tr>
                            <tr>
                                <td style="padding: 12px 0 3px">
                                    联系人：<span th:text="${emailParam.phone}"></span>
                                </td>
                            </tr>

                        </table>
                    </td>
                </tr>
            </table>
        </td>
    </tr>

</table>
</body>
</html>

业务实现类

 public void sendTemplateMail(Mail mail)
    {
        Context context = new Context();
        Map<String, Object> emailParam = new HashMap<>();
        emailParam.put("companyName", "公司名称");
        emailParam.put("address", "公司地址");
        emailParam.put("phone", "联系电话");
        context.setVariable("emailParam", emailParam);
        //模板合成html内容
        String emailTemplate = templateEngine.process("emailTemplate", context);
        mail.setBody(emailTemplate);
        sendHtmlMail(mail);
    }

测试示例

    @Async
    @GetMapping("sendTemplateEmail")
    public String sendTemplateEmail() 
    {
        Mail mail = new Mail();
        mail.setFrom("xx@qq.com);
        mail.setTo("yyy@qq.com");
        mail.setSubject("测试模板邮件");
        mailService.sendTemplateMail(mail);
        return "发送成功";
    }

总结

本文讲解的是Spring Boot集成JavaMailSender发送邮件，邮件内容格式有种，需要结合业务的来选择对应的实现方式。

到此这篇关于Spring Boot集成JavaMailSender发送邮件功能的文章就介绍到这了,更多相关SpringBoot JavaMailSender发邮件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Spring加载properties文件的方法

    Spring加载properties文件的方法

    这篇文章主要为大家详细介绍了Spring加载properties文件的两种方法，一是通过xml方式，另一种方式是通过注解方式，感兴趣的小伙伴们可以参考一下
    2016-06-06
  • java实现MD5加密算法的实例代码

    java实现MD5加密算法的实例代码

    这篇文章主要介绍了java实现MD5加密算法的实例代码，有需要的朋友可以参考一下
    2013-12-12
  • 获取JsonObject某一未知key的值操作

    获取JsonObject某一未知key的值操作

    这篇文章主要介绍了获取JsonObject某一未知key的值操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • Java IO流深入理解

    Java IO流深入理解

    这篇文章主要介绍了java IO流的深入理解，下面和小编来一起学习一下吧，希望能给你带来帮助，也希望您能够多多关注脚本之家的更多内容
    2021-07-07
  • Java数组的定义、初始化、及二维数组用法分析

    Java数组的定义、初始化、及二维数组用法分析

    这篇文章主要介绍了Java数组的定义、初始化、及二维数组用法,结合具体实例形式分析了java数组概念、功能、数组定义、静态数组、动态数组、二维数组等相关使用技巧,需要的朋友可以参考下
    2019-01-01
  • Spring Cloud Ribbon负载均衡器处理方法

    Spring Cloud Ribbon负载均衡器处理方法

    这篇文章主要介绍了Spring Cloud Ribbon负载均衡器处理方法,看看是如何获取服务实例，获取以后做了哪些处理，处理后又是如何选取服务实例的，需要的朋友可以参考下
    2018-02-02
  • java实现后台图片跨域上传功能

    java实现后台图片跨域上传功能

    这篇文章主要给大家介绍了关于java实现后台图片跨域上传功能的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用java具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
    2019-07-07
  • MyBatis通用Mapper和PageHelper的过程详解

    MyBatis通用Mapper和PageHelper的过程详解

    这篇文章主要介绍了MyBatis通用Mapper和PageHelper的相关知识，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2020-11-11
  • nohup运行Java tail查看日志方式

    nohup运行Java tail查看日志方式

    nohup命令允许程序在用户退出账户或关闭终端后继续运行,常与"&"结合使用以实现程序的后台执行,配合重定向操作,nohup可以将程序输出保存到日志文件中,如nohup java -jar XXX.jar &> myout.log &,此外,tail命令可用于实时监控日志文件的变化
    2024-09-09
  • 并行Stream与Spring事务相遇会发生什么?

    并行Stream与Spring事务相遇会发生什么?

    这篇文章主要介绍了并行Stream与Spring事务相遇会发生什么?文章主要解决实战中的Bug及解决方案和技术延伸，具有一定的参考价值，需要的小伙伴可以参考一下
    2022-05-05

最新评论