Cách dùng Spring Email trong Spring Boot

Cách sử dụng Spring Email để gửi email trong ứng dụng Spring Boot Java và đưa ra một ví dụ minh họa để giúp bạn áp dụng kiến thức vào thực tế.

Việc gửi email là một chức năng quan trọng trong phát triển ứng dụng web, đặc biệt là khi chúng ta cần thông báo về các hoạt động của ứng dụng hoặc gửi thông tin đến người dùng. Spring Email là một trong những thư viện hỗ trợ gửi email phổ biến nhất trong môi trường Spring Boot Java, với nhiều tính năng và khả năng tùy chỉnh cao.

1. Spring Email là gì?

Spring Email

Giới thiệu về Spring Email

Khái niệm: Spring Email là một thư viện trong Spring Framework, cung cấp cho các nhà phát triển các lớp và công cụ hỗ trợ để tạo và gửi email trong ứng dụng Spring Boot Java. Thư viện này sử dụng các giao thức SMTP và MIME để tạo và gửi các email, cho phép chúng ta đính kèm các tệp đính kèm, tùy chỉnh nội dung email và gửi email đến nhiều người nhận cùng lúc.

Tính năng: Một số tính năng cơ bản của Spring Email.

Bài viết này được đăng tại [free tuts .net]

• Xây dựng nội dung email: Spring Email cung cấp cho chúng ta lớp MimeMessageHelper để dễ dàng tạo nội dung email, cho phép đính kèm tệp tin, chèn hình ảnh, định dạng nội dung email theo HTML hoặc văn bản thuần túy.

• Gửi email đến nhiều người nhận: Chúng ta có thể gửi email đến nhiều người nhận cùng lúc thông qua việc chỉ định danh sách địa chỉ email của các người nhận.

• Tính năng đa luồng: Spring Email hỗ trợ tính năng đa luồng để xử lý các nhiệm vụ gửi email một cách hiệu quả và không làm chậm hoạt động của ứng dụng.

• Tính năng tùy chỉnh cao: Spring Email cho phép chúng ta tùy chỉnh các thông tin về SMTP server, cấu hình TLS/SSL, xác thực, thời gian chờ kết nối, các thông tin xác thực tài khoản email, v.v. để phù hợp với yêu cầu của ứng dụng.

Ứng dụng: Spring Email được sử dụng rộng rãi trong các ứng dụng web để gửi các email thông báo đến người dùng, như thông báo đặt hàng, thông báo kích hoạt tài khoản, v.v. Ngoài ra, nó cũng được sử dụng trong các ứng dụng quản lý email như các ứng dụng webmail hoặc các công cụ quản lý email khác. Với tính năng tùy chỉnh cao, Spring Email cũng có thể được sử dụng để gửi email tùy chỉnh trong các ứng dụng phát triển khác như ứng dụng máy chủ hoặc ứng dụng máy tính cá nhân.

Tầm quan trọng của Spring Email trong ứng dụng web?

Với tầm quan trọng của email trong giao tiếp trực tuyến hiện nay, Spring Email có tầm quan trọng rất lớn trong ứng dụng web. Dưới đây là một số tầm quan trọng của Spring Email trong ứng dụng web:

Gửi thông báo cho người dùng: Trong ứng dụng web, chúng ta thường cần gửi email thông báo cho người dùng để cập nhật về các sự kiện quan trọng, ví dụ như đăng ký tài khoản, kích hoạt tài khoản, thông báo đặt hàng, v.v. Spring Email cung cấp các công cụ để tạo và gửi các email thông báo này một cách dễ dàng và nhanh chóng.

Gửi email xác nhận: Khi người dùng đăng ký tài khoản hoặc thực hiện một hành động quan trọng, chúng ta thường cần gửi email xác nhận để đảm bảo tính xác thực và bảo mật cho ứng dụng. Spring Email cung cấp các công cụ để tạo và gửi email xác nhận một cách dễ dàng và đáng tin cậy.

Gửi email marketing: Trong ứng dụng web, chúng ta có thể sử dụng email để quảng cáo sản phẩm hoặc dịch vụ đến khách hàng. Spring Email cung cấp các công cụ để tạo và gửi các email marketing này một cách dễ dàng và tiện lợi.

Quản lý email: Nếu ứng dụng web cần tích hợp chức năng quản lý email như các ứng dụng webmail hoặc các công cụ quản lý email khác, Spring Email là một lựa chọn tuyệt vời để hỗ trợ việc này. Chúng ta có thể sử dụng Spring Email để tạo và gửi email, cũng như quản lý các email đã gửi hoặc nhận.

=> Với các tính năng tiên tiến và tùy chỉnh cao, Spring Email giúp các nhà phát triển ứng dụng web xây dựng và triển khai các tính năng email một cách dễ dàng và hiệu quả.

2. Cài đặt và cấu hình môi trường để sử dụng Spring Email

Bước 1: Tạo project.

Đầu tiên các bạn cần tạo mới một dự án mới, bạn có thể tham khảo các bước tạo project trên phần mềm Eclipse qua các bài trước.

Hoặc bạn có thể tạo project trên trang chủ Spring Boot Initializr hoặc sử dụng các IDE như Eclipse, IntelliJ IDEA, hoặc NetBeans để tạo project.

Bước 2: Thêm dependency Spring Email

Thêm dependency của Spring Email vào file pom.xml để có thể sử dụng được Spring Email:

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

Bước 2: Cấu hình file

Cấu hình thông tin kết nối SMTP server trong file application.properties hoặc application.yml.

Ví dụ:

spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=example@gmail.com
spring.mail.password=examplepassword
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

Lưu ý: Chúng ta có thể thay đổi thông tin kết nối SMTP server tùy theo nhu cầu sử dụng.

3. Sử dụng Spring Email

Tạo một đối tượng EmailSender và cấu hình nó trong Spring Boot

Để cấu hình EmailSender trong Spring Boot thì chúng ta cần add dependency và cấu hình thông tin kết nối như phần trên mình vừa hướng dẫn.

Bước 1: Tạo đối tượng EmailSender

Để tạo đối tượng EmailSender, bạn có thể sử dụng @Autowired để inject dependency của EmailSender vào trong class của bạn.

Ví dụ:

@Service
public class MyEmailService {
 
    @Autowired
    private JavaMailSender javaMailSender;
 
    // ...
}

Bước 2: Sử dụng đối tượng EmailSender để gửi email

Sau khi tạo đối tượng EmailSender, bạn có thể sử dụng các phương thức của nó để gửi email.

Ví dụ:

@Service
public class MyEmailService {
 
    @Autowired
    private JavaMailSender javaMailSender;
 
    public void sendEmail(String to, String subject, String text) {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setTo(to);
        message.setSubject(subject);
        message.setText(text);
        javaMailSender.send(message);
    }
}

Trong ví dụ trên, chúng ta đã tạo một đối tượng SimpleMailMessage để lưu trữ các thông tin cần thiết để gửi email, sau đó sử dụng phương thức javaMailSender.send() để gửi email.

Tạo một đối tượng MimeMessagePreparator để thiết lập nội dung email

Để tạo một đối tượng MimeMessagePreparator trong Spring Boot để thiết lập nội dung email, bạn có thể sử dụng đối tượng MimeMessageHelper để tạo email có định dạng MIME. MimeMessageHelper cung cấp các phương thức để thiết lập các thuộc tính của email như địa chỉ email người gửi, địa chỉ email người nhận, tiêu đề email và nội dung email.

Ví dụ, để tạo một đối tượng MimeMessagePreparator với nội dung email là một chuỗi HTML, bạn có thể sử dụng đoạn mã sau:

MimeMessagePreparator messagePreparator = mimeMessage -> {
    MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage, true, "UTF-8");
    messageHelper.setFrom("sender@example.com");
    messageHelper.setTo("recipient@example.com");
    messageHelper.setSubject("Test email");
    String htmlContent = "<html><body><h1>This is a test email</h1></body></html>";
    messageHelper.setText(htmlContent, true);
};

Lưu ý rằng trong ví dụ trên, chúng ta đã sử dụng charset là UTF-8 để đảm bảo rằng email có thể hiển thị đúng các ký tự Unicode.

Sau khi tạo đối tượng MimeMessagePreparator, bạn có thể sử dụng nó để gửi email bằng cách sử dụng phương thức send() của JavaMailSender:

javaMailSender.send(messagePreparator);

Khi gửi email, JavaMailSender sẽ sử dụng thông tin cấu hình được cung cấp trong file application.properties hoặc application.yml để thiết lập kết nối SMTP và gửi email.

4. Ví dụ gửi Email đơn giản

Tạo một ứng dụng Spring Boot đơn giản để gửi email

Bước 1: Các bước tạo project và cấu hình dự án các bạn có thể tham khảo ở các bước trên.

Bước 2: Tiếp đó là bước tạo JavaMailSender

Tạo một đối tượng JavaMailSender trong ứng dụng của bạn bằng cách sử dụng @Autowired và @Bean annotation:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.JavaMailSenderImpl;

@Configuration
public class MailConfig {

    @Autowired
    private MailProperties mailProperties;

    @Bean
    public JavaMailSender javaMailSender() {
        JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
        mailSender.setHost(mailProperties.getHost());
        mailSender.setPort(mailProperties.getPort());
        mailSender.setUsername(mailProperties.getUsername());
        mailSender.setPassword(mailProperties.getPassword());
        mailSender.setJavaMailProperties(mailProperties.getProperties());
        return mailSender;
    }
}

Lưu ý rằng trong ví dụ trên, chúng ta đã sử dụng @Autowired để inject đối tượng MailProperties, đây là một lớp để lưu trữ các thông tin cấu hình của email được cấu hình trong file application.properties.

Bước 3: Tạo một đối tượng MimeMessagePreparator để thiết lập nội dung email

Tạo một đối tượng MimeMessagePreparator để thiết lập nội dung email của bạn.

Ví dụ:

import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.mail.javamail.MimeMessagePreparator;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework

Tiếp tục phần trước, bạn có thể sử dụng Thymeleaf để tạo email với định dạng HTML. Thymeleaf là một công cụ mạnh mẽ cho phép bạn tạo các mẫu HTML động. Để sử dụng Thymeleaf trong ứng dụng của bạn, bạn cần thêm dependency spring-boot-starter-thymeleaf vào file pom.xml hoặc build.gradle.

Bước 4: Tạo một template email bằng Thymeleaf

Bạn có thể tạo một template email bằng Thymeleaf, tại đây bạn có thể sử dụng các biểu thức Thymeleaf để tạo nội dung email động.

Ví dụ:

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Mail Template</title>
</head>
<body>
    <p th:text="${message}"></p>
</body>
</html>

Trong ví dụ trên, chúng ta sử dụng biểu thức Thymeleaf ${message} để đưa dữ liệu động vào template email

Bước 5: Tạo đối tượng MimeMessagePreparator

Sau khi tạo template email, bạn có thể tạo đối tượng MimeMessagePreparator để thiết lập nội dung email.

Ví dụ:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.mail.javamail.MimeMessagePreparator;
import org.springframework.stereotype.Component;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;

import javax.mail.internet.MimeMessage;

@Component
public class EmailService {

    @Autowired
    private JavaMailSender javaMailSender;

    @Autowired
    private TemplateEngine templateEngine;

    public void sendMail(String to, String subject, String message) {

        MimeMessagePreparator preparator = new MimeMessagePreparator() {
            public void prepare(MimeMessage mimeMessage) throws Exception {
                MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage, true, "UTF-8");
                messageHelper.setFrom("noreply@example.com");
                messageHelper.setTo(to);
                messageHelper.setSubject(subject);

                Context context = new Context();
                context.setVariable("message", message);
                String content = templateEngine.process("email-template", context);

                messageHelper.setText(content, true);
            }
        };

        javaMailSender.send(preparator);
    }
}

Trong ví dụ trên, chúng ta sử dụng đối tượng TemplateEngine để render nội dung email từ template Thymeleaf. Sau đó, chúng ta sử dụng đối tượng MimeMessageHelper để thiết lập thông tin email, bao gồm địa chỉ email người nhận, chủ đề email và nội dung email. Cuối cùng, chúng ta sử dụng đối tượng JavaMailSender để gửi email.

Bước 7: Gửi Email

Cuối cùng, bạn có thể gửi email bằng cách gọi phương thức sendMail() của đối tượng EmailService.

Ví dụ:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.JavaMailSenderImpl;

@SpringBootApplication
public class EmailApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(EmailApplication.class, args);

        EmailService emailService = context.getBean(EmailService.class);
        emailService.sendMail("to@example.com", "Test Email", "This is a test email.");
    }

    @Bean
    public JavaMailSender javaMailSender() {
        JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
        javaMailSender.setHost("smtp.gmail.com");
        javaMailSender.setPort(587);
        javaMailSender.setUsername("your-email@gmail.com");
        javaMailSender.setPassword("your-password");

        Properties properties = javaMailSender.getJavaMailProperties();
        properties.put("mail.transport.protocol", "smtp");
        properties.put("mail.smtp.auth", "true");
        properties.put("mail.smtp.starttls.enable", "true");
        properties.put("mail.debug", "true");

        return javaMailSender;
    }
}

Nếu bạn sử dụng Gmail để gửi email, bạn cần bật chế độ truy cập cho ứng dụng kém an toàn bằng cách vào mục Security của tài khoản Google và bật tùy chọn "Less secure app access".

Chúc bạn thành công trong việc tạo ứng dụng Spring Boot để gửi email!

Thực hiện gửi email thông qua giao diện người dùng hoặc REST API

Để gửi email thông qua giao diện người dùng hoặc REST API trong Spring Email trong Spring Boot, chúng ta có thể sử dụng các framework như Thymeleaf để tạo giao diện và Spring MVC hoặc Spring WebFlux để xử lý các yêu cầu REST API.

Bước 1: Sử dụng Thymeleaf để tạo giao diện người dùng

Đầu tiên, chúng ta cần tạo một trang HTML sử dụng Thymeleaf để cho phép người dùng nhập thông tin và gửi email.

Dưới đây là một ví dụ đơn giản:

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Send Email</title>
</head>
<body>
    <h1>Send Email</h1>

    <form method="post" th:action="@{/send-email}">
        <label for="to">To:</label>
        <input type="email" id="to" name="to" required><br>

        <label for="subject">Subject:</label>
        <input type="text" id="subject" name="subject" required><br>

        <label for="body">Body:</label>
        <textarea id="body" name="body" rows="5" required></textarea><br>

        <button type="submit">Send</button>
    </form>
</body>
</html>

Ở đây, chúng ta sử dụng Thymeleaf để tạo form và định dạng trang HTML. Đường dẫn đến phương thức xử lý yêu cầu gửi email sử dụng thuộc tính th:action="@{/send-email}".

Bước 2: Tạo một phương thức xử lý yêu cầu

Sau đó, chúng ta cần tạo một phương thức xử lý yêu cầu POST để gửi email. Ở đây, chúng ta sử dụng đối tượng EmailService đã được cấu hình trong phần trước để gửi email:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class EmailController {

    @Autowired
    private EmailService emailService;

    @PostMapping("/send-email")
    public String sendEmail(@RequestParam String to, @RequestParam String subject, @RequestParam String body) {
        emailService.sendMail(to, subject, body);
        return "redirect:/";
    }
}

Ở đây, chúng ta sử dụng @PostMapping để xử lý yêu cầu POST từ form và sử dụng đối tượng EmailService để gửi email. Sau khi gửi email thành công, chúng ta chuyển hướng trở lại trang chủ.

Bước 3: Sử dụng Spring MVC hoặc Spring WebFlux để tạo REST API

Đối với việc gửi email thông qua REST API, chúng ta có thể sử dụng Spring MVC hoặc Spring WebFlux để xử lý các yêu cầu HTTP.

Dưới đây là một ví dụ sử dụng Spring MVC:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class EmailController {

    @Autowired
    private EmailService emailService;

    @PostMapping("/send-email")
    public ResponseEntity<String> sendEmail(@RequestBody EmailRequest emailRequest) {
        emailService.sendMail(emailRequest.getTo(), emailRequest.getSubject(), emailRequest.getBody());
        return new ResponseEntity<>("Email sent successfully", HttpStatus.OK);
    }
}

Bước 4: Với Spring WebFlux, chúng ta có thể sử dụng đối tượng WebClient để gửi yêu cầu HTTP đến một REST API khác để gửi email.

Dưới đây là một ví dụ:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;

@Controller
public class EmailController {

    @Autowired
    private WebClient webClient;

    @PostMapping("/send-email")
    public Mono<String> sendEmail(@RequestBody EmailRequest emailRequest) {
        return webClient.post()
                .uri("/send-email")
                .contentType(MediaType.APPLICATION_JSON)
                .body(Mono.just(emailRequest), EmailRequest.class)
                .retrieve()
                .bodyToMono(String.class);
    }
}

Ở đây, chúng ta sử dụng WebClient để gửi yêu cầu POST đến một REST API khác để gửi email. Chúng ta cũng sử dụng Mono để xử lý kết quả trả về từ REST API.

Bước 5: Ngoài ra, bạn cũng có thể tích hợp email vào các ứng dụng Spring Boot khác như các ứng dụng hàng đợi bằng cách sử dụng Spring AMQP hoặc các ứng dụng lên lịch bằng cách sử dụng Spring Scheduling.

Ví dụ, bạn có thể tạo một Job để gửi email mỗi ngày lúc 9 giờ sáng như sau:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@Component
public class EmailJob {

    @Autowired
    private EmailService emailService;

    @Scheduled(cron = "0 0 9 * * *")
    public void sendDailyEmail() {
        String to = "example@example.com";
        String subject = "Daily Report";
        String body = "Hello,\n\nHere is your daily report.\n\nBest regards,\nExample team";
        emailService.sendMail(to, subject, body);
    }
}

Ở đây, chúng ta sử dụng @Scheduled để lên lịch Job để gửi email mỗi ngày lúc 9 giờ sáng. Đối tượng EmailService được sử dụng để gửi email.

Kết quả: Ví dụ trên sẽ gửi email mỗi ngày lúc 9 giờ sáng đến địa chỉ email "example@example.com" với tiêu đề "Daily Report" và nội dung "Hello,\n\nHere is your daily report.\n\nBest regards,\nExample team". Nếu thành công, người dùng sẽ nhận được email đó.

5. Các câu hỏi thường gặp

Spring Email hoạt động như thế nào trong Spring Boot?

Spring Email trong Spring Boot sử dụng JavaMailSender để gửi email. JavaMailSender được cấu hình bằng cách sử dụng đối tượng JavaMailSenderImpl được cung cấp bởi Spring Boot. Chúng ta có thể cấu hình JavaMailSender bằng các thuộc tính trong file application.properties hoặc application.yml của ứng dụng Spring Boot.

Có cách nào xác nhận rằng email đã được gửi thành công?

Có, JavaMailSender có thể trả về một đối tượng đại diện cho trạng thái của email đã được gửi. Đối tượng này chứa các thông tin như trạng thái, mã trạng thái và thông báo lỗi (nếu có). Chúng ta có thể kiểm tra đối tượng trả về này để xác định xem email đã được gửi thành công hay không.

Làm thế nào để đính kèm tệp đính kèm vào email?

Để đính kèm tệp đính kèm vào email, chúng ta có thể sử dụng đối tượng MimeMessageHelper. Chúng ta có thể sử dụng phương thức addAttachment() để đính kèm tệp đính kèm vào email.

Làm thế nào để gửi email đến nhiều người nhận?

Chúng ta có thể gửi email đến nhiều người nhận bằng cách chỉ định danh sách các địa chỉ email cách nhau bằng dấu phẩy trong phương thức send() hoặc bằng cách sử dụng phương thức addTo() của đối tượng MimeMessageHelper.

Tôi có thể sử dụng Spring Email để gửi email từ các ứng dụng không phải là Spring Boot không?

Có, chúng ta có thể sử dụng Spring Email để gửi email từ các ứng dụng không phải là Spring Boot bằng cách cấu hình JavaMailSenderImpl và sử dụng đối tượng MimeMessageHelper. Chúng ta có thể khởi tạo đối tượng JavaMailSenderImpl bằng cách cung cấp các thuộc tính như host, port, username và password.

6. Kết bài viết

Hy vọng bài viết này giúp bạn có thể hiểu và sử dụng Spring Email trong Spring Boot một cách dễ dàng và hiệu quả hơn. Nếu bạn có bất kỳ câu hỏi hay thắc mắc nào về chủ đề này, hãy đặt câu hỏi cho chúng tôi và chúng tôi sẽ cố gắng trả lời trong thời gian sớm nhất có thể.