org.subethamail.wiser

Class Wiser

java.lang.Object

org.subethamail.wiser.Wiser

All Implemented Interfaces:

SimpleMessageListener

public final class Wiser
extends Object
implements SimpleMessageListener

Wiser is a tool for unit testing applications that send mail. Your unit tests can start Wiser, run tests which generate emails, then examine the emails that Wiser received and verify their integrity. Wiser is not intended to be a "real" mail server and is not adequate for that purpose; it simply stores all mail in memory. Use the MessageHandlerFactory interface (optionally with the SimpleMessageListenerAdapter) of SubEthaSMTP instead.

Author:

Jon Stevens, Jeff Schnitzer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Wiser.Accepter
static class	Wiser.WiserBuilder

Method Summary

Modifier and Type	Method and Description
boolean	accept(String from, String recipient) Always accept everything
static Wiser.WiserBuilder	accepter(Wiser.Accepter accepter)
static Wiser	create()
static Wiser	create(SMTPServer.Builder builder)
void	deliver(String from, String recipient, InputStream data) Cache the messages in memory
void	dumpMessages(PrintStream out) For debugging purposes, dumps a rough outline of the messages to the output stream.
List<WiserMessage>	getMessages() Returns the list of WiserMessages.
SMTPServer	getServer()
static void	main(String[] args) A main() for this class.
static Wiser	port(int port)
void	start() Starts the SMTP Server
void	stop() Stops the SMTP Server

Methods inherited from class java.lang.Object

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

Method Detail

port

public static Wiser port(int port)

create

public static Wiser create(SMTPServer.Builder builder)

create

public static Wiser create()

accepter

public static Wiser.WiserBuilder accepter(Wiser.Accepter accepter)

start

public void start()

Starts the SMTP Server

stop

public void stop()

Stops the SMTP Server

accept

public boolean accept(String from,
                      String recipient)

Always accept everything

Specified by:

accept in interface SimpleMessageListener

Parameters:

from - is a rfc822-compliant email address.

recipient - is a rfc822-compliant email address.

Returns:

true if the listener wants delivery of the message, false if the message is not for this listener.

deliver

public void deliver(String from,
                    String recipient,
                    InputStream data)
             throws TooMuchDataException,
                    IOException

Cache the messages in memory

Specified by:

deliver in interface SimpleMessageListener

Parameters:

from - is the envelope sender in rfc822 form

recipient - will be an accepted recipient in rfc822 form

data - will be the smtp data stream, stripped of any extra '.' chars. The data stream is only valid for the duration of this call.

Throws:

TooMuchDataException - if the listener can't handle that much data. An error will be reported to the client.

IOException - if there is an IO error reading the input data.

getMessages

public List<WiserMessage> getMessages()

Returns the list of WiserMessages.

The number of mail transactions and the number of mails may be different. If a message is received with multiple recipients in a single mail transaction, then the list will contain more WiserMessage instances, one for each recipient.

getServer

public SMTPServer getServer()

Returns:

the server implementation

dumpMessages

public void dumpMessages(PrintStream out)
                  throws javax.mail.MessagingException

For debugging purposes, dumps a rough outline of the messages to the output stream.

Throws:

javax.mail.MessagingException

main

public static void main(String[] args)
                 throws Exception

A main() for this class. Starts up the server.

Throws:

Exception