emailserver:run

Full name:

com.btmatthews.maven.plugins:emailserver-maven-plugin:1.1.1:run

Description:

Run the e-mail server.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.0.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
monitorKey String 1.0.0 Key to provide when sending commands to the mail apache.
User property is: monitor.key.
monitorPort int 1.0.0 The port to listen on for the monitor commands.
User property is: monitor.port.

Optional Parameters

Name Type Since Description
daemon boolean 1.0.0 If true the server is run as a daemon.
Default value is: false.
User property is: monitor.daemon.
mailboxes Mailbox[] 1.0.0 A list of mailboxes to be pre-configured during start-up.
portOffset int 1.0.0 The offset applied to the standard protocol ports.
Default value is: 0.
User property is: emailserver.portOffset.
serverName String 1.0.0 The name of the server. The following server types are supported:
  • greenmail
  • dumbster
  • subethasmtp

Default value is: greenmail.
User property is: emailserver.serverName.
useSSL boolean 1.0.0 If true then mail servers are run using secure transports.
Default value is: false.
User property is: emailServer.useSSL.

Parameter Details

daemon:

If true the server is run as a daemon.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: monitor.daemon
  • Default: false

mailboxes:

A list of mailboxes to be pre-configured during start-up.
  • Type: com.btmatthews.maven.plugins.emailserver.mojo.Mailbox[]
  • Since: 1.0.0
  • Required: No

monitorKey:

Key to provide when sending commands to the mail apache.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: monitor.key

monitorPort:

The port to listen on for the monitor commands.
  • Type: int
  • Since: 1.0.0
  • Required: Yes
  • User Property: monitor.port

portOffset:

The offset applied to the standard protocol ports.
  • Type: int
  • Since: 1.0.0
  • Required: No
  • User Property: emailserver.portOffset
  • Default: 0

serverName:

The name of the server. The following server types are supported:
  • greenmail
  • dumbster
  • subethasmtp
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: emailserver.serverName
  • Default: greenmail

useSSL:

If true then mail servers are run using secure transports.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: emailServer.useSSL
  • Default: false