SpringBoot模块系列：发送邮件（mail）

1 pom.xml

引入mail包。

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

2 DTO

邮件实体，包括主题、发送者邮件地址、接收者邮件地址、抄送者邮件地址、邮件正文内容，其中，接收者和抄送者地址可以为多个，使用英文逗号隔开。

package com.company.test.dto;

import lombok.Data;
import org.springframework.lang.Nullable;

import java.util.Date;

/**
 * 邮件输入参数.
 *
 * @author xindaqi
 * @since 2021/2/19 17:43
 */
@Data
public class EmailInputDTO {

    @Nullable
    private String from;
    @Nullable
    private String replyTo;
    @Nullable
    private String[] to;
    @Nullable
    private String[] cc;
    @Nullable
    private String[] bcc;
    @Nullable
    private Date sentDate;
    @Nullable
    private String subject;
    @Nullable
    private String text;

}

3 application-dev.yml

邮箱地址配置，包括

• 发送者邮箱配置，邮箱服务器，发送者邮箱地址，端口，内容编码格式
• 接收者和抄送者邮箱地址

spring:
  profiles: dev
  mail:
    host: smtp.qq.com
    username: ***@qq.com
    # qq邮箱为认证码
    password: *****
    port: 465
    protocol: smtp
    default-encoding: UTF-8
    properties:
      mail:
        smtp:
          auth: true
          starttls:
            enable: true
            required: true
          ssl:
            enable: true
        display:
          sendmail: test-send-email
server:
  port: 9121
  servlet:
    session:
      timeout: PT10S
email:
  address:
    sender: ***@qq.com
    receiver: ***@qq.com
    carbonCopy: ***@qq.com

4 读取邮箱配置

通过@ConfigurationProperties注解构建实体，映射yml配置文件的属性。

package com.company.test.common.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * 我是描述信息.
 *
 * @author xindaqi
 * @since 2021/2/18 15:57
 */
@Data
@Component
@ConfigurationProperties(prefix = "email.address")
public class EmailReceiverConfig {

    private String sender;

    private String[] receiver;

    private String[] carbonCopy;
}

5 Util

发送邮件工具类。

package com.company.test.common.utils;

import com.company.test.modules.alioss.dto.EmailInputDTO;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Component;

import java.util.List;

/**
 * 发送消息工具.
 *
 * @author xindaqi
 * @since 2021/2/19 17:15
 */
@Component
public class SendMessageUtil {

    /**
     * 发送邮件：只发送正文
     * @param  emailInputDTO 邮件正文
     * @return 发送结果标志位
     */
    public boolean sendEmail(JavaMailSender javaMailSender, EmailInputDTO emailInputDTO) {
        SimpleMailMessage mailMessageHandler = new SimpleMailMessage();
        BeanUtils.copyProperties(emailInputDTO, mailMessageHandler);
        javaMailSender.send(mailMessageHandler);
        return true;
    }
}

6 Test

测试用例。

package com.company.test;

import com.company.test.common.config.EmailReceiverConfig;
import com.company.test.common.utils.SendMessageUtil;
import com.company.test.modules.alioss.dto.EmailInputDTO;
import com.company.test.modules.alioss.service.ISendMessage;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.test.context.junit4.SpringRunner;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Resource;

@RunWith(SpringRunner.class)
@SpringBootTest
public class OssApplicationTests {

	private static final Logger logger = LoggerFactory.getLogger(OssApplicationTests.class);

	@Resource(name="A")
	ISendMessage sendMessage;
	@Autowired
	EmailReceiverConfig emailReceiverConfig;
	@Resource
	JavaMailSender javaMailSender;
	@Resource
	SendMessageUtil sendMessageUtil;
	/**
	 * @description 我是第一个测试用例
	 * @author xindaqi
	 * @since 2021/2/18 14:31
	 */
	@Test
	public void contextLoads() {
		Assert.assertEquals("oss", "oss");
		logger.info("我是第一个测试用例");
	}

	/**
	 * 发送邮件
	 * 纯文本内容
	 */
	@Test
	public void sendEmailOnlyText() {
		EmailInputDTO emailInputDTO = new EmailInputDTO();
		emailInputDTO.setFrom(emailReceiverConfig.getSender());
		emailInputDTO.setTo(emailReceiverConfig.getReceiver());
		emailInputDTO.setSubject("Spring Boot");
		emailInputDTO.setText("我是Spring Boot发送的邮件！");
		boolean sendFlag = sendMessageUtil.sendEmail(javaMailSender, emailInputDTO);
		Assert.assertEquals(sendFlag, true);
		logger.info("发送邮件");
	}
}

---

【参考文献】
[1]https://www.cnblogs.com/sun2020/p/13961554.html
[2]https://github.com/xkcoding/spring-boot-demo/blob/master/demo-email/src/main/resources/application.yml