org.springframework.integration.mail.dsl

Class MailSendingMessageHandlerSpec

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

org.springframework.integration.dsl.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.MessageHandlerSpec<MailSendingMessageHandlerSpec,MailSendingMessageHandler>

org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<MailSendingMessageHandler>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class MailSendingMessageHandlerSpec
extends org.springframework.integration.dsl.MessageHandlerSpec<MailSendingMessageHandlerSpec,MailSendingMessageHandler>

Since:

5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.mail.javamail.JavaMailSenderImpl	sender

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MailSendingMessageHandlerSpec(java.lang.String host)

Method Summary

Modifier and Type	Method and Description
MailSendingMessageHandlerSpec	credentials(java.lang.String username, java.lang.String password) Set the credentials.
MailSendingMessageHandlerSpec	defaultEncoding(java.lang.String defaultEncoding) Set the default encoding.
MailSendingMessageHandlerSpec	defaultFileTypeMap(javax.activation.FileTypeMap defaultFileTypeMap) Set the default type map.
MailSendingMessageHandlerSpec	javaMailProperties(java.util.function.Consumer<org.springframework.integration.support.PropertiesBuilder> propertiesConfigurer) Set a Consumer that will be invoked with a PropertiesBuilder; most often used with a lambda expression.
MailSendingMessageHandlerSpec	javaMailProperties(java.util.Properties javaMailProperties) Set the javamail properties.
MailSendingMessageHandlerSpec	password(java.lang.String password) Set the mail user password.
MailSendingMessageHandlerSpec	port(int port) Set the port.
MailSendingMessageHandlerSpec	protocol(java.lang.String protocol) Set the protocol.

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Field Detail

sender

protected final org.springframework.mail.javamail.JavaMailSenderImpl sender

Constructor Detail

MailSendingMessageHandlerSpec

protected MailSendingMessageHandlerSpec(@Nullable
                                        java.lang.String host)

Method Detail

javaMailProperties

public MailSendingMessageHandlerSpec javaMailProperties(java.util.Properties javaMailProperties)

Set the javamail properties.

Parameters:

javaMailProperties - the properties.

Returns:

the spec.

See Also:

JavaMailSenderImpl.setJavaMailProperties(Properties)

javaMailProperties

public MailSendingMessageHandlerSpec javaMailProperties(java.util.function.Consumer<org.springframework.integration.support.PropertiesBuilder> propertiesConfigurer)

Set a Consumer that will be invoked with a PropertiesBuilder; most often used with a lambda expression.

Parameters:

propertiesConfigurer - the consumer.

Returns:

the spec.

protocol

public MailSendingMessageHandlerSpec protocol(@Nullable
                                              java.lang.String protocol)

Set the protocol.

Parameters:

protocol - the protocol.

Returns:

the spec.

See Also:

JavaMailSenderImpl.setProtocol(String)

port

public MailSendingMessageHandlerSpec port(int port)

Set the port.

Parameters:

port - the port.

Returns:

the spec.

See Also:

JavaMailSenderImpl.setPort(int)

credentials

public MailSendingMessageHandlerSpec credentials(@Nullable
                                                 java.lang.String username,
                                                 @Nullable
                                                 java.lang.String password)

Set the credentials.

Parameters:

username - the user name.

password - the password.

Returns:

the spec.

See Also:

JavaMailSenderImpl.setUsername(String), JavaMailSenderImpl.setPassword(String)

password

public MailSendingMessageHandlerSpec password(@Nullable
                                              java.lang.String password)

Set the mail user password. A convenient method when username is provided in the Java mail properties.

Parameters:

password - the password.

Returns:

the spec.

Since:

5.1.3

See Also:

JavaMailSenderImpl.setPassword(String), javaMailProperties(Properties)

defaultEncoding

public MailSendingMessageHandlerSpec defaultEncoding(@Nullable
                                                     java.lang.String defaultEncoding)

Set the default encoding.

Parameters:

defaultEncoding - the default encoding.

Returns:

the spec.

See Also:

JavaMailSenderImpl.setDefaultEncoding(String)

defaultFileTypeMap

public MailSendingMessageHandlerSpec defaultFileTypeMap(@Nullable
                                                        javax.activation.FileTypeMap defaultFileTypeMap)

Set the default type map.

Parameters:

defaultFileTypeMap - the default type map.

Returns:

the spec.

See Also:

JavaMailSenderImpl.setDefaultFileTypeMap(FileTypeMap)