Package org.citrusframework.mail.server

Class MailServer

java.lang.Object

org.citrusframework.endpoint.AbstractEndpoint

org.citrusframework.server.AbstractServer

org.citrusframework.mail.server.MailServer

All Implemented Interfaces:

Runnable, InitializingPhase, Named, ShutdownPhase, Endpoint, Server, ReferenceResolverAware

public class MailServer
extends AbstractServer

Mail server implementation starts new SMTP server instance and listens for incoming mail messages. Incoming mail messages are converted to XML representation and forwarded to some message endpoint adapter (e.g. forwarding mail content to a message channel).

By default, incoming messages are accepted automatically. When auto accept is disabled the endpoint adapter is invoked with accept request and test case has to decide accept outcome in response.

In case of incoming multipart mail messages the server is able to split the body parts into separate XML messages handled by the endpoint adapter.

Since:

1.4

Author:

Christoph Deppisch

Field Summary

Fields inherited from class org.citrusframework.server.AbstractServer

DEFAULT_CHANNEL_ID_SUFFIX

Constructor Summary

Constructors

Constructor	Description
MailServer()

Method Summary

Modifier and Type	Method	Description
boolean	accept(String from, List<com.icegreen.greenmail.mail.MailAddress> recipients)
void	addKnownUser(String email, String login, String password)	Adds a new user known to this mail server.
void	deliver(jakarta.mail.internet.MimeMessage mimeMessage)
MailEndpointConfiguration	getEndpointConfiguration()
Properties	getJavaMailProperties()	Gets the Java mail properties.
List<String>	getKnownUsers()	Gets the known users.
MailMarshaller	getMarshaller()	Gets the mail message marshaller.
MailMessageConverter	getMessageConverter()	Gets the message converter.
int	getPort()	Gets the server port.
jakarta.mail.Session	getSession()	Return a new mail session if not already created before.
com.icegreen.greenmail.util.GreenMail	getSmtpServer()	Gets the smtp server instance.
protected Message	invokeEndpointAdapter(MailMessage mail)	Invokes the endpoint adapter with constructed mail message and headers.
boolean	isAuthRequired()	Users must authenticate properly with the server.
boolean	isAutoAccept()	Is auto accept enabled.
boolean	isSplitMultipart()	Gets the split multipart message.
void	setAuthRequired(boolean authRequired)	Enable/disable the user authentication on this server.
void	setAutoAccept(boolean autoAccept)	Enable/disable auto accept feature.
void	setJavaMailProperties(Properties javaMailProperties)	Sets the Java mail properties.
void	setKnownUsers(List<String> knownUsers)	Sets the known users.
void	setMarshaller(MailMarshaller marshaller)	Sets the mail message marshaller.
void	setMessageConverter(MailMessageConverter messageConverter)	Sets the message converter.
void	setPort(int port)	Sets the server port.
void	setSmtpServer(com.icegreen.greenmail.util.GreenMail smtpServer)	Sets the smtp server instance.
void	setSplitMultipart(boolean splitMultipart)	Sets the split multipart message.
protected void	shutdown()
protected void	startup()

Methods inherited from class org.citrusframework.server.AbstractServer

createConsumer, createProducer, destroy, getDefaultTimeout, getEndpointAdapter, getInterceptors, getReferenceResolver, initialize, isAutoStart, isDebugLogging, isRunning, join, run, setAutoStart, setDebugLogging, setDefaultTimeout, setEndpointAdapter, setInterceptors, setReferenceResolver, setRunning, start, stop

Methods inherited from class org.citrusframework.endpoint.AbstractEndpoint

getActor, getConsumerName, getName, getProducerName, setActor, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.citrusframework.endpoint.Endpoint

getActor, getName, setActor

Methods inherited from interface org.citrusframework.common.Named

setName

Constructor Details

MailServer

public MailServer()

Method Details

startup

protected void startup()

Specified by:

startup in class AbstractServer

shutdown

protected void shutdown()

Specified by:

shutdown in class AbstractServer

accept

public boolean accept(String from,
 List<com.icegreen.greenmail.mail.MailAddress> recipients)

deliver

public void deliver(jakarta.mail.internet.MimeMessage mimeMessage)

invokeEndpointAdapter

protected Message invokeEndpointAdapter(MailMessage mail)

Invokes the endpoint adapter with constructed mail message and headers.

getEndpointConfiguration

public MailEndpointConfiguration getEndpointConfiguration()

Specified by:

getEndpointConfiguration in interface Endpoint

Overrides:

getEndpointConfiguration in class AbstractServer

getSession

public jakarta.mail.Session getSession()

Return a new mail session if not already created before.

isAuthRequired

public boolean isAuthRequired()

Users must authenticate properly with the server.

Returns:

setAuthRequired

public void setAuthRequired(boolean authRequired)

Enable/disable the user authentication on this server.

Parameters:

authRequired -

isAutoAccept

public boolean isAutoAccept()

Is auto accept enabled.

setAutoAccept

public void setAutoAccept(boolean autoAccept)

Enable/disable auto accept feature.

getMarshaller

public MailMarshaller getMarshaller()

Gets the mail message marshaller.

setMarshaller

public void setMarshaller(MailMarshaller marshaller)

Sets the mail message marshaller.

getJavaMailProperties

public Properties getJavaMailProperties()

Gets the Java mail properties.

setJavaMailProperties

public void setJavaMailProperties(Properties javaMailProperties)

Sets the Java mail properties.

getPort

public int getPort()

Gets the server port.

setPort

public void setPort(int port)

Sets the server port.

getSmtpServer

public com.icegreen.greenmail.util.GreenMail getSmtpServer()

Gets the smtp server instance.

setSmtpServer

public void setSmtpServer(com.icegreen.greenmail.util.GreenMail smtpServer)

Sets the smtp server instance.

isSplitMultipart

public boolean isSplitMultipart()

Gets the split multipart message.

setSplitMultipart

public void setSplitMultipart(boolean splitMultipart)

Sets the split multipart message.

getMessageConverter

public MailMessageConverter getMessageConverter()

Gets the message converter.

setMessageConverter

public void setMessageConverter(MailMessageConverter messageConverter)

Sets the message converter.

getKnownUsers

public List<String> getKnownUsers()

Gets the known users.

Returns:

setKnownUsers

public void setKnownUsers(List<String> knownUsers)

Sets the known users.

Parameters:

knownUsers -

addKnownUser

public void addKnownUser(String email,
 String login,
 String password)

Adds a new user known to this mail server.

Parameters:

email -

login -

password -