在Spring Boot中实现邮件发送功能的详细指南

createh55个月前 (12-15)技术教程43

有时候,我们可能会用邮件确认、或者是发送重置密码的链接,或者是通过邮件来发送一些通知提醒的功能,在Spring Boot中内置了邮件发送的功能,下面我们就来看看如何在Spring Boot中利用现有的邮件功能来实现邮件发送功能。。

准备工作

要想实现发送邮件的功能首先需要有一个SMTP的邮件发送服务器,比如可以通过Gmail、QQ邮箱或企业邮箱,来实现这个功能,接下来就是需要在项目中添加发送邮件相关的依赖,如下所示。

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

接下来我们就需要配置SMTP的邮件服务,这里,我们演示通过Gmail作为SMTP服务器来实现,当然有兴趣的读者可以研究通过网易邮箱、QQ有限来实现相关的操作内容。

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=your-email@gmail.com
spring.mail.password=your-email-password
spring.mail.protocol=smtp
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true

当然这里为了安全起见,可以将邮件的信息通过Jasypt来实现对敏感信息加密操作。

创建邮件发送服务

配置完成之后,接下来我们需要创建一个邮件发送服务,如下所示。

@Service
public class EmailService {

    @Autowired
    private JavaMailSender mailSender;

    public void sendSimpleMail(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        message.setFrom("your-email@gmail.com");

        mailSender.send(message);
    }
}

然后可以创建一个RESTFul接口来调用这个服务实现邮件发送操作。

@RestController
public class EmailController {

    @Autowired
    private EmailService emailService;

    @GetMapping("/send-email")
    public String sendEmail(@RequestParam String to, @RequestParam String subject, @RequestParam String text) {
        try {
            emailService.sendSimpleMail(to, subject, text);
            return "Email sent successfully!";
        } catch (Exception e) {
            e.printStackTrace();
            return "Failed to send email.";
        }
    }
}

发送HTML格式的邮件

在上面的实现中,我们发送的是一个简单的文本类型的邮件,但是在有些场景中,我们可能需要对邮件的格式进行设置,也就是说我们需要发送一个HTML格式的邮件,或者是要实现添加附件发送操作。可以看通过如下的扩展来实现。

@Service
public class EmailService {

    @Autowired
    private JavaMailSender mailSender;

    public void sendHtmlMail(String to, String subject, String htmlContent) throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message, true);

        helper.setTo(to);
        helper.setSubject(subject);
        helper.setText(htmlContent, true);
        helper.setFrom("your-email@gmail.com");

        mailSender.send(message);
    }
}

发送带有附件操作的邮件,如下所示。

public void sendMailWithAttachment(String to, String subject, String text, String pathToAttachment) throws MessagingException {
    MimeMessage message = mailSender.createMimeMessage();
    MimeMessageHelper helper = new MimeMessageHelper(message, true);

    helper.setTo(to);
    helper.setSubject(subject);
    helper.setText(text);
    helper.setFrom("your-email@gmail.com");

    FileSystemResource file = new FileSystemResource(new File(pathToAttachment));
    helper.addAttachment("Attachment", file);

    mailSender.send(message);
}

总结

以上展示了通过谷歌邮箱来实现邮件的发送操作,如果想使用其他的邮箱,可以查找相关的方式来搭建SMTP的邮件服务,然后通过这个邮件服务来实现邮件发送操作。当然如果在实际开发中你还需要更加复杂的邮件模板,可以通过集成Thymeleaf或Freemarker来提供更加复杂的邮件发送模板,这样就会让你的邮件更加美观。

相关文章

Java二十周年特别策划--谈谈我与Java的那些年、这些事

Java作为当今最流行的编程技术之一,它的出现不仅给软件产业带来了深远影响,也改变了许多人的人生轨迹。得益于其技术平台的通用性、高效性、平台移植性和安全性,许多企业纷纷选用Java作为技术支撑,获得了...

SpringBoot整合之邮件发送

1.邮件发送需要引入spring-boot-starter-mail依赖。<dependency> <groupId>org.springframework.boot<...