Package ch.astorm.smtp4j.core

Class SmtpMessageStorage

java.lang.Object

ch.astorm.smtp4j.core.SmtpMessageStorage

All Implemented Interfaces:

SmtpMessageHandler, SmtpServerListener

public class SmtpMessageStorage
extends Object
implements SmtpMessageHandler, SmtpServerListener

Simple SmtpMessageHandler that stores the received messages in a list. This class is Thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface ch.astorm.smtp4j.core.SmtpMessageHandler

SmtpMessageHandler.SmtpMessageIterator

Constructor Summary

Constructors

Constructor	Description
SmtpMessageStorage()

Method Summary

Modifier and Type	Method	Description
void	clear()	Deprecated. Use readMessages() instead.
List<SmtpMessage>	getMessages()	Deprecated. Use readMessages() instead.
SmtpMessageHandler.SmtpMessageIterator	iterator()	Returns a new SmtpMessageIterator that loops over the received messages.
void	notifyClose(SmtpServer server)	Invoked when the server has been closed.
void	notifyStart(SmtpServer server)	Invoked when the server has been started and is ready to receive messages.
List<SmtpMessage>	readMessages()	Retrieves the received messages and clears the list.
void	receive(SmtpMessage smtpMessage)	Receives the given smtpMessage.

Methods inherited from class java.lang.Object

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

Constructor Details

SmtpMessageStorage

public SmtpMessageStorage()

Method Details

notifyStart

public void notifyStart(SmtpServer server)

Description copied from interface: SmtpServerListener

Invoked when the server has been started and is ready to receive messages.

Specified by:

notifyStart in interface SmtpServerListener

Parameters:

server - The started SmtpServer.

notifyClose

public void notifyClose(SmtpServer server)

Description copied from interface: SmtpServerListener

Invoked when the server has been closed.

Specified by:

notifyClose in interface SmtpServerListener

Parameters:

server - The stopped SmtpServer.

receive

public void receive(SmtpMessage smtpMessage)

Description copied from interface: SmtpMessageHandler

Receives the given smtpMessage.

Specified by:

receive in interface SmtpMessageHandler

Parameters:

smtpMessage - The message received within the transaction.

iterator

public SmtpMessageHandler.SmtpMessageIterator iterator()

Description copied from interface: SmtpMessageHandler

Returns a new SmtpMessageIterator that loops over the received messages.

Specified by:

iterator in interface SmtpMessageHandler

Returns:

A new SmtpMessageIterator instance.

readMessages

public List<SmtpMessage> readMessages()

Description copied from interface: SmtpMessageHandler

Retrieves the received messages and clears the list. If no new message has been received since the last notification, an empty list will be returned.

Specified by:

readMessages in interface SmtpMessageHandler

Returns:

All the (newly) received messages or an empty list if none.

getMessages

@Deprecated
public List<SmtpMessage> getMessages()

Deprecated.

Use readMessages() instead.

Returns a List with all the received messages.

Returns:

All the received messages.

clear

@Deprecated
public void clear()

Deprecated.

Use readMessages() instead.

Clears all the messages.