Explication détaillée du service de messagerie intégré dans SpringBoot (avec code)

Cet article vous apporte une explication détaillée du service de messagerie intégré dans SpringBoot (avec code). Il a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer.

1. Préface

Le cœur de l'abstraction Spring Email est l'interface MailSender. L'implémentation de MailSender peut envoyer des e-mails au serveur de messagerie, et le serveur de messagerie implémente la fonction d'envoi. e-mails.

Spring est livré avec une implémentation MailSender, JavaMailSenderImpl, qui utilise l'API JavaMail pour envoyer des e-mails. Avant qu'une application Spring ou SpringBoot puisse envoyer un e-mail, nous devons assembler JavaMailSenderImpl en tant que bean dans le contexte de l'application Spring.

2. Configuration

1. pom.xml

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

2. application.yml

spring:
  mail:
    host: smtp.163.com
    port: 25
    username: 159****2662@163.com
    password: ***********

L'attribut hôte par défaut. est l'hôte de la session JavaMail ; le port port écoute le port SMTP standard 25 par défaut ; si le serveur de messagerie nécessite une authentification, le nom d'utilisateur et le mot de passe doivent être définis.

Ici, j'utilise le serveur de messagerie 163. Je dois activer le mot de passe d'autorisation client dans la boîte aux lettres 163, sinon une erreur d'authentification 550 sera signalée.

3. EmailConfig.java

Ici, nous assemblons JavaMailSenderImpl en tant que Bean du contexte d'application Spring. Dans le même temps, il convient de noter que l'annotation @ConfigurationProperties est utilisée ici. Cette annotation nécessite que la propriété ait une méthode setter et l'annotation @EnableConfigurationProperties est utilisée dans la classe de démarrage pour la rendre efficace.

@Configuration
@ConfigurationProperties(prefix = "spring.mail")
public class EmailConfig {
    private String host;
    private Integer port;
    private String username;
    private String password;
    @Bean
    public MailSender javaMailSender() {
        JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
        javaMailSender.setHost(host);
        javaMailSender.setPort(port);
        javaMailSender.setUsername(username);
        javaMailSender.setPassword(password);
        return javaMailSender;
    }
    public void setHost(String host) {
        this.host = host;
    }
    public void setPort(Integer port) {
        this.port = port;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public void setPassword(String password) {
        this.password = password;
    }
}

3. Envoi

Avec javaMailSender, l'envoi d'e-mails est simple. Il nous suffit d'injecter le javaMailSender Bean dans notre propre classe d'implémentation, puis d'utiliser l'API JavaMail pour envoyer un e-mail.

1. Envoi d'e-mails texte

public void sendSimpleEmail() {
    // 构造Email消息
    SimpleMailMessage message = new SimpleMailMessage();
    message.setFrom("159****2662@163.com");
    message.setTo("****@qianxx.com");
    message.setSubject("邮件主题");
    message.setText("邮件内容");
    javaMailSender.send(message);
}

L'e-mail en texte brut consiste à construire une instance SimpleMailMessage. Cet objet peut facilement envoyer des e-mails.

2. Envoi de pièces jointes par e-mail

La fonction Email de Spring ne se limite pas aux e-mails en texte brut. Nous pouvons également ajouter des pièces jointes. Si vous souhaitez envoyer un e-mail avec une pièce jointe, l'astuce consiste à créer Message de type en plusieurs parties————L'e-mail se compose de plusieurs parties, une partie est le corps de l'e-mail et les autres parties sont des pièces jointes. Pour envoyer en plusieurs parties type d'e-mail, vous devez créer un message MIME (MultiPurpose Internet Mail Extensions).

public void mimeEmail() throws MessagingException {
    // MimeMessage 本身的 API 有些笨重，我们可以使用 MimeMessageHelper
    MimeMessage mimeMessage = javaMailSender.createMimeMessage();
    // 第二个参数是 true ，表明这个消息是 multipart类型的/
    MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
    mimeMessageHelper.setFrom("159****2662@163.com");
    mimeMessageHelper.setTo("****@qianxx.com");
    mimeMessageHelper.setSubject("附件邮件主题");
    mimeMessageHelper.setText("附件邮件内容");
    //添加附件,第一个参数表示添加到 Email 中附件的名称，第二个参数是图片资源
    mimeMessageHelper.addAttachment("boot.png", new ClassPathResource("public/images/boot.png"));
    javaMailSender.send(mimeMessage);
}

3. Envoi d'e-mails en texte enrichi

En plus d'ajouter des pièces jointes, la fonction Email de Spring peut même utiliser du HTML pour embellir le contenu du corps du message. Envoi d'e-mails en texte enrichi ou envoi d'e-mails en texte simple Le courrier électronique n'est pas très différent, la clé est de définir le texte du message de la méthode setText() sur HTML et de définir le deuxième paramètre sur true, indiquant qu'il s'agit de HTML. de texte riche.

public void htmlEmail() throws MessagingException {
    MimeMessage mimeMessage = javaMailSender.createMimeMessage();
    MimeMessageHelper mimeMessageHelper = new MimeMessageHelper(mimeMessage, true);
    mimeMessageHelper.setFrom("159****2662@163.com");
    mimeMessageHelper.setTo("****@qianxx.com");
    mimeMessageHelper.setSubject("富文本邮件主题");
    String html = "<html><body><h4 id="Hello-SpringBoot">Hello,SpringBoot</h4><img  src=&#39;cid:boot&#39; / alt="Explication détaillée du service de messagerie intégré dans SpringBoot (avec code)" ></body></html>";
    mimeMessageHelper.setText(html, true);
    // 设置内嵌元素 cid，第一个参数表示内联图片的标识符，第二个参数标识资源引用
    mimeMessageHelper.addInline("boot", new ClassPathResource("public/images/boot.png"));
    javaMailSender.send(mimeMessage);
}

4. Conclusion

L'épissage de chaînes de balises HTML est une chose très délicate. Parce qu'il est difficile d'analyser les balises HTML dans votre esprit et d'imaginer à quoi elles ressembleront une fois rendues. Mélanger du HTML avec du code Java complique encore le problème.

La solution proposée par Spring consiste donc à utiliser des modèles pour générer des e-mails. Il existe une variété de solutions de modèles parmi lesquelles choisir, notamment Apache Velocity et Thymeleaf. (Comme je ne suis pas très doué avec ces deux syntaxes de modèles, je ne les présenterai pas en détail).

Code source de la démo : https://github.com/JMCuixy/Boot

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!