com.jfplugin.mail.core

类 JavaMailSenderImpl

java.lang.Object

com.jfplugin.mail.core.JavaMailSenderImpl

所有已实现的接口:

JavaMailSender, MailSender

public class JavaMailSenderImpl
extends Object
implements JavaMailSender

作者:

farmer

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_PORT The default port: -1
static String	DEFAULT_PROTOCOL The default protocol: 'smtp'

构造器概要

构造器

构造器和说明
JavaMailSenderImpl() Create a new instance of the JavaMailSenderImpl class.

方法概要

方法

限定符和类型	方法和说明
javax.mail.internet.MimeMessage	createMimeMessage() This implementation creates a SmartMimeMessage, holding the specified default encoding and default FileTypeMap.
javax.mail.internet.MimeMessage	createMimeMessage(InputStream contentStream) Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender, using the given input stream as the message source.
protected void	doSend(javax.mail.internet.MimeMessage[] mimeMessages, Object[] originalMessages) Actually send the given array of MimeMessages via JavaMail.
String	getDefaultEncoding()
FileTypeMap	getDefaultFileTypeMap()
String	getHost()
Properties	getJavaMailProperties() Allow Map access to the JavaMail properties of this sender, with the option to add or override specific entries.
String	getPassword()
int	getPort()
String	getProtocol()
javax.mail.Session	getSession() Return the JavaMail Session, lazily initializing it if hasn't been specified explicitly.
protected javax.mail.Transport	getTransport(javax.mail.Session session) Obtain a Transport object from the given JavaMail Session, using the configured protocol.
String	getUsername()
void	send(javax.mail.internet.MimeMessage mimeMessage) Send the given JavaMail MIME message.
void	send(javax.mail.internet.MimeMessage[] mimeMessages) Send the given array of JavaMail MIME messages in batch.
void	send(MimeMessagePreparator mimeMessagePreparator) Send the JavaMail MIME message prepared by the given MimeMessagePreparator.
void	send(MimeMessagePreparator[] mimeMessagePreparators) Send the JavaMail MIME messages prepared by the given MimeMessagePreparators.
void	send(SimpleMailMessage simpleMessage) Send the given simple mail message.
void	send(SimpleMailMessage[] simpleMessages) Send the given array of simple mail messages in batch.
void	setDefaultEncoding(String defaultEncoding) Set the default encoding to use for MimeMessages created by this instance.
void	setDefaultFileTypeMap(FileTypeMap defaultFileTypeMap) Set the default Java Activation FileTypeMap to use for MimeMessages created by this instance.
void	setHost(String host) Set the mail server host, typically an SMTP host.
void	setJavaMailProperties(Properties javaMailProperties) Set JavaMail properties for the Session.
void	setPassword(String password) Set the password for the account at the mail host, if any.
void	setPort(int port) Set the mail server port.
void	setProtocol(String protocol) Set the mail protocol.
void	setSession(javax.mail.Session session) Set the JavaMail Session, possibly pulled from JNDI.
void	setUsername(String username) Set the username for the account at the mail host, if any.

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

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

字段详细资料

DEFAULT_PROTOCOL

public static final String DEFAULT_PROTOCOL

The default protocol: 'smtp'

另请参阅:

常量字段值

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port: -1

另请参阅:

常量字段值

构造器详细资料

JavaMailSenderImpl

public JavaMailSenderImpl()

Create a new instance of the JavaMailSenderImpl class.

Initializes the "defaultFileTypeMap" property with a default ConfigurableMimeFileTypeMap.

方法详细资料

setJavaMailProperties

public void setJavaMailProperties(Properties javaMailProperties)

Set JavaMail properties for the Session.

A new Session will be created with those properties. Use either this method or setSession(javax.mail.Session), but not both.

Non-default properties in this instance will override given

参数:

javaMailProperties - JavaMail properties.

getJavaMailProperties

public Properties getJavaMailProperties()

Allow Map access to the JavaMail properties of this sender, with the option to add or override specific entries.

Useful for specifying entries directly, for example via "javaMailProperties[mail.smtp.auth]".

返回:

Properties

setSession

public void setSession(javax.mail.Session session)

Set the JavaMail Session, possibly pulled from JNDI.

Default is a new Session without defaults, that is completely configured via this instance's properties.

If using a pre-configured Session, non-default properties in this instance will override the settings in the Session.

参数:

session -

另请参阅:

setJavaMailProperties(java.util.Properties)

getSession

public javax.mail.Session getSession()

Return the JavaMail Session, lazily initializing it if hasn't been specified explicitly.

返回:

Session

setProtocol

public void setProtocol(String protocol)

Set the mail protocol. Default is "smtp".

参数:

protocol - protocol

getProtocol

public String getProtocol()

返回:

the mail protocol.

setHost

public void setHost(String host)

Set the mail server host, typically an SMTP host.

Default is the default host of the underlying JavaMail Session.

参数:

host - host

getHost

public String getHost()

返回:

the mail server host.

setPort

public void setPort(int port)

Set the mail server port.

Default is DEFAULT_PORT, letting JavaMail use the default SMTP port (25).

参数:

port -

getPort

public int getPort()

返回:

the mail server port.

setUsername

public void setUsername(String username)

Set the username for the account at the mail host, if any.

Note that the underlying JavaMail Session has to be configured with the property "mail.smtp.auth" set to true, else the specified username will not be sent to the mail server by the JavaMail runtime. If you are not explicitly passing in a Session to use, simply specify this setting via setJavaMailProperties(java.util.Properties).

参数:

username - username

另请参阅:

setSession(javax.mail.Session), setPassword(java.lang.String)

getUsername

public String getUsername()

返回:

the username for the account at the mail host.

setPassword

public void setPassword(String password)

Set the password for the account at the mail host, if any.

Note that the underlying JavaMail Session has to be configured with the property "mail.smtp.auth" set to true, else the specified password will not be sent to the mail server by the JavaMail runtime. If you are not explicitly passing in a Session to use, simply specify this setting via setJavaMailProperties(java.util.Properties).

参数:

password - password

另请参阅:

setSession(javax.mail.Session), setUsername(java.lang.String)

getPassword

public String getPassword()

返回:

the password for the account at the mail host.

setDefaultEncoding

public void setDefaultEncoding(String defaultEncoding)

Set the default encoding to use for MimeMessages created by this instance.

Such an encoding will be auto-detected by MimeMessageHelper.

参数:

defaultEncoding - defaultEncoding

getDefaultEncoding

public String getDefaultEncoding()

返回:

the default encoding for MimeMessages, or null if none.

setDefaultFileTypeMap

public void setDefaultFileTypeMap(FileTypeMap defaultFileTypeMap)

Set the default Java Activation FileTypeMap to use for MimeMessages created by this instance.

A FileTypeMap specified here will be autodetected by MimeMessageHelper, avoiding the need to specify the FileTypeMap for each MimeMessageHelper instance.

For example, you can specify a custom instance of Spring's ConfigurableMimeFileTypeMap here. If not explicitly specified, a default ConfigurableMimeFileTypeMap will be used, containing an extended set of MIME type mappings (as defined by the mime.types file contained in the Spring jar).

参数:

defaultFileTypeMap - defaultFileTypeMap

另请参阅:

MimeMessageHelper.setFileTypeMap(javax.activation.FileTypeMap)

getDefaultFileTypeMap

public FileTypeMap getDefaultFileTypeMap()

返回:

the default Java Activation FileTypeMap for MimeMessages, or null if none.

send

public void send(SimpleMailMessage simpleMessage)
          throws MailException

从接口复制的说明: MailSender

Send the given simple mail message.

指定者:

send 在接口中 MailSender

参数:

simpleMessage - the message to send

抛出:

MailException

send

public void send(SimpleMailMessage[] simpleMessages)
          throws MailException

从接口复制的说明: MailSender

Send the given array of simple mail messages in batch.

指定者:

send 在接口中 MailSender

参数:

simpleMessages - the messages to send

抛出:

MailException

createMimeMessage

public javax.mail.internet.MimeMessage createMimeMessage()

This implementation creates a SmartMimeMessage, holding the specified default encoding and default FileTypeMap. This special defaults-carrying message will be autodetected by MimeMessageHelper, which will use the carried encoding and FileTypeMap unless explicitly overridden.

指定者:

createMimeMessage 在接口中 JavaMailSender

返回:

the new MimeMessage instance

另请参阅:

setDefaultEncoding(java.lang.String), setDefaultFileTypeMap(javax.activation.FileTypeMap)

createMimeMessage

public javax.mail.internet.MimeMessage createMimeMessage(InputStream contentStream)
                                                  throws MailException

从接口复制的说明: JavaMailSender

Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender, using the given input stream as the message source.

指定者:

createMimeMessage 在接口中 JavaMailSender

参数:

contentStream - the raw MIME input stream for the message

返回:

the new MimeMessage instance

抛出:

MailException - in case of message creation failure

send

public void send(javax.mail.internet.MimeMessage mimeMessage)
          throws MailException

从接口复制的说明: JavaMailSender

Send the given JavaMail MIME message. The message needs to have been created with JavaMailSender.createMimeMessage().

指定者:

send 在接口中 JavaMailSender

参数:

mimeMessage - message to send

抛出:

MailException - in case of failure when sending the message

另请参阅:

JavaMailSender.createMimeMessage()

send

public void send(javax.mail.internet.MimeMessage[] mimeMessages)
          throws MailException

从接口复制的说明: JavaMailSender

Send the given array of JavaMail MIME messages in batch. The messages need to have been created with JavaMailSender.createMimeMessage().

指定者:

send 在接口中 JavaMailSender

参数:

mimeMessages - messages to send

抛出:

MailException - in case of failure when sending a message

另请参阅:

JavaMailSender.createMimeMessage()

send

public void send(MimeMessagePreparator mimeMessagePreparator)
          throws MailException

从接口复制的说明: JavaMailSender

Send the JavaMail MIME message prepared by the given MimeMessagePreparator.

Alternative way to prepare MimeMessage instances, instead of JavaMailSender.createMimeMessage() and JavaMailSender.send(MimeMessage) calls. Takes care of proper exception conversion.

指定者:

send 在接口中 JavaMailSender

参数:

mimeMessagePreparator - the preparator to use

抛出:

MailException

send

public void send(MimeMessagePreparator[] mimeMessagePreparators)
          throws MailException

从接口复制的说明: JavaMailSender

Send the JavaMail MIME messages prepared by the given MimeMessagePreparators.

Alternative way to prepare MimeMessage instances, instead of JavaMailSender.createMimeMessage() and JavaMailSender.send(MimeMessage[]) calls. Takes care of proper exception conversion.

指定者:

send 在接口中 JavaMailSender

参数:

mimeMessagePreparators - the preparator to use

抛出:

MailException - in case of failure when sending a message

doSend

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

Actually send the given array of MimeMessages via JavaMail.

参数:

mimeMessages - MimeMessage objects to send

originalMessages - corresponding original message objects that the MimeMessages have been created from (with same array length and indices as the "mimeMessages" array), if any

抛出:

org.springframework.mail.MailAuthenticationException - in case of authentication failure

org.springframework.mail.MailSendException - in case of failure when sending a message

MailException

getTransport

protected javax.mail.Transport getTransport(javax.mail.Session session)
                                     throws javax.mail.NoSuchProviderException

Obtain a Transport object from the given JavaMail Session, using the configured protocol.

Can be overridden in subclasses, e.g. to return a mock Transport object.

抛出:

javax.mail.NoSuchProviderException

另请参阅:

Session.getTransport(String), getProtocol()