在Spring Boot中使用JavaMailSender发送邮件

news2024/12/25 8:54:18

用了这么久的Spring Boot，我们对Spring Boot的了解应该也逐步进入正轨了，这篇文章讲的案例也在我们的实际开发中算是比较实用的了，毕竟我们完成注册功能和对用户群发消息，都可以采用到邮箱发送功能，往下看，我们来看看什么是JavaMailSender。

什么是JavaMailSender

JavaMailSender是Spring Framework中的一个接口，用于发送电子邮件。它是Spring对JavaMail API的封装，提供了更简单和更方便的方式来发送邮件。

JavaMailSender接口定义了一组发送邮件的方法，包括发送简单文本邮件、发送带附件的邮件、发送HTML格式的邮件等。它隐藏了底层JavaMail API的复杂性，使得在Spring应用中发送邮件变得更加容易。

在Spring Boot中，你可以通过依赖注入JavaMailSender来使用它。通过配置邮件服务器的相关信息，你可以使用JavaMailSender发送邮件。

JavaMailSender接口的常用实现类是JavaMailSenderImpl，它是基于JavaMail API实现的。除了JavaMailSenderImpl，Spring还提供了其他的实现类，例如MockMailSender用于测试目的。

使用JavaMailSender，你可以方便地发送邮件，设置收件人、发件人、主题、正文等信息，并可以附加文件、设置抄送、密送等功能。

JavaMailSender是Spring Framework中用于发送邮件的接口，它简化了邮件发送的过程，提供了更高级的抽象和便利性。

来看一个案例：
引入依赖：

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

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

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

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

如其他自动化配置一样，我们在引入相关依赖后就需要在application.properties文件中进行配置：

spring.mail.host=your-smtp-host
spring.mail.port=your-smtp-port
spring.mail.username=your-username
spring.mail.password=your-password
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

请将your-smtp-host、your-smtp-port、your-username和your-password替换为你的实际信息。

然后，在你的代码中，注入JavaMailSender并使用它来发送邮件。以下是一个简单的示例：

例如我们采用qq邮箱：

spring.mail.host=smtp.qq.com
spring.mail.username=用户名
spring.mail.password=密码
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true

这里的密码指你获取的邮箱的授权码
在这里插入图片描述

在这里获取你的相关信息，

@SpringBootApplication
public class Application {

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}
}

在这里插入图片描述
template.vm

<html>
<body>
    <h3>你好， ${username}, 这是一封模版引擎封装的邮箱信!</h3>
</body>
</html>

之后咱们创建一个测试类进行：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
public class ApplicationTests {

	@Autowired
	private JavaMailSender mailSender;
	@Autowired
	private VelocityEngine velocityEngine;

	//简单的邮件发送
	@Test
	public void sendSimpleMail() throws Exception {

		SimpleMailMessage message = new SimpleMailMessage();
		message.setFrom("28****70@qq.com");
		message.setTo("28****70@qq.com");
		message.setSubject("主题：简单邮件");
		message.setText("简单的邮件内容");

		mailSender.send(message);
	}

	//携带附件的邮件
	@Test
	public void sendAttachmentsMail() throws Exception {

		MimeMessage mimeMessage = mailSender.createMimeMessage();

		MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
		helper.setFrom("28****70@qq.com");
		helper.setTo("28****70@qq.com");
		helper.setSubject("主题：有附件");
		helper.setText("内容：有附件的邮件");

		FileSystemResource file = new FileSystemResource(new File("weixin.jpg"));
		helper.addAttachment("miaow-1.jpg", file);
		helper.addAttachment("miaow-2.jpg", file);
		helper.addAttachment("miaow-2.jpg", file);
		mailSender.send(mimeMessage);
	}

		//发送嵌入静态资源
	@Test
	public void sendInlineMail() throws Exception {

		MimeMessage mimeMessage = mailSender.createMimeMessage();

		MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
		helper.setFrom("28****70@qq.com");
		helper.setTo("28****70@qq.com");
		helper.setSubject("主题：嵌入静态资源");
		helper.setText("<html><body><img src=\"cid:weixin\" ></body></html>", true);

		FileSystemResource file = new FileSystemResource(new File("weixin.jpg"));
		helper.addInline("weixin", file);

		mailSender.send(mimeMessage);
	}

		//发送模版附件
	@Test
	public void sendTemplateMail() throws Exception {

		MimeMessage mimeMessage = mailSender.createMimeMessage();

		MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
		helper.setFrom("28****70@qq.com");
		helper.setTo("28****70@qq.com");
		helper.setSubject("主题：模板邮件");

		Map<String, Object> model = new HashedMap();
		model.put("username", "miaow");
		String text = VelocityEngineUtils.mergeTemplateIntoString(
				velocityEngine, "template.vm", "UTF-8", model);
		helper.setText(text, true);

		mailSender.send(mimeMessage);
	}
}