Package net.mailific.mailificserverspringboot

Class Autoconf

java.lang.Object

net.mailific.mailificserverspringboot.Autoconf

@AutoConfiguration
public class Autoconf
extends Object

Provides Spring autoconfiguration for the Mailific SMTP listener library.

Author:

jhumphreys

Constructor Summary

Constructors

Constructor	Description
Autoconf()

Method Summary

Modifier and Type	Method	Description
BannerDomainProvider	bannerDomainProvider()	Provides the domain to be advertised in the Banner (connect response).
CommandHandlerProvider	commandHandlerProvider(BannerDomainProvider domain, EhloGreetingProvider greeting, MailObjectFactory mailObjectFactory)	Provides a connect handler and collection of command handlers.
EhloGreetingProvider	ehloGreetingProvider()	Provides the EHLO greeting text.
ExtensionProvider	extensionProvider(String certPath)	Provides a list of extensions for the server to support.
SmtpCommandMap	mailificCommandConsumer(CommandHandlerProvider commands)	Builds an SmtpCommandMap from a CommandHandlerProvider .
MailObjectFactory	mailObjectFactory()	Provides a factory for MailObject objects.
ServerConfig	serverConfig(String listenHost, int listenPort, String certPath, String certKeyPath, String certPass, SmtpSessionFactory sessionFactory)	Provides the ServerConfig used by smtpServer(ServerConfig)
SmtpServer	smtpServer(ServerConfig config)	Provides a Netty-based SmtpServer.
SmtpSessionFactory	smtpSesssionFactory(LineConsumer commandConsumer, ExtensionProvider extensions)	Provides an SmtpSessionFactory.

Methods inherited from class java.lang.Object

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

Constructor Details

Autoconf

public Autoconf()

Method Details

smtpServer

@Bean
@ConditionalOnMissingBean
public SmtpServer smtpServer(ServerConfig config)

Provides a Netty-based SmtpServer.

Parameters:

config - See serverConfig(String, int, String, String, String, SmtpSessionFactory)

serverConfig

@Bean
@ConditionalOnMissingBean
public ServerConfig serverConfig(@Value("${mailific.server.listenHost:localhost}")
 String listenHost,
 @Value("${mailific.server.listenPort:2525}")
 int listenPort,
 @Value("${mailific.server.certPath:}")
 String certPath,
 @Value("${mailific.server.certKeyPath:}")
 String certKeyPath,
 @Value("${mailific.server.certPassword:#{NULL}}")
 String certPass,
 SmtpSessionFactory sessionFactory)

Provides the ServerConfig used by smtpServer(ServerConfig)

Parameters:

listenHost - Hostname to listen to. Taken from the property mailific.server.listenHost. The property defaults to "localhost".

listenPort - Port to listen on. Taken from the property mailific.server.listenPort. The property defaults to 2525.

certPath - File path to an SSL cert-chain file, in PEM format. If set to empty or null, the server won't offer STARTTLS. Taken from the property mailific.server.certPath. The property defaults to empty.

certKeyPath - File path to the key (in PKCS8 format) for the SSL cert. Taken from the property mailific.server.certKeyPath. The poperty defaults to empty.

certPass - Password for the key specified by certKeyPath. Leave null if the key file is not encrypted. Taken from the property mailific.server.certPassword. Defaults to null.

sessionFactory - see smtpSesssionFactory(LineConsumer, ExtensionProvider)

smtpSesssionFactory

@Bean
@ConditionalOnMissingBean
public SmtpSessionFactory smtpSesssionFactory(@Qualifier("mailificCommandConsumer")
 LineConsumer commandConsumer,
 ExtensionProvider extensions)

Provides an SmtpSessionFactory. Used by serverConfig(String, int, String, String, String, SmtpSessionFactory)

Parameters:

commandConsumer - see mailificCommandConsumer(CommandHandlerProvider)

extensions - see extensionProvider(String)

extensionProvider

@Bean
@ConditionalOnMissingBean
public ExtensionProvider extensionProvider(@Value("${mailific.server.certPath:}")
 String certPath)

Provides a list of extensions for the server to support. Used by smtpSesssionFactory(LineConsumer, ExtensionProvider).

Parameters:

certPath - If nonnull and nonblank, the return value will include the STARTTLS extension. Taken from the property mailific.server.certPath. The property defaults to empty.

mailificCommandConsumer

@Bean
@ConditionalOnMissingBean(name="mailificCommandConsumer")
public SmtpCommandMap mailificCommandConsumer(CommandHandlerProvider commands)

Builds an SmtpCommandMap from a CommandHandlerProvider . This is the default implementation for the LineConsumer used by smtpSesssionFactory(LineConsumer, ExtensionProvider).

This Bean is named "mailificCommandConsumer" so that it can be distinguished from other possible LineConsumer Beans.

Parameters:

commands - see commandHandlerProvider(BannerDomainProvider, EhloGreetingProvider, MailObjectFactory)

commandHandlerProvider

@Bean
@ConditionalOnMissingBean
public CommandHandlerProvider commandHandlerProvider(BannerDomainProvider domain,
 EhloGreetingProvider greeting,
 MailObjectFactory mailObjectFactory)

Provides a connect handler and collection of command handlers. Used by mailificCommandConsumer(CommandHandlerProvider).

Parameters:

domain - Domain to be used in the Banner and EHLO responses. See bannerDomainProvider()

greeting - Greeting text to be used in EHLO response. See ehloGreetingProvider()

mailObjectFactory - see mailObjectFactory()

mailObjectFactory

@Bean
@ConditionalOnMissingBean
public MailObjectFactory mailObjectFactory()

Provides a factory for MailObject objects. You will almost certainly need to provide your own implementation here. Used by commandHandlerProvider(BannerDomainProvider, EhloGreetingProvider, MailObjectFactory)

bannerDomainProvider

@Bean
@ConditionalOnMissingBean
public BannerDomainProvider bannerDomainProvider()

Provides the domain to be advertised in the Banner (connect response). Also used in the EHLO response. Used by commandHandlerProvider(BannerDomainProvider, EhloGreetingProvider, MailObjectFactory)

ehloGreetingProvider

@Bean
@ConditionalOnMissingBean
public EhloGreetingProvider ehloGreetingProvider()

Provides the EHLO greeting text. Maybe return null. Used by commandHandlerProvider(BannerDomainProvider, EhloGreetingProvider, MailObjectFactory)