com.easycodebox.common.mail

类 SimpleMailSender

java.lang.Object

org.springframework.mail.javamail.JavaMailSenderImpl

com.easycodebox.common.mail.SimpleMailSender

所有已实现的接口:

org.springframework.mail.javamail.JavaMailSender, org.springframework.mail.MailSender

public class SimpleMailSender
extends org.springframework.mail.javamail.JavaMailSenderImpl

增加了异步发送邮件、模板解析功能

作者:

WangXiaoJin

字段概要

从类继承的字段 org.springframework.mail.javamail.JavaMailSenderImpl

DEFAULT_PORT, DEFAULT_PROTOCOL

构造器概要

构造器

构造器和说明
SimpleMailSender()

方法概要

限定符和类型	方法和说明
protected void	asyncLogic(String subject, String text, CoupleMailProcessor coupleMailProcessor, Object model, boolean isTemplate, boolean isHtml, String... to)
protected javax.mail.Address	createFromAddress(String addr, String personal) 创建发送人邮件地址
protected void	doSend(javax.mail.internet.MimeMessage[] mimeMessages, Object[] originalMessages) 检查mimeMessages中的from属性有没有值，没有则设置为 fromAddress 值
org.springframework.util.concurrent.ListenableFutureCallback<javax.mail.internet.MimeMessage[]>	getCallback()
TemplateProcessor	getDefaultTemplateProcessor()
org.springframework.core.task.AsyncListenableTaskExecutor	getExecutor()
String	getFromAddress()
String	getFromPersonal()
ConcurrentHashMap<String,TemplateProcessor>	getProcessorMap()
ConcurrentHashMap<String,String>	getTemplateMap()
protected boolean	hasPersonal(String address) 验证邮件发送人字符窜中是否设置了昵称，即使用了如下格式： 隔壁老王 <3xxxxx@qq.com>
void	init()
protected String	processTemplate(String template, Object model) 处理模板内容
void	send(String subject, String text, String... to) 发送简单的文本邮件
void	sendAsync(CoupleMailProcessor coupleMailProcessor, String... to) 异步发送简单的文本邮件
void	sendAsync(javax.mail.internet.MimeMessage... mimeMessages) 异步发送邮件
void	sendAsync(String subject, String text, String... to) 异步发送简单的文本邮件
void	sendHtml(String subject, String html, String... to) 发送HTML格式的邮件
void	sendHtmlAsync(CoupleMailProcessor coupleMailProcessor, String... to) 异步发送HTML格式的邮件
void	sendHtmlAsync(String subject, String html, String... to) 异步发送HTML格式的邮件
void	sendHtmlTmpl(String subject, String template, Object model, String... to) 发送模板邮件 - 邮件内容为HTML格式
void	sendHtmlTmplAsync(CoupleMailProcessor coupleMailProcessor, Object model, String... to) 异步发送模板邮件 - 邮件内容为HTML格式
void	sendHtmlTmplAsync(String subject, String template, Object model, String... to) 异步发送模板邮件 - 邮件内容为HTML格式
void	sendTmpl(String subject, String template, Object model, String... to) 发送模板邮件 - 邮件内容为文本格式
void	sendTmplAsync(CoupleMailProcessor coupleMailProcessor, Object model, String... to) 异步发送模板邮件 - 邮件内容为文本格式
void	sendTmplAsync(String subject, String template, Object model, String... to) 异步发送模板邮件 - 邮件内容为文本格式
void	setCallback(org.springframework.util.concurrent.ListenableFutureCallback<javax.mail.internet.MimeMessage[]> callback)
void	setDefaultTemplateProcessor(TemplateProcessor defaultTemplateProcessor)
void	setExecutor(org.springframework.core.task.AsyncListenableTaskExecutor executor)
void	setFromAddress(String fromAddress) fromAddress不支持多个邮件地址，如果传了多个邮件地址，则默认使用第一个。
void	setFromPersonal(String fromPersonal)
void	setProcessorMap(Map<String,TemplateProcessor> processorMap)
void	setTemplateMap(Map<String,String> templateMap)
void	setTemplateProcessorMapping(String mapping) 配置模板和处理器的映射，字符窜格式： /templates/order.ftl=freemarker /templates/cards.vm=velocity 注：等号后面的freemarker、velocity是通过processorMap来决定的

从类继承的方法 org.springframework.mail.javamail.JavaMailSenderImpl

connectTransport, createMimeMessage, createMimeMessage, getDefaultEncoding, getDefaultFileTypeMap, getHost, getJavaMailProperties, getPassword, getPort, getProtocol, getSession, getTransport, getUsername, send, send, send, send, send, send, setDefaultEncoding, setDefaultFileTypeMap, setHost, setJavaMailProperties, setPassword, setPort, setProtocol, setSession, setUsername, testConnection

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SimpleMailSender

public SimpleMailSender()

方法详细资料

init

@PostConstruct
public void init()
                          throws Exception

抛出:

Exception

send

public void send(String subject,
                 String text,
                 String... to)
          throws org.springframework.mail.MailException

发送简单的文本邮件

参数:

subject - 邮件主题

text - 邮件内容

to - 收件人

抛出:

org.springframework.mail.MailException

sendTmpl

public void sendTmpl(String subject,
                     String template,
                     Object model,
                     String... to)
              throws org.springframework.mail.MailException,
                     ParseTemplateException

发送模板邮件 - 邮件内容为文本格式

参数:

subject - 邮件主题

template - 邮件内容

model - 模板占位符替换值，可用值类型根据具体模板处理器而定

to - 收件人

抛出:

org.springframework.mail.MailException

ParseTemplateException

sendAsync

public void sendAsync(String subject,
                      String text,
                      String... to)

异步发送简单的文本邮件

参数:

subject - 邮件主题

text - 邮件内容

to - 收件人

sendAsync

public void sendAsync(CoupleMailProcessor coupleMailProcessor,
                      String... to)

异步发送简单的文本邮件

参数:

coupleMailProcessor -

to - 收件人

sendTmplAsync

public void sendTmplAsync(String subject,
                          String template,
                          Object model,
                          String... to)

异步发送模板邮件 - 邮件内容为文本格式

参数:

subject - 邮件主题

template - 邮件模板

model - 模板占位符替换值，可用值类型根据具体模板处理器而定

to - 收件人

sendTmplAsync

public void sendTmplAsync(CoupleMailProcessor coupleMailProcessor,
                          Object model,
                          String... to)

异步发送模板邮件 - 邮件内容为文本格式

参数:

coupleMailProcessor -

model - 模板占位符替换值，可用值类型根据具体模板处理器而定

to - 收件人

sendHtml

public void sendHtml(String subject,
                     String html,
                     String... to)
              throws org.springframework.mail.MailException,
                     javax.mail.MessagingException

发送HTML格式的邮件

参数:

subject - 邮件主题

html - 邮件内容

to - 收件人

抛出:

org.springframework.mail.MailException

javax.mail.MessagingException

sendHtmlTmpl

public void sendHtmlTmpl(String subject,
                         String template,
                         Object model,
                         String... to)
                  throws org.springframework.mail.MailException,
                         ParseTemplateException,
                         javax.mail.MessagingException

发送模板邮件 - 邮件内容为HTML格式

参数:

subject - 邮件主题

template - 邮件内容

model - 模板占位符替换值，可用值类型根据具体模板处理器而定

to - 收件人

抛出:

org.springframework.mail.MailException

ParseTemplateException

javax.mail.MessagingException

sendHtmlAsync

public void sendHtmlAsync(String subject,
                          String html,
                          String... to)

异步发送HTML格式的邮件

参数:

subject - 邮件主题

html - 邮件内容

to - 收件人

sendHtmlAsync

public void sendHtmlAsync(CoupleMailProcessor coupleMailProcessor,
                          String... to)

异步发送HTML格式的邮件

参数:

coupleMailProcessor -

to - 收件人

sendHtmlTmplAsync

public void sendHtmlTmplAsync(String subject,
                              String template,
                              Object model,
                              String... to)

异步发送模板邮件 - 邮件内容为HTML格式

参数:

subject - 邮件主题

template - 邮件模板

model - 模板占位符替换值，可用值类型根据具体模板处理器而定

to - 收件人

sendHtmlTmplAsync

public void sendHtmlTmplAsync(CoupleMailProcessor coupleMailProcessor,
                              Object model,
                              String... to)

异步发送模板邮件 - 邮件内容为HTML格式

参数:

coupleMailProcessor -

model - 模板占位符替换值，可用值类型根据具体模板处理器而定

to - 收件人

sendAsync

public void sendAsync(javax.mail.internet.MimeMessage... mimeMessages)

异步发送邮件

参数:

mimeMessages -

doSend

protected void doSend(javax.mail.internet.MimeMessage[] mimeMessages,
                      Object[] originalMessages)
               throws org.springframework.mail.MailException

检查mimeMessages中的from属性有没有值，没有则设置为 fromAddress 值

覆盖:

doSend 在类中 org.springframework.mail.javamail.JavaMailSenderImpl

参数:

mimeMessages -

originalMessages -

抛出:

org.springframework.mail.MailException

asyncLogic

protected void asyncLogic(String subject,
                          String text,
                          CoupleMailProcessor coupleMailProcessor,
                          Object model,
                          boolean isTemplate,
                          boolean isHtml,
                          String... to)

processTemplate

protected String processTemplate(String template,
                                 Object model)
                          throws ParseTemplateException,
                                 IllegalArgumentException

处理模板内容

参数:

template -

model -

返回:

抛出:

ParseTemplateException

IllegalArgumentException

createFromAddress

protected javax.mail.Address createFromAddress(String addr,
                                               String personal)
                                        throws UnsupportedEncodingException

创建发送人邮件地址

参数:

addr - 邮件地址

personal - 人名

返回:

抛出:

UnsupportedEncodingException

hasPersonal

protected boolean hasPersonal(String address)

验证邮件发送人字符窜中是否设置了昵称，即使用了如下格式：

      隔壁老王 <3xxxxx@qq.com>
 

参数:

address -

返回:

getFromAddress

public String getFromAddress()

setFromAddress

public void setFromAddress(String fromAddress)

fromAddress不支持多个邮件地址，如果传了多个邮件地址，则默认使用第一个。格式支持：

• 3xxxxx@qq.com
• 隔壁老王 <3xxxxx@qq.com>

参数:

fromAddress -

getFromPersonal

public String getFromPersonal()

setFromPersonal

public void setFromPersonal(String fromPersonal)

getExecutor

public org.springframework.core.task.AsyncListenableTaskExecutor getExecutor()

setExecutor

public void setExecutor(org.springframework.core.task.AsyncListenableTaskExecutor executor)

getCallback

public org.springframework.util.concurrent.ListenableFutureCallback<javax.mail.internet.MimeMessage[]> getCallback()

setCallback

public void setCallback(org.springframework.util.concurrent.ListenableFutureCallback<javax.mail.internet.MimeMessage[]> callback)

getDefaultTemplateProcessor

public TemplateProcessor getDefaultTemplateProcessor()

setDefaultTemplateProcessor

public void setDefaultTemplateProcessor(TemplateProcessor defaultTemplateProcessor)

setTemplateProcessorMapping

public void setTemplateProcessorMapping(String mapping)

配置模板和处理器的映射，字符窜格式：

     /templates/order.ftl=freemarker
     /templates/cards.vm=velocity
 

注：等号后面的freemarker、velocity是通过processorMap来决定的

参数:

mapping -

getTemplateMap

public ConcurrentHashMap<String,String> getTemplateMap()

setTemplateMap

public void setTemplateMap(Map<String,String> templateMap)

getProcessorMap

public ConcurrentHashMap<String,TemplateProcessor> getProcessorMap()

setProcessorMap

public void setProcessorMap(Map<String,TemplateProcessor> processorMap)