Die Anleitung zu Spring Email

View more categories:

1- Die Überblick über Spring Mail

Spring Framework bringt Ihnen ein  API um Email zu schicken. Es fasst einige Interface und einige Klassen um. Alle sie liegen in 2 Package  org.springframework.mail & org.springframework.mail.javamail.
Um  Spring Mail in der Applikation  Spring Boot zu verwenden, fügen Sie die Abhängigkeit nach  pom.xml ​​​​​​​ein:
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
        http://maven.apache.org/xsd/maven-4.0.0.xsd">
        
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.o7planning</groupId>
    <artifactId>SpringBootMail</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>SpringBootMail</name>
    <description>Spring Boot + Mail</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</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-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
Spring Mail hat auch viele Klassen (oder die Interfaces) nicht. Grundsätzlich ist das unten die Liste von der Hauptsklasse und -Interface:
  1. org.springframework.mail.MailSender
  2. org.springframework.mail.SimpleMailMessage
  3. org.springframework.mail.MailMessage
  4. org.springframework.mail.javamail.JavaMailSender
  5. org.springframework.mail.javamail.JavaMailSenderImpl
  6. org.springframework.mail.javamail.MimeMessagePreparator
  7. org.springframework.mail.javamail.MimeMessageHelper
  8. org.springframework.mail.javamail.MimeMailMessage

MIME (Multi-Purpose Internet Mail Extensions):

MIME (Multi-Purpose Internet Mail Extensions): (Mehrzwecksverbreitung für Internet Mail) Ist eine Verbreitung des ursprünglichen Internet Email . Es erlaubt, die Emails mit der unterschiedlichen Datenstypen auf Internet wie  audio, video, image,.., zu senden und unterstütz die HTMLformate Email .
Class/Interface Die Bezeichnung
MailSender Das ist eine Interface in die höchsten Ebene (top-level), die die Funktion zur Sendung eines einfachen Email zu bieten.
JavaMailSender Das ist eine Sub-Interface vom MailSender. Sie unterstützt die MIME-Typ Email und wird oft mit der Klasse MimeMessageHelper verwendet um MimeMessage zu erstellen. Eine Empfehlung wird gegeben, die Interface  MimeMessagePreparator mit dieser Interface zu verwenden
JavaMailSenderImpl heißt eine Klasse, die die Interface JavaMailSender implementiert. Es unterstützt die Sendung der Nachricht MimeMessage und SimpleMailMessage.
MailMessage Ist eine Interface, die eine einfache Nachricht (message) vertritt. Sie fasst die grundlegende Information eines Email um, wie den Sender, den Empfänger, das Titel und die Inhalt der Nachricht.
SimpleMailMessage Das ist eine Klasse, die die Interface MailMessage implementiert und benutzt wird, um eine einfache Nachricht zu erstellen
MimeMailMessage Das ist eine Klasse, die die Interface MailMessage implementiert und benutzt wird, um eine MIME unterstützende Nachricht zu erstellen.
MimeMessagePreparator Die Interface bietet die aufgerufted Methode callback bei der Vorbereitung einer MIME Nachricht.
MimeMessageHelper Ist eine Hilfsklasse zur Erstellung einer Nachricht MIME, Sie unterstützt image und die beigefügten Files und erstellt die HTMLformate Nachtricht

2- Die Bemerkung für Gmail

In diesem Artikel werde ich ein  Gmail KOnto um die Nachricht zu senden. Denn   Gmail ist ein sehr üblicher  Mail-Server . Allerdings damit Ihr  Gmail Konto ein Email durch die Applikation  Java sendet, sollen Sie  Google sagen um es zu erlauben. OK, zum ersten melden Sie in Ihrem  Gmail Konto auf dem Browser an, dann greifen Sie in die folgende Addresse zu:
Aktivieren Sie zu erlauben, dass Ihr Gmail Konto durch die weniger sichere Applikation (Less Secure Apps) verwendet werden können

3- Spring Mail konfigurieren

In der Applikation  Spring sollen Sie ein  Spring-Bean für  MailSender erstellen. In dem folgenden Beispiel benutze ich ein  Gmail Konto um das Email zu schicken
MailConfig.java
package org.o7planning.sbmail.config;

import java.util.Properties;

import org.o7planning.sbmail.MyConstants;
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 {

    @Bean
    public JavaMailSender getJavaMailSender() {
        JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
        mailSender.setHost("smtp.gmail.com");
        mailSender.setPort(587);

        mailSender.setUsername(MyConstants.MY_EMAIL);
        mailSender.setPassword(MyConstants.MY_PASSWORD);

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

        return mailSender;
    }

}
MyConstants.java
package org.o7planning.sbmail;

public class MyConstants {

    // Replace with your email here:  
    public static final String MY_EMAIL = "[email protected]";

    // Replace password!!
    public static final String MY_PASSWORD = "yourPassword";

    // And receiver!
    public static final String FRIEND_EMAIL = "[email protected]";

}

4- Das Beispiel: Das einface Email schicken

Das ist ein sehr einfaches Beispiel: Ein Email mit der normalen Text schicken
SimpleEmailExampleController.java
package org.o7planning.sbmail.controller;

import org.o7planning.sbmail.MyConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class SimpleEmailExampleController {

    @Autowired
    public JavaMailSender emailSender;

    @ResponseBody
    @RequestMapping("/sendSimpleEmail")
    public String sendSimpleEmail() {

        // Create a Simple MailMessage.
        SimpleMailMessage message = new SimpleMailMessage();
        
        message.setTo(MyConstants.FRIEND_EMAIL);
        message.setSubject("Test Simple Email");
        message.setText("Hello, Im testing Simple Email");

        // Send Message!
        this.emailSender.send(message);

        return "Email Sent!";
    }

}

5- Das Email mit dem eingefügten File schicken

AttachmentEmailExampleController.java
package org.o7planning.sbmail.controller;

import java.io.File;

import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;

import org.o7planning.sbmail.MyConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class AttachmentEmailExampleController {

    @Autowired
    public JavaMailSender emailSender;

    @ResponseBody
    @RequestMapping("/sendAttachmentEmail")
    public String sendAttachmentEmail() throws MessagingException {

        MimeMessage message = emailSender.createMimeMessage();

        boolean multipart = true;

        MimeMessageHelper helper = new MimeMessageHelper(message, multipart);

        helper.setTo(MyConstants.FRIEND_EMAIL);
        helper.setSubject("Test email with attachments");
        
        helper.setText("Hello, Im testing email with attachments!");
        
        String path1 = "/home/tran/Downloads/test.txt";
        String path2 = "/home/tran/Downloads/readme.zip";

        // Attachment 1
        FileSystemResource file1 = new FileSystemResource(new File(path1));
        helper.addAttachment("Txt file", file1);

        // Attachment 2
        FileSystemResource file2 = new FileSystemResource(new File(path2));
        helper.addAttachment("Readme", file2);

        emailSender.send(message);

        return "Email Sent!";
    }

}

6- Das HTMLformate Email schicken

HtmlEmailExampleController.java
package org.o7planning.sbmail.controller;

import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;

import org.o7planning.sbmail.MyConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class HtmlEmailExampleController {

    @Autowired
    public JavaMailSender emailSender;

    @ResponseBody
    @RequestMapping("/sendHtmlEmail")
    public String sendHtmlEmail() throws MessagingException {

        MimeMessage message = emailSender.createMimeMessage();

        boolean multipart = true;
        
        MimeMessageHelper helper = new MimeMessageHelper(message, multipart, "utf-8");
        
        String htmlMsg = "<h3>Im testing send a HTML email</h3>"
                +"<img src='http://www.apache.org/images/asf_logo_wide.gif'>";
        
        message.setContent(htmlMsg, "text/html");
        
        helper.setTo(MyConstants.FRIEND_EMAIL);
        
        helper.setSubject("Test send HTML email");
        
    
        this.emailSender.send(message);

        return "Email Sent!";
    }

}

View more categories: