Class MailSendingMessageHandlerSpec

java.lang.Object

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

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

org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<MailSendingMessageHandler>, InitializingBean, Lifecycle, Phased, SmartLifecycle

public class MailSendingMessageHandlerSpec
extends MessageHandlerSpec<MailSendingMessageHandlerSpec, MailSendingMessageHandler>

Since:

5.0

Author:

Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
protected final JavaMailSenderImpl	sender

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

logger, PARSER, target

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

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MailSendingMessageHandlerSpec(@Nullable String host)

Method Summary

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

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

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

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

isSingleton

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Field Details

sender

protected final JavaMailSenderImpl sender

Constructor Details

MailSendingMessageHandlerSpec

protected MailSendingMessageHandlerSpec(@Nullable String host)

Method Details

javaMailProperties

public MailSendingMessageHandlerSpec javaMailProperties(Properties javaMailProperties)

Set the javamail properties.

Parameters:

javaMailProperties - the properties.

Returns:

the spec.

See Also:

• JavaMailSenderImpl.setJavaMailProperties(Properties)

javaMailProperties

public MailSendingMessageHandlerSpec javaMailProperties(Consumer<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 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 String username,
 @Nullable String password)

Set the credentials.

Parameters:

username - the username.

password - the password.

Returns:

the spec.

See Also:

• JavaMailSenderImpl.setUsername(String)
• JavaMailSenderImpl.setPassword(String)

password

public MailSendingMessageHandlerSpec password(@Nullable 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 String defaultEncoding)

Set the default encoding.

Parameters:

defaultEncoding - the default encoding.

Returns:

the spec.

See Also:

• JavaMailSenderImpl.setDefaultEncoding(String)

defaultFileTypeMap

public MailSendingMessageHandlerSpec defaultFileTypeMap(@Nullable FileTypeMap defaultFileTypeMap)

Set the default type map.

Parameters:

defaultFileTypeMap - the default type map.

Returns:

the spec.

See Also:

• JavaMailSenderImpl.setDefaultFileTypeMap(FileTypeMap)