upgrade email article, move to spring-mvc-simple

spring-mvc-simple/README.md

@@ -5,3 +5,4 @@
 - [Spring 5 and Servlet 4 – The PushBuilder](http://www.baeldung.com/spring-5-push)
 - [Servlet Redirect vs Forward](http://www.baeldung.com/servlet-redirect-forward)
 - [Apache Tiles Integration with Spring MVC](http://www.baeldung.com/spring-mvc-apache-tiles)
+- [Guide to Spring Email](http://www.baeldung.com/spring-email)

spring-mvc-simple/pom.xml

@@ -20,6 +20,15 @@
             <artifactId>spring-oxm</artifactId>
             <version>${spring-oxm.version}</version>
         </dependency>
+        <dependency>
+    <groupId>org.springframework</groupId>
+    <artifactId>spring-context-support</artifactId>
+</dependency>
+<dependency>
+    <groupId>com.sun.mail</groupId>
+    <artifactId>javax.mail</artifactId>
+    <version>1.6.1</version>
+</dependency>
         <dependency>
             <groupId>javax.servlet</groupId>
             <artifactId>javax.servlet-api</artifactId>
@@ -171,7 +180,7 @@
         <jstl.version>1.2</jstl.version>
         <javax.servlet.jsp-api.version>2.3.2-b02</javax.servlet.jsp-api.version>
         <javax.servlet-api.version>4.0.0</javax.servlet-api.version>
-        <hibernate-validator.version>5.4.1.Final</hibernate-validator.version>
+        <hibernate-validator.version>6.0.10.Final</hibernate-validator.version>
         <deploy-path>enter-location-of-server</deploy-path>
         <fileupload.version>1.3.2</fileupload.version>
         <java.version>1.8</java.version>

spring-mvc-simple/src/main/java/com/baeldung/spring/configuration/ApplicationConfiguration.java

@@ -8,6 +8,9 @@ import org.springframework.context.annotation.Configuration;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.http.converter.StringHttpMessageConverter;
 import org.springframework.http.converter.feed.RssChannelHttpMessageConverter;
+import org.springframework.mail.SimpleMailMessage;
+import org.springframework.mail.javamail.JavaMailSender;
+import org.springframework.mail.javamail.JavaMailSenderImpl;
 import org.springframework.web.accept.ContentNegotiationManager;
 import org.springframework.web.multipart.MultipartResolver;
 import org.springframework.web.multipart.commons.CommonsMultipartResolver;
@@ -20,10 +23,11 @@ import org.springframework.web.servlet.view.InternalResourceViewResolver;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Properties;
 
 @Configuration
 @EnableWebMvc
-@ComponentScan(basePackages = { "com.baeldung.springmvcforms", "com.baeldung.spring.controller", "com.baeldung.spring.validator" })
+@ComponentScan(basePackages = { "com.baeldung.springmvcforms", "com.baeldung.spring.controller", "com.baeldung.spring.validator", "com.baeldung.spring.mail" })
 public class ApplicationConfiguration implements WebMvcConfigurer {
 
     @Override
@@ -60,4 +64,29 @@ public class ApplicationConfiguration implements WebMvcConfigurer {
         converters.add(new RssChannelHttpMessageConverter());
         converters.add(new JsonChannelHttpMessageConverter());
     }
+    
+    @Bean
+    public SimpleMailMessage templateSimpleMessage() {
+        SimpleMailMessage message = new SimpleMailMessage();
+        message.setText("This is the test email template for your email:\n%s\n");
+        return message;
+    }
+    
+    @Bean
+    public JavaMailSender getJavaMailSender() {
+        JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
+        mailSender.setHost("smtp.gmail.com");
+        mailSender.setPort(587);
+        
+        mailSender.setUsername("my.gmail@gmail.com");
+        mailSender.setPassword("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;
+    }
 }

spring-mvc-simple/src/main/java/com/baeldung/spring/controller/MailController.java

@@ -0,0 +1,132 @@
+package com.baeldung.spring.controller;
+
+import com.baeldung.spring.mail.EmailServiceImpl;
+import com.baeldung.spring.domain.MailObject;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.mail.SimpleMailMessage;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.validation.Errors;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.validation.Valid;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Set;
+
+@Controller
+@RequestMapping("/mail")
+public class MailController {
+
+    @Autowired
+    public EmailServiceImpl emailService;
+
+    @Value("${attachment.invoice}")
+    private String attachmentPath;
+
+    @Autowired
+    public SimpleMailMessage template;
+
+    private static final Map<String, Map<String, String>> labels;
+
+    static {
+        labels = new HashMap<>();
+
+        //Simple email
+        Map<String, String> props = new HashMap<>();
+        props.put("headerText", "Send Simple Email");
+        props.put("messageLabel", "Message");
+        props.put("additionalInfo", "");
+        labels.put("send", props);
+
+        //Email with template
+        props = new HashMap<>();
+        props.put("headerText", "Send Email Using Template");
+        props.put("messageLabel", "Template Parameter");
+        props.put("additionalInfo",
+                "The parameter value will be added to the following message template:<br>" +
+                        "<b>This is the test email template for your email:<br>'Template Parameter'</b>"
+        );
+        labels.put("sendTemplate", props);
+
+        //Email with attachment
+        props = new HashMap<>();
+        props.put("headerText", "Send Email With Attachment");
+        props.put("messageLabel", "Message");
+        props.put("additionalInfo", "To make sure that you send an attachment with this email, change the value for the 'attachment.invoice' in the application.properties file to the path to the attachment.");
+        labels.put("sendAttachment", props);
+    }
+    
+    @RequestMapping(method = RequestMethod.GET)
+    public String showEmailsPage() {
+        return "emails";
+    }
+
+    @RequestMapping(value = {"/send", "/sendTemplate", "/sendAttachment"}, method = RequestMethod.GET)
+    public String createMail(Model model,
+                             HttpServletRequest request) {
+        String action = request.getRequestURL().substring(
+                request.getRequestURL().lastIndexOf("/") + 1
+        );
+        Map<String, String> props = labels.get(action);
+        Set<String> keys = props.keySet();
+        Iterator<String> iterator = keys.iterator();
+        while (iterator.hasNext()) {
+            String key = iterator.next();
+            model.addAttribute(key, props.get(key));
+        }
+
+        model.addAttribute("mailObject", new MailObject());
+        return "mail/send";
+    }
+
+    @RequestMapping(value = "/send", method = RequestMethod.POST)
+    public String createMail(Model model,
+                             @ModelAttribute("mailObject") @Valid MailObject mailObject,
+                             Errors errors) {
+        if (errors.hasErrors()) {
+            return "mail/send";
+        }
+        emailService.sendSimpleMessage(mailObject.getTo(),
+                mailObject.getSubject(), mailObject.getText());
+
+        return "redirect:/home";
+    }
+
+    @RequestMapping(value = "/sendTemplate", method = RequestMethod.POST)
+    public String createMailWithTemplate(Model model,
+                             @ModelAttribute("mailObject") @Valid MailObject mailObject,
+                             Errors errors) {
+        if (errors.hasErrors()) {
+            return "mail/send";
+        }
+        emailService.sendSimpleMessageUsingTemplate(mailObject.getTo(),
+                mailObject.getSubject(),
+                template,
+                mailObject.getText());
+
+        return "redirect:/home";
+    }
+
+    @RequestMapping(value = "/sendAttachment", method = RequestMethod.POST)
+    public String createMailWithAttachment(Model model,
+                             @ModelAttribute("mailObject") @Valid MailObject mailObject,
+                             Errors errors) {
+        if (errors.hasErrors()) {
+            return "mail/send";
+        }
+        emailService.sendMessageWithAttachment(
+                mailObject.getTo(),
+                mailObject.getSubject(),
+                mailObject.getText(),
+                attachmentPath
+        );
+
+        return "redirect:/home";
+    }
+}

spring-mvc-simple/src/main/java/com/baeldung/spring/domain/MailObject.java

@@ -0,0 +1,41 @@
+package com.baeldung.spring.domain;
+
+import javax.validation.constraints.Email;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Size;
+
+/**
+ * Created by Olga on 7/20/2016.
+ */
+public class MailObject {
+    @Email
+    @NotNull
+    @Size(min = 1, message = "Please, set an email address to send the message to it")
+    private String to;
+    private String subject;
+    private String text;
+
+    public String getTo() {
+        return to;
+    }
+
+    public void setTo(String to) {
+        this.to = to;
+    }
+
+    public String getSubject() {
+        return subject;
+    }
+
+    public void setSubject(String subject) {
+        this.subject = subject;
+    }
+
+    public String getText() {
+        return text;
+    }
+
+    public void setText(String text) {
+        this.text = text;
+    }
+}

spring-mvc-simple/src/main/java/com/baeldung/spring/mail/EmailService.java

@@ -0,0 +1,20 @@
+package com.baeldung.spring.mail;
+
+import org.springframework.mail.SimpleMailMessage;
+
+/**
+ * Created by Olga on 8/22/2016.
+ */
+public interface EmailService {
+    void sendSimpleMessage(String to,
+                           String subject,
+                           String text);
+    void sendSimpleMessageUsingTemplate(String to,
+                                        String subject,
+                                        SimpleMailMessage template,
+                                        String ...templateArgs);
+    void sendMessageWithAttachment(String to,
+                                   String subject,
+                                   String text,
+                                   String pathToAttachment);
+}

spring-mvc-simple/src/main/java/com/baeldung/spring/mail/EmailServiceImpl.java

@@ -0,0 +1,69 @@
+package com.baeldung.spring.mail;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.io.FileSystemResource;
+import org.springframework.mail.MailException;
+import org.springframework.mail.SimpleMailMessage;
+import org.springframework.mail.javamail.JavaMailSender;
+import org.springframework.mail.javamail.MimeMessageHelper;
+import org.springframework.stereotype.Component;
+
+import java.io.File;
+
+import javax.mail.MessagingException;
+import javax.mail.internet.MimeMessage;
+
+/**
+ * Created by Olga on 7/15/2016.
+ */
+@Component
+public class EmailServiceImpl implements EmailService {
+
+    @Autowired
+    public JavaMailSender emailSender;
+
+    public void sendSimpleMessage(String to, String subject, String text) {
+        try {
+            SimpleMailMessage message = new SimpleMailMessage();
+            message.setTo(to);
+            message.setSubject(subject);
+            message.setText(text);
+
+            emailSender.send(message);
+        } catch (MailException exception) {
+            exception.printStackTrace();
+        }
+    }
+
+    @Override
+    public void sendSimpleMessageUsingTemplate(String to,
+                                               String subject,
+                                               SimpleMailMessage template,
+                                               String ...templateArgs) {
+        String text = String.format(template.getText(), templateArgs);  
+        sendSimpleMessage(to, subject, text);
+    }
+
+    @Override
+    public void sendMessageWithAttachment(String to,
+                                          String subject,
+                                          String text,
+                                          String pathToAttachment) {
+        try {
+            MimeMessage message = emailSender.createMimeMessage();
+            // pass 'true' to the constructor to create a multipart message
+            MimeMessageHelper helper = new MimeMessageHelper(message, true);
+
+            helper.setTo(to);
+            helper.setSubject(subject);
+            helper.setText(text);
+
+            FileSystemResource file = new FileSystemResource(new File(pathToAttachment));
+            helper.addAttachment("Invoice", file);
+
+            emailSender.send(message);
+        } catch (MessagingException e) {
+            e.printStackTrace();
+        }
+    }
+}

spring-mvc-simple/src/main/resources/application.properties

@@ -0,0 +1,22 @@
+#this property file will have to be loaded explicitly as this is not a Spring Boot project
+
+# Gmail SMTP
+spring.mail.host=smtp.gmail.com
+spring.mail.port=587
+spring.mail.username=username
+spring.mail.password=password
+spring.mail.properties.mail.smtp.auth=true
+spring.mail.properties.mail.smtp.starttls.enable=true
+
+# Amazon SES SMTP
+#spring.mail.host=email-smtp.us-west-2.amazonaws.com
+#spring.mail.username=username
+#spring.mail.password=password
+#spring.mail.properties.mail.transport.protocol=smtp
+#spring.mail.properties.mail.smtp.port=25
+#spring.mail.properties.mail.smtp.auth=true
+#spring.mail.properties.mail.smtp.starttls.enable=true
+#spring.mail.properties.mail.smtp.starttls.required=true
+
+# path to attachment file
+attachment.invoice=path_to_file

spring-mvc-simple/src/main/webapp/WEB-INF/views/emails.jsp

@@ -0,0 +1,43 @@
+<%--
+  Created by IntelliJ IDEA.
+  User: Olga
+  Date: 1/19/16
+  Time: 3:53 PM
+  To change this template use File | Settings | File Templates.
+--%>
+<%@ page contentType="text/html;charset=UTF-8" language="java" %>
+<%@ taglib prefix="sf" uri="http://www.springframework.org/tags/form" %>
+<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
+<html>
+<head>
+    <title>Home Page</title>
+</head>
+<body>
+    <div>
+        <div>
+            <h4>Select any of the options below to send sample email:</h4>
+            <form method="get" style="width: 200px;">
+                <fieldset style="border: none; padding-left: 0px; padding-top: 0px">
+                    <table>
+                        <tr>
+                            <td>
+                                <input type="submit" formaction="mail/send" value="Send Simple Email">
+                            </td>
+                        </tr>
+                        <tr>
+                            <td>
+                                <input type="submit" formaction="mail/sendTemplate" value="Send Email Using Template">
+                            </td>
+                        </tr>
+                        <tr>
+                            <td>
+                                <input type="submit" formaction="mail/sendAttachment" value="Send Email With Attachment">
+                            </td>
+                        </tr>
+                    </table>
+                </fieldset>
+            </form>
+        </div>
+    </div>
+</body>
+</html>

spring-mvc-simple/src/main/webapp/WEB-INF/views/mail/send.jsp

@@ -0,0 +1,58 @@
+<%--
+  Created by IntelliJ IDEA.
+  User: Olga
+  Date: 7/20/2016
+  Time: 1:47 PM
+  To change this template use File | Settings | File Templates.
+--%>
+<%@ page contentType="text/html;charset=UTF-8" language="java" %>
+<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
+<html>
+<head>
+    <title>Send Email</title>
+</head>
+<body>
+    <div>
+        <h3>${headerText}</h3>
+        <form:form method="POST" modelAttribute="mailObject" >
+            <fieldset>
+                <div style="float:left;">
+                    <table cellspacing="0" width="300">
+                        <tr>
+                            <th><label for="input_to">To</label></th>
+                            <td><form:input path="to" id="input_to" type="email"/>
+                                <small>Enter email address</small><br/>
+                                <form:errors path="to" cssStyle="color:red;font-size:small"/>
+                            </td>
+                        </tr>
+                        <tr>
+                            <th><label for="input_subject">Subject</label></th>
+                            <td><form:input path="subject" id="input_subject"/>
+                                <small>Enter the subject</small><br/>
+                                <form:errors path="subject" cssStyle="color:red;font-size:small"/>
+                            </td>
+                        </tr>
+                        <tr>
+                            <th><label for="input_text">${messageLabel}:</label></th>
+                            <td><form:textarea path="text"
+                                             rows="5" cols="50"
+                                             id="input_text"/>
+                                <form:errors path="text" cssStyle="color:red;font-size:small"/>
+                            </td>
+                        </tr>
+                        <tr>
+                            <th></th>
+                            <td>
+                                <input type="submit" value="Send">
+                            </td>
+                        </tr>
+                    </table>
+                </div>
+                <div style="float:left; word-wrap: break-word; margin-left: 50px; width: 400px; color: grey">
+                    ${additionalInfo}
+                </div>
+            </fieldset>
+        </form:form>
+    </div>
+</body>
+</html>