Spring整合freemarker发送邮件

最新推荐文章于 2023-12-28 13:19:57 发布
最新推荐文章于 2023-12-28 13:19:57 发布
阅读量1.3k 收藏 2
点赞数
分类专栏： spring
本文介绍如何使用Spring、JavaMail和Freemarker实现带附件及内嵌图片的HTML格式邮件发送，包括环境搭建、代码实现及单元测试。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >


原文  http://blog.youkuaiyun.com/zdp072/article/details/32745335

一. 背景知识

在上一篇博文: 使用JavaMail发送邮件和接受邮件, 我们学习了原生的JavaApi发送邮件, 我们会发现代码比较多, 特别是当邮件内容很丰富的时候, 我们需要在Java中拼装Html, 是不是觉得非常麻烦. 

下面我们使用一种比较简单的方法: spring + javaMail + freemarker, 使用freemarker模板引擎后, 我们就不用再在Java中拼装html.


二. 环境准备

废话不多说了, 下面我们准备下开发环境:

1. 所需Jar包:

spring.jar(2.5), commons-logging.jar, mail.jar, freemarker.jar, spring-webmvc.jar, activation.jar

2. 安装易邮邮件服务器, 这个我们在上一篇博文中有讲过, 这里就不再赘述.

3. D盘中放一张图片 "welcome.gif" 和一个word文件 "欢迎注册.docx" 以填充邮件内容.


三. 代码实现

1. 代码结构图如下:



2. 实体Bean:

[java] view plain copy print ? 在CODE上查看代码片 派生到我的代码片
  1. /** 
  2.  * 用户对象 
  3.  */  
  4. public class User {  
  5.     private String username;  
  6.     private String password;  
  7.   
  8.     public String getUsername() {  
  9.         return username;  
  10.     }  
  11.   
  12.     public void setUsername(String username) {  
  13.         this.username = username;  
  14.     }  
  15.   
  16.     public String getPassword() {  
  17.         return password;  
  18.     }  
  19.   
  20.     public void setPassword(String password) {  
  21.         this.password = password;  
  22.     }  
  23. }  
/**
 * 用户对象
 */
public class User {
	private String username;
	private String password;

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	public String getPassword() {
		return password;
	}

	public void setPassword(String password) {
		this.password = password;
	}
}

2. 发邮件业务接口

[java] view plain copy print ? 在CODE上查看代码片 派生到我的代码片
  1. public interface EmailService {  
  2.     public void sendEmail(User user);  
  3. }  
public interface EmailService {
	public void sendEmail(User user);
}

3. 发邮件实现

[java] view plain copy print ? 在CODE上查看代码片 派生到我的代码片
  1. public class EmailServiceImpl implements EmailService {  
  2.   
  3.     private JavaMailSender mailSender;  
  4.     private FreeMarkerConfigurer freeMarkerConfigurer;   
  5.     private static final String ENCODING = "utf-8";  
  6.   
  7.     public void setMailSender(JavaMailSender mailSender) {  
  8.         this.mailSender = mailSender;  
  9.     }  
  10.   
  11.     public void setFreeMarkerConfigurer(FreeMarkerConfigurer freeMarkerConfigurer) {  
  12.         this.freeMarkerConfigurer = freeMarkerConfigurer;  
  13.     }  
  14.       
  15.   
  16.     /** 
  17.      * 发送带附件的html格式邮件 
  18.      */  
  19.     public void sendEmail(User user) {  
  20.         MimeMessage msg = null;  
  21.         try {  
  22.             msg = mailSender.createMimeMessage();  
  23.             MimeMessageHelper helper = new MimeMessageHelper(msg, true, ENCODING);  
  24.             helper.setFrom("service@estore.com");  
  25.             helper.setTo("zhangsan@estore.com");  
  26.             helper.setSubject(MimeUtility.encodeText("estore注册成功提示邮件", ENCODING, "B"));  
  27.             helper.setText(getMailText(user), true); // true表示text的内容为html  
  28.               
  29.             // 添加内嵌文件，第1个参数为cid标识这个文件,第2个参数为资源  
  30.             helper.addInline("welcomePic", new File("d:/welcome.gif")); // 附件内容  
  31.               
  32.             // 这里的方法调用和插入图片是不同的，解决附件名称的中文问题  
  33.             File file = new File("d:/欢迎注册.docx");  
  34.             helper.addAttachment(MimeUtility.encodeWord(file.getName()), file);  
  35.         } catch (Exception e) {  
  36.             throw new RuntimeException("error happens", e);  
  37.         }   
  38.         mailSender.send(msg);  
  39.         System.out.println("邮件发送成功...");  
  40.     }  
  41.   
  42.     /** 
  43.      * 通过模板构造邮件内容，参数content将替换模板文件中的${content}标签。 
  44.      */  
  45.     private String getMailText(User user) throws Exception {  
  46.         // 通过指定模板名获取FreeMarker模板实例  
  47.         Template template = freeMarkerConfigurer.getConfiguration().getTemplate("registe.html");   
  48.           
  49.         // FreeMarker通过Map传递动态数据  
  50.         Map<String, String> map = new HashMap<String, String>();   
  51.         map.put("username", user.getUsername()); // 注意动态数据的key和模板标签中指定的属性相匹配  
  52.         map.put("password", user.getPassword());  
  53.           
  54.         // 解析模板并替换动态数据，最终content将替换模板文件中的${content}标签。  
  55.         String htmlText = FreeMarkerTemplateUtils.processTemplateIntoString(template, map);  
  56.         return htmlText;  
  57.     }  
  58. }  
public class EmailServiceImpl implements EmailService {

	private JavaMailSender mailSender;
	private FreeMarkerConfigurer freeMarkerConfigurer; 
	private static final String ENCODING = "utf-8";

	public void setMailSender(JavaMailSender mailSender) {
        this.mailSender = mailSender;
    }

	public void setFreeMarkerConfigurer(FreeMarkerConfigurer freeMarkerConfigurer) {
		this.freeMarkerConfigurer = freeMarkerConfigurer;
	}
	

	/**
	 * 发送带附件的html格式邮件
	 */
	public void sendEmail(User user) {
		MimeMessage msg = null;
		try {
			msg = mailSender.createMimeMessage();
			MimeMessageHelper helper = new MimeMessageHelper(msg, true, ENCODING);
			helper.setFrom("service@estore.com");
			helper.setTo("zhangsan@estore.com");
			helper.setSubject(MimeUtility.encodeText("estore注册成功提示邮件", ENCODING, "B"));
			helper.setText(getMailText(user), true); // true表示text的内容为html
			
			// 添加内嵌文件，第1个参数为cid标识这个文件,第2个参数为资源
			helper.addInline("welcomePic", new File("d:/welcome.gif")); // 附件内容
			
			// 这里的方法调用和插入图片是不同的，解决附件名称的中文问题
			File file = new File("d:/欢迎注册.docx");
			helper.addAttachment(MimeUtility.encodeWord(file.getName()), file);
		} catch (Exception e) {
			throw new RuntimeException("error happens", e);
		} 
		mailSender.send(msg);
		System.out.println("邮件发送成功...");
	}

	/**
	 * 通过模板构造邮件内容，参数content将替换模板文件中的${content}标签。
	 */
	private String getMailText(User user) throws Exception {
		// 通过指定模板名获取FreeMarker模板实例
		Template template = freeMarkerConfigurer.getConfiguration().getTemplate("registe.html"); 
		
		// FreeMarker通过Map传递动态数据
		Map<String, String> map = new HashMap<String, String>(); 
		map.put("username", user.getUsername()); // 注意动态数据的key和模板标签中指定的属性相匹配
		map.put("password", user.getPassword());
		
		// 解析模板并替换动态数据，最终content将替换模板文件中的${content}标签。
		String htmlText = FreeMarkerTemplateUtils.processTemplateIntoString(template, map);
		return htmlText;
	}
}

解决名字乱码问题使用：MimeUtility.encodeText(name, "UTF-8", "B")
因为Email的规范，在smtp传输中不可使用中文字符。所以可以使用内置类的MimeUtility方法encodeText将收件人、发件人名字编码即可。

编码方式有两种："B"代表Base64、"Q"代表QP（quoted-printable）方式。


注意：

1. 不能将名字和email地址一起编码，如直接编码 "Name " 后当做收件人就会出错。

2. Mail的Subject和Content不需要我们显式的编码，在Set的时候这两项会被javax.mail自动编码。


4. spring核心配置

[html] view plain copy print ? 在CODE上查看代码片 派生到我的代码片
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <beans xmlns="http://www.springframework.org/schema/beans"  
  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"  
  4.     xmlns:tx="http://www.springframework.org/schema/tx"  
  5.     xsi:schemaLocation="http://www.springframework.org/schema/beans   
  6.     http://www.springframework.org/schema/beans/spring-beans-2.5.xsd  
  7.     http://www.springframework.org/schema/aop   
  8.     http://www.springframework.org/schema/aop/spring-aop-2.5.xsd  
  9.     http://www.springframework.org/schema/tx   
  10.     http://www.springframework.org/schema/tx/spring-tx-2.5.xsd">  
  11.               
  12.     <bean id="freeMarker" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">  
  13.         <property name="templateLoaderPath" value="classpath:" /> <!-- 指定模板文件目录  -->  
  14.         <property name="freemarkerSettings"><!-- 设置FreeMarker环境属性 -->  
  15.             <props>  
  16.                 <prop key="template_update_delay">1800</prop> <!--刷新模板的周期，单位为秒 -->  
  17.                 <prop key="default_encoding">UTF-8</prop> <!--模板的编码格式 -->  
  18.                 <prop key="locale">zh_CN</prop> <!--本地化设置-->  
  19.             </props>  
  20.         </property>  
  21.     </bean>  
  22.   
  23.     <!-- 注意:这里的参数(如用户名、密码)都是针对邮件发送者的 -->  
  24.     <bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">  
  25.         <property name="host">    
  26.             <value>localhost</value>    
  27.         </property>    
  28.         <property name="javaMailProperties">    
  29.             <props>    
  30.                 <prop key="mail.smtp.auth">true</prop>    
  31.                 <prop key="mail.smtp.timeout">25000</prop>    
  32.             </props>    
  33.         </property>    
  34.         <property name="username">    
  35.             <value>service</value> <!-- 发送者用户名 -->  
  36.         </property>    
  37.         <property name="password">    
  38.             <value>123</value> <!-- 发送者密码 -->  
  39.         </property>   
  40.     </bean>  
  41.       
  42.     <bean id="emailService" class="com.zdp.service.impl.EmailServiceImpl">  
  43.         <property name="mailSender" ref="mailSender"></property>  
  44.         <property name="freeMarkerConfigurer" ref="freeMarker"></property>  
  45.     </bean>  
  46. </beans>      
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="http://www.springframework.org/schema/beans 
	http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
	http://www.springframework.org/schema/aop 
	http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
	http://www.springframework.org/schema/tx 
	http://www.springframework.org/schema/tx/spring-tx-2.5.xsd">
			
	<bean id="freeMarker" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
		<property name="templateLoaderPath" value="classpath:" /> <!-- 指定模板文件目录  -->
		<property name="freemarkerSettings"><!-- 设置FreeMarker环境属性 -->
			<props>
				<prop key="template_update_delay">1800</prop> <!--刷新模板的周期，单位为秒 -->
				<prop key="default_encoding">UTF-8</prop> <!--模板的编码格式 -->
				<prop key="locale">zh_CN</prop> <!--本地化设置-->
			</props>
		</property>
	</bean>

	<!-- 注意:这里的参数(如用户名、密码)都是针对邮件发送者的 -->
	<bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
		<property name="host">  
            <value>localhost</value>  
        </property>  
        <property name="javaMailProperties">  
            <props>  
                <prop key="mail.smtp.auth">true</prop>  
                <prop key="mail.smtp.timeout">25000</prop>  
            </props>  
        </property>  
        <property name="username">  
            <value>service</value> <!-- 发送者用户名 -->
        </property>  
        <property name="password">  
            <value>123</value> <!-- 发送者密码 -->
        </property> 
	</bean>
	
	<bean id="emailService" class="com.zdp.service.impl.EmailServiceImpl">
		<property name="mailSender" ref="mailSender"></property>
		<property name="freeMarkerConfigurer" ref="freeMarker"></property>
	</bean>
</beans>

5. 模板文件:

[html] view plain copy print ? 在CODE上查看代码片 派生到我的代码片
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">  
  2. <html>    
  3.    <head>    
  4.       <meta http-equiv="content-type" content="text/html;charset=utf8">    
  5.    </head>    
  6.    <body>    
  7.             恭喜您成功注册estore！<br/>  
  8.             您的用户名为：<font color='red' size='20'>${username}</font>,    
  9.             您的密码为：<font color='red' size='20'>${password}</font>  <img src='cid:welcomePic'/>  
  10.    </body>    
  11. </html>   
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>  
   <head>  
      <meta http-equiv="content-type" content="text/html;charset=utf8">  
   </head>  
   <body>  
        	恭喜您成功注册estore！<br/>
        	您的用户名为：<font color='red' size='20'>${username}</font>,  
        	您的密码为：<font color='red' size='20'>${password}</font>  <img src='cid:welcomePic'/>
   </body>  
</html>

6. 单元测试:

[java] view plain copy print ? 在CODE上查看代码片 派生到我的代码片
  1. public class EmailServiceImplTest {  
  2.     @Test  
  3.     public void testSendEmail() {  
  4.         ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");  
  5.         EmailService emailService = (EmailService) context.getBean("emailService");  
  6.         User user = new User();  
  7.         user.setUsername("zhangsan");  
  8.         user.setPassword("123");  
  9.         emailService.sendEmail(user);  
  10.     }  
  11. }  
public class EmailServiceImplTest {
	@Test
	public void testSendEmail() {
		ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
		EmailService emailService = (EmailService) context.getBean("emailService");
		User user = new User();
		user.setUsername("zhangsan");
		user.setPassword("123");
		emailService.sendEmail(user);
	}
}

7. 效果图如下:



8. 源码下载地址: http://download.youkuaiyun.com/detail/zdp072/7529157


SpringBoot使用FreeMarker模板发送邮件
05-23
通过springboot 整合freemarker模板引擎，自动发送html格式邮件
使用FreeMarker邮件模版来发送邮件
lvdong5830的专栏
01-06 744
使用FreeMarker邮件模版来发送邮件 博客分类：  Spring SpringBeanServletfreemarkerITeye  Spring为FreeMarker提供了一个FreeMarkerConfigurer类，通过此类可方便地创建FreeMarker的基础环境，Spring提供FreeMarkerTemplateUtils工具类来完成解析模板的...
freemarker在邮件发送中使用
你好
04-05 3293
第一步：准备模板（需要填充的值 : ${值名}） 第二步：导入freemarker包 第三步：把模板放到web工程的webinf目录下 并且后缀名改成ftl格式 把html文件改成ftl文件 第四步：配置模板配置 FreeMarkerConfigurer 功能：找到模板的位置 解决乱码问题 //设置模板位置 configurer.setTemplateLoaderPath("/WEB-INF/ftl/"); //设置编码级 configurer.setDefaultEncoding(“utf-8”);
Spring整合Freemarker实现邮件发送服务
qq_27022157的博客
06-17 281
Spring整合Fremarker实现邮件发送服务 最近项目中有发送邮件需求，使用Spring邮件服务实现，由于第一次使用，所以自己编写一个测试demo，并做记录，以下为具体配置及代码。 欢迎使用Markdown编辑器 你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。 新的改变 我们对Markdown编辑器进行了一些功能拓展与语法支持，除了标准的Markdown编辑器功能，我们增加了
spring整合freemarker发送邮件例子
04-26
其中，Spring与Freemarker的整合是用于创建动态HTML模板并发送邮件的一种常见实践。在本案例中，我们将深入探讨如何实现这个功能，包括处理内嵌图片、添加附件以及解决乱码问题。 首先，让我们了解`Freemarker`。...
freemarker发送邮件
..7a.
03-24 2261
发送邮件。jar包版本：freemarker-2.3-16 1.1 action代码： boolean isSuccess = false; boolean successBySend = false; //Container启动时取得config.xml Configuration config = Container.getTemplateConfig();//详细见 2.4 /
利用freemarker发送邮件
11-07
利用freemarker发送邮件利用freemarker发送邮件利用freemarker发送邮件利用freemarker发送邮件利用freemarker发送邮件利用freemarker发送邮件利用freemarker发送邮件
FreeMarker模板实现邮件发送
03-08
1.这是一个在根目录下的mail.properties文件中配好发送邮件地址和接收邮箱地址的实例，利用freeMarker模板作为展示，在测试类中提供配固定接收邮箱地址和手动输入接收邮箱地址两种方法进行发送试验，结果都能实现成功发送。 2.测试本例时要将根目录下mail.properties文件中邮箱地址和密码修改正确，最好选择自己的邮箱地址进行测试。
利用 spring+freemarker 发送邮件
把酒问天专栏
06-09 769
最近公司要用到给注册会员发送邮件的功能，这里采用spring+freemarker模板来发送邮件，其中模板可以自定义，欲了解freemarker请看我写的利用freemarker 静态化网页，里面介绍的很详细和怎么使用。 在做本次试验之前需要spring相关的jar和freemarker.jar ①定义发送邮件的模板 demo.ftl [html] 
利用Freemarker模板引擎发送邮件
一念永恒
10-11 607
一、maven引入jar包 &lt;dependency&gt; &lt;groupId&gt;org.freemarker&lt;/groupId&gt; &lt;artifactId&gt;freemarker&lt;/artifactId&gt; &lt;version&gt;2.3.20&lt;/version&gt; &lt;/dependency&gt; 二
通过FreeMarker模板生成邮件发送EML
最新发布
z69183787的专栏
12-28 1213
java 读取邮件 并生成邮件文件eml，##Java读取邮件并生成邮件文件eml###1.简介Java作为一种广泛使用的编程语言，提供了丰富的API和库，可以方便地实现各种功能。本文将介绍如何使用Java来读取邮件，并将其保存为邮件文件（.eml）。java生成eml文件，#Java生成EML文件的实现##简介EML文件是一种用于电子邮件的标准文件格式，它可以在不同的邮件客户端之间进行互操作。java 读取邮件 并生成邮件文件eml_mob64ca12de24b0的技术博客_51CTO博客。
【项目实战】SpringBoot整合Freemarker模板引擎实现Email邮件发送功能
本本本添哥
03-08 894
微服务项目中，需要集成Freemark，实现定时发送周年祝福邮件给公司雇员
Spring Boot基于FreeMarker发送模板邮件（带附件）
嘉禾嘉宁papa
12-13 9020
spring boot使用freemarker发送模板邮件详细说明（带附件）
SpringBoot整合freemarker、email实现邮件发送
someday____的博客
09-29 1179
第三步：写一个MailClient工具类。第五步：准备一个文件模板。第六步：写一个测试类验证。
Spring发送Mail + freemaker模板
Rico_Yip
04-22 592
除Spring核心依赖，还需添加 &lt;dependency&gt; &lt;groupId&gt;org.springframework&lt;/groupId&gt; &lt;artifactId&gt;spring-context-support&lt;/artifactId&gt; &lt;vers...
Spring与FreeMarker整合发送邮件案例解析
### Spring整合FreeMarker发送邮件的知识点 #### 1. Spring Mail支持 Spring框架通过`spring-context-support`模块提供对邮件发送的支持。具体来说，它利用了JavaMail API进行邮件的发送。在Spring中发送邮件需要...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值