电子邮件

本节介绍如何使用 Spring 框架发送电子邮件。spring-doc.cadn.net.cn

库依赖项

以下 JAR 需要位于您应用程序的类路径中,以便使用 Spring Framework 的电子邮件支持:spring-doc.cadn.net.cn

此库可在网络上免费获得 — 例如,在Maven Central中作为 org.eclipse.angus:angus-mailspring-doc.cadn.net.cn

Spring框架提供了一个有助于发送电子邮件的实用工具库,它使您免于处理底层邮件系统的细节,并代表客户端负责低级别的资源管理。spring-doc.cadn.net.cn

org.springframework.mail 包是 Spring 框架电子邮件支持的根级包。发送电子邮件的核心接口是 MailSender 接口。一个简单的值对象,用于封装简单邮件的属性,如 fromto(以及许多其他属性)的是 SimpleMailMessage 类。此包还包含一组检查异常,这些异常为底层邮件系统异常提供了更高层次的抽象,根异常是 MailException。有关丰富的邮件异常层次结构的更多信息,请参阅 javadocspring-doc.cadn.net.cn

The org.springframework.mail.javamail.JavaMailSender interface adds specialized JavaMail features, such as MIME message support to the MailSender interface (from which it inherits). JavaMailSender also provides a callback interface called org.springframework.mail.javamail.MimeMessagePreparator for preparing a MimeMessage.spring-doc.cadn.net.cn

用法

假设我们有一个名为 OrderManager 的业务接口,如下例所示:spring-doc.cadn.net.cn

public interface OrderManager {

	void placeOrder(Order order);
}
interface OrderManager {

	fun placeOrder(order: Order)
}

进一步假设我们有一个需求,即需要生成并发送一封包含订单号的电子邮件给下此订单的客户。spring-doc.cadn.net.cn

基础 MailSenderSimpleMailMessage 用法

以下示例显示了如何使用 MailSenderSimpleMailMessage 在有人下订单时发送电子邮件:spring-doc.cadn.net.cn

public class SimpleOrderManager implements OrderManager {

	private MailSender mailSender;
	private SimpleMailMessage templateMessage;

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

	public void setTemplateMessage(SimpleMailMessage templateMessage) {
		this.templateMessage = templateMessage;
	}

	@Override
	public void placeOrder(Order order) {

		// Do the business calculations...

		// Call the collaborators to persist the order...

		// Create a thread-safe "copy" of the template message and customize it
		SimpleMailMessage msg = new SimpleMailMessage(this.templateMessage);
		msg.setTo(order.getCustomer().getEmailAddress());
		msg.setText(
				"Dear " + order.getCustomer().getFirstName()
						+ order.getCustomer().getLastName()
						+ ", thank you for placing order. Your order number is "
						+ order.getOrderNumber());
		try {
			this.mailSender.send(msg);
		}
		catch (MailException ex) {
			// simply log it and go on...
			System.err.println(ex.getMessage());
		}
	}

}
class SimpleOrderManager : OrderManager {

	lateinit var mailSender: MailSender
	lateinit var templateMessage: SimpleMailMessage

	override fun placeOrder(order: Order) {
		// Do the business calculations...

		// Call the collaborators to persist the order...

		// Create a thread-safe "copy" of the template message and customize it

		val msg = SimpleMailMessage(this.templateMessage)
		msg.setTo(order.customer.emailAddress)
		msg.text = ("Dear " + order.customer.firstName
				+ order.customer.lastName
				+ ", thank you for placing order. Your order number is "
				+ order.orderNumber)
		try {
			mailSender.send(msg)
		} catch (ex: MailException) {
			// simply log it and go on...
			System.err.println(ex.message)
		}
	}
}

以下示例显示了前面代码的bean定义:spring-doc.cadn.net.cn

@Bean
JavaMailSender mailSender() {
	JavaMailSenderImpl mailSender = new JavaMailSenderImpl();
	mailSender.setHost("mail.mycompany.example");
	return mailSender;
}

@Bean // this is a template message that we can pre-load with default state
SimpleMailMessage templateMessage() {
	SimpleMailMessage message = new SimpleMailMessage();
	message.setFrom("[email protected]");
	message.setSubject("Your order");
	return message;
}

@Bean
SimpleOrderManager orderManager(JavaMailSender mailSender, SimpleMailMessage templateMessage) {
	SimpleOrderManager orderManager = new SimpleOrderManager();
	orderManager.setMailSender(mailSender);
	orderManager.setTemplateMessage(templateMessage);
	return orderManager;
}
@Bean
fun mailSender(): JavaMailSender {
	return JavaMailSenderImpl().apply {
		host = "mail.mycompany.example"
	}
}

@Bean // this is a template message that we can pre-load with default state
fun templateMessage() = SimpleMailMessage().apply {
	from = "[email protected]"
	subject = "Your order"
}


@Bean
fun orderManager(javaMailSender: JavaMailSender, simpleTemplateMessage: SimpleMailMessage) = SimpleOrderManager().apply {
	mailSender = javaMailSender
	templateMessage = simpleTemplateMessage
}
<bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
	<property name="host" value="mail.mycompany.example"/>
</bean>

<!-- this is a template message that we can pre-load with default state -->
<bean id="templateMessage" class="org.springframework.mail.SimpleMailMessage">
	<property name="from" value="[email protected]"/>
	<property name="subject" value="Your order"/>
</bean>

<bean id="orderManager" class="com.mycompany.businessapp.support.SimpleOrderManager">
	<property name="mailSender" ref="mailSender"/>
	<property name="templateMessage" ref="templateMessage"/>
</bean>

使用 JavaMailSenderMimeMessagePreparator

本节描述了另一种使用OrderManager的实现,该实现使用了MimeMessagePreparator回调接口。在下面的例子中,mailSender属性的类型为JavaMailSender,以便我们可以使用JavaMail MimeMessage类:spring-doc.cadn.net.cn

import jakarta.mail.Message;
import jakarta.mail.MessagingException;
import jakarta.mail.internet.InternetAddress;
import jakarta.mail.internet.MimeMessage;

import jakarta.mail.internet.MimeMessage;
import org.springframework.mail.MailException;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessagePreparator;

public class SimpleOrderManager implements OrderManager {

	private JavaMailSender mailSender;

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

	public void placeOrder(final Order order) {
		// Do the business calculations...
		// Call the collaborators to persist the order...

		MimeMessagePreparator preparator = new MimeMessagePreparator() {
			public void prepare(MimeMessage mimeMessage) throws Exception {
				mimeMessage.setRecipient(Message.RecipientType.TO,
						new InternetAddress(order.getCustomer().getEmailAddress()));
				mimeMessage.setFrom(new InternetAddress("[email protected]"));
				mimeMessage.setText("Dear " + order.getCustomer().getFirstName() + " " +
						order.getCustomer().getLastName() + ", thanks for your order. " +
						"Your order number is " + order.getOrderNumber() + ".");
			}
		};

		try {
			this.mailSender.send(preparator);
		}
		catch (MailException ex) {
			// simply log it and go on...
			System.err.println(ex.getMessage());
		}
	}

}
邮件验证码是一个横切关注点,很可能是重构为 自定义Spring AOP切面 的候选,然后 可以在 OrderManager 目标上的适当连接点运行。

Spring框架的邮件支持随标准JavaMail实现一起提供。 有关更多信息,请参阅相关的javadoc。spring-doc.cadn.net.cn

使用 JavaMail MimeMessageHelper

在处理JavaMail消息时非常有用的类是 org.springframework.mail.javamail.MimeMessageHelper,它使您免于使用冗长的JavaMail API。使用MimeMessageHelper,就可以很容易地创建一个MimeMessage,如下例所示:spring-doc.cadn.net.cn

// of course you would use DI in any real-world cases
JavaMailSenderImpl sender = new JavaMailSenderImpl();
sender.setHost("mail.host.com");

MimeMessage message = sender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(message);
helper.setTo("[email protected]");
helper.setText("Thank you for ordering!");

sender.send(message);

发送附件和内联资源

多部分电子邮件消息允许同时包含附件和内联资源。内联资源的示例包括您想在邮件中使用但不想作为附件显示的图片或样式表。spring-doc.cadn.net.cn

附件

以下示例显示了如何使用 MimeMessageHelper 通过单个JPEG图像附件发送电子邮件:spring-doc.cadn.net.cn

JavaMailSenderImpl sender = new JavaMailSenderImpl();
sender.setHost("mail.host.com");

MimeMessage message = sender.createMimeMessage();

// use the true flag to indicate you need a multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setTo("[email protected]");

helper.setText("Check out this image!");

// let's attach the infamous windows Sample file (this time copied to c:/)
FileSystemResource file = new FileSystemResource(new File("c:/Sample.jpg"));
helper.addAttachment("CoolImage.jpg", file);

sender.send(message);

内联资源

以下示例向您展示如何使用 MimeMessageHelper 通过内联图片发送电子邮件:spring-doc.cadn.net.cn

JavaMailSenderImpl sender = new JavaMailSenderImpl();
sender.setHost("mail.host.com");

MimeMessage message = sender.createMimeMessage();

// use the true flag to indicate you need a multipart message
MimeMessageHelper helper = new MimeMessageHelper(message, true);
helper.setTo("[email protected]");

// use the true flag to indicate the text included is HTML
helper.setText("<html><body><img src='cid:identifier1234'></body></html>", true);

// let's include the infamous windows Sample file (this time copied to c:/)
FileSystemResource res = new FileSystemResource(new File("c:/Sample.jpg"));
helper.addInline("identifier1234", res);

sender.send(message);
内联资源通过使用指定的 MimeMessage 添加到 MimeMessage 中(在上面的例子中为 identifier1234)。您添加文本和资源的顺序非常重要。请确保先添加文本,然后再添加资源。如果您反过来操作,将无法正常工作。

使用模板库创建电子邮件内容

前面各节中显示的示例代码显式创建了电子邮件消息的内容, 通过使用诸如message.setText(..)的方法调用。这对于简单的情况来说是可行的,在前述示例的上下文中也合适,因为其目的是向您展示API的基本知识。spring-doc.cadn.net.cn

在典型的企业的应用程序中,开发人员通常不会使用之前展示的方法来创建电子邮件内容,出于多种原因:spring-doc.cadn.net.cn

通常,解决这些问题的方法是使用模板库(如 FreeMarker)来定义电子邮件内容的显示结构。这使得你的代码只需负责创建要在电子邮件模板中渲染的数据并发送电子邮件。当电子邮件内容变得稍微复杂时,这无疑是一种最佳实践,而借助 Spring 框架对 FreeMarker 的支持类,这变得非常容易。spring-doc.cadn.net.cn