org.springframework.integration.mail.dsl

Class Mail

java.lang.Object

org.springframework.integration.mail.dsl.Mail

public final class Mail
extends java.lang.Object

The factory for Spring Integration Mail components.

Since:

5.0

Author:

Gary Russell, Artem Bilan

Method Summary

Modifier and Type	Method and Description
static MailHeadersBuilder	headers() A MailHeadersBuilder factory.
static ImapIdleChannelAdapterSpec	imapIdleAdapter() An ImapIdleChannelAdapterSpec factory using a default ImapMailReceiver.
static ImapIdleChannelAdapterSpec	imapIdleAdapter(ImapMailReceiver imapMailReceiver) An ImapIdleChannelAdapterSpec factory based on the provided ImapMailReceiver.
static ImapIdleChannelAdapterSpec	imapIdleAdapter(java.lang.String url) A ImapIdleChannelAdapterSpec factory based on the provided url.
static ImapMailInboundChannelAdapterSpec	imapInboundAdapter() An ImapMailInboundChannelAdapterSpec factory using a default ImapMailReceiver.
static ImapMailInboundChannelAdapterSpec	imapInboundAdapter(ImapMailReceiver imapMailReceiver) An ImapMailInboundChannelAdapterSpec factory based on the provided ImapMailReceiver.
static ImapMailInboundChannelAdapterSpec	imapInboundAdapter(java.lang.String url) A ImapMailInboundChannelAdapterSpec factory based on the provided url.
static MailSendingMessageHandlerSpec	outboundAdapter(java.lang.String host)
static Pop3MailInboundChannelAdapterSpec	pop3InboundAdapter() A Pop3MailInboundChannelAdapterSpec factory using a default Pop3MailReceiver.
static Pop3MailInboundChannelAdapterSpec	pop3InboundAdapter(Pop3MailReceiver pop3MailReceiver) A Pop3MailInboundChannelAdapterSpec factory based on the provided Pop3MailReceiver.
static Pop3MailInboundChannelAdapterSpec	pop3InboundAdapter(java.lang.String url) A Pop3MailInboundChannelAdapterSpec factory based on the provided url.
static Pop3MailInboundChannelAdapterSpec	pop3InboundAdapter(java.lang.String host, int port, java.lang.String username, java.lang.String password) A Pop3MailInboundChannelAdapterSpec factory based on the provided host, port, user, and password.
static Pop3MailInboundChannelAdapterSpec	pop3InboundAdapter(java.lang.String host, java.lang.String username, java.lang.String password) A Pop3MailInboundChannelAdapterSpec factory based on the provided host, user, password and the default port.
static MailToStringTransformer	toStringTransformer() A MailToStringTransformer factory.
static MailToStringTransformer	toStringTransformer(java.lang.String charset) A MailToStringTransformer factory.

Methods inherited from class java.lang.Object

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

Method Detail

outboundAdapter

public static MailSendingMessageHandlerSpec outboundAdapter(java.lang.String host)

pop3InboundAdapter

public static Pop3MailInboundChannelAdapterSpec pop3InboundAdapter()

A Pop3MailInboundChannelAdapterSpec factory using a default Pop3MailReceiver.

Returns:

the Pop3MailInboundChannelAdapterSpec instance.

pop3InboundAdapter

public static Pop3MailInboundChannelAdapterSpec pop3InboundAdapter(Pop3MailReceiver pop3MailReceiver)

A Pop3MailInboundChannelAdapterSpec factory based on the provided Pop3MailReceiver.

Parameters:

pop3MailReceiver - the Pop3MailReceiver to use.

Returns:

the Pop3MailInboundChannelAdapterSpec instance.

pop3InboundAdapter

public static Pop3MailInboundChannelAdapterSpec pop3InboundAdapter(java.lang.String url)

A Pop3MailInboundChannelAdapterSpec factory based on the provided url.

Parameters:

url - the pop3 url

Returns:

the Pop3MailInboundChannelAdapterSpec instance.

pop3InboundAdapter

public static Pop3MailInboundChannelAdapterSpec pop3InboundAdapter(java.lang.String host,
                                                                   java.lang.String username,
                                                                   java.lang.String password)

A Pop3MailInboundChannelAdapterSpec factory based on the provided host, user, password and the default port.

Parameters:

host - the host.

username - the user.

password - the password.

Returns:

the Pop3MailInboundChannelAdapterSpec instance.

pop3InboundAdapter

public static Pop3MailInboundChannelAdapterSpec pop3InboundAdapter(java.lang.String host,
                                                                   int port,
                                                                   java.lang.String username,
                                                                   java.lang.String password)

A Pop3MailInboundChannelAdapterSpec factory based on the provided host, port, user, and password.

Parameters:

host - the host.

port - the port.

username - the user.

password - the password.

Returns:

the Pop3MailInboundChannelAdapterSpec instance.

imapInboundAdapter

public static ImapMailInboundChannelAdapterSpec imapInboundAdapter()

An ImapMailInboundChannelAdapterSpec factory using a default ImapMailReceiver.

Returns:

the ImapMailInboundChannelAdapterSpec instance.

imapInboundAdapter

public static ImapMailInboundChannelAdapterSpec imapInboundAdapter(ImapMailReceiver imapMailReceiver)

An ImapMailInboundChannelAdapterSpec factory based on the provided ImapMailReceiver.

Parameters:

imapMailReceiver - the ImapMailReceiver to use.

Returns:

the ImapMailInboundChannelAdapterSpec instance.

imapInboundAdapter

public static ImapMailInboundChannelAdapterSpec imapInboundAdapter(java.lang.String url)

A ImapMailInboundChannelAdapterSpec factory based on the provided url.

Parameters:

url - the imap url

Returns:

the ImapMailInboundChannelAdapterSpec instance.

imapIdleAdapter

public static ImapIdleChannelAdapterSpec imapIdleAdapter()

An ImapIdleChannelAdapterSpec factory using a default ImapMailReceiver.

Returns:

the ImapIdleChannelAdapterSpec instance.

imapIdleAdapter

public static ImapIdleChannelAdapterSpec imapIdleAdapter(java.lang.String url)

A ImapIdleChannelAdapterSpec factory based on the provided url.

Parameters:

url - the imap url

Returns:

the ImapIdleChannelAdapterSpec instance.

imapIdleAdapter

public static ImapIdleChannelAdapterSpec imapIdleAdapter(ImapMailReceiver imapMailReceiver)

An ImapIdleChannelAdapterSpec factory based on the provided ImapMailReceiver.

Parameters:

imapMailReceiver - the ImapMailReceiver to use.

Returns:

the ImapIdleChannelAdapterSpec instance.

headers

public static MailHeadersBuilder headers()

A MailHeadersBuilder factory.

Returns:

the factory.

toStringTransformer

public static MailToStringTransformer toStringTransformer()

A MailToStringTransformer factory.

Returns:

the transformer.

toStringTransformer

public static MailToStringTransformer toStringTransformer(java.lang.String charset)

A MailToStringTransformer factory.

Parameters:

charset - the charset to use when the default is not appropriate.

Returns:

the transformer.