Package com.icegreen.greenmail.junit5

Class GreenMailExtension

java.lang.Object

com.icegreen.greenmail.configuration.ConfiguredGreenMail

com.icegreen.greenmail.util.GreenMailProxy

com.icegreen.greenmail.junit5.GreenMailExtension

All Implemented Interfaces:

com.icegreen.greenmail.base.GreenMailOperations, AfterAllCallback, AfterEachCallback, BeforeAllCallback, BeforeEachCallback, Extension

public class GreenMailExtension
extends com.icegreen.greenmail.util.GreenMailProxy
implements BeforeAllCallback, AfterAllCallback, BeforeEachCallback, AfterEachCallback

To use this extension you need to use @RegisterExtension Junit5 mechanism and made variable static.
But if you want to remove static keyword annotate test class with @TestInstance(TestInstance.Lifecycle.PER_CLASS).

By default you get a new GreenMail instance per method which works with BeforeEach. You can use withPerMethodLifecycle(boolean) to control this behavior - eg to speed up at the cost of isolation using only BeforeAll

    @RegisterExtension
    GreenMailExtension greenMail = new GreenMailExtension(ServerSetupTest.SMTP_IMAP)
             .withPerMethodLifecycle(false);

    @BeforeAll
    public void setup() { ... }
 

See Also:

RegisterExtension, TestInstance

Constructor Summary

Constructors

Constructor	Description
GreenMailExtension()	Initialize with all server setups.
GreenMailExtension(com.icegreen.greenmail.util.ServerSetup serverSetup)	Initialize with single server setups.
GreenMailExtension(com.icegreen.greenmail.util.ServerSetup[] serverSetups)	Initialize with multiple server setups.

Method Summary

Modifier and Type	Method	Description
void	afterAll(ExtensionContext context)
void	afterEach(ExtensionContext context)
void	beforeAll(ExtensionContext context)
void	beforeEach(ExtensionContext context)
protected com.icegreen.greenmail.util.GreenMail	getGreenMail()
boolean	isRunning()
GreenMailExtension	withConfiguration(com.icegreen.greenmail.configuration.GreenMailConfiguration config)
GreenMailExtension	withPerMethodLifecycle(boolean perMethod)	Specify whether GreenMail should be set up and torn down before and after each method or before and after all methods.

Methods inherited from class com.icegreen.greenmail.util.GreenMailProxy

findReceivedMessages, getImap, getImaps, getManagers, getPop3, getPop3s, getReceivedMessages, getReceivedMessagesForDomain, getSmtp, getSmtps, getUserManager, loadEmails, purgeEmailFromAllMailboxes, reset, setQuotaSupported, setUser, setUser, setUsers, start, stop, waitForIncomingEmail, waitForIncomingEmail

Methods inherited from class com.icegreen.greenmail.configuration.ConfiguredGreenMail

doConfigure

Methods inherited from class java.lang.Object

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

Constructor Detail

GreenMailExtension

public GreenMailExtension(com.icegreen.greenmail.util.ServerSetup serverSetup)

Initialize with single server setups.

Parameters:

serverSetup - Setup to use

GreenMailExtension

public GreenMailExtension()

Initialize with all server setups.

GreenMailExtension

public GreenMailExtension(com.icegreen.greenmail.util.ServerSetup[] serverSetups)

Initialize with multiple server setups.

Parameters:

serverSetups - All setups to use

Method Detail

beforeEach

public void beforeEach(ExtensionContext context)

Specified by:

beforeEach in interface BeforeEachCallback

afterEach

public void afterEach(ExtensionContext context)

Specified by:

afterEach in interface AfterEachCallback

beforeAll

public void beforeAll(ExtensionContext context)

Specified by:

beforeAll in interface BeforeAllCallback

afterAll

public void afterAll(ExtensionContext context)

Specified by:

afterAll in interface AfterAllCallback

withPerMethodLifecycle

public GreenMailExtension withPerMethodLifecycle(boolean perMethod)

Specify whether GreenMail should be set up and torn down before and after each method or before and after all methods.

Parameters:

perMethod - If true, per-method lifecycle is used, per-class otherwise.

Returns:

The GreenMail extension for chaining calls.

getGreenMail

protected com.icegreen.greenmail.util.GreenMail getGreenMail()

Specified by:

getGreenMail in class com.icegreen.greenmail.util.GreenMailProxy

withConfiguration

public GreenMailExtension withConfiguration(com.icegreen.greenmail.configuration.GreenMailConfiguration config)

Specified by:

withConfiguration in interface com.icegreen.greenmail.base.GreenMailOperations

Overrides:

withConfiguration in class com.icegreen.greenmail.configuration.ConfiguredGreenMail

isRunning

public boolean isRunning()

Specified by:

isRunning in interface com.icegreen.greenmail.base.GreenMailOperations