io.quarkus.mailer.runtime

Class MailConfig

java.lang.Object

io.quarkus.mailer.runtime.MailConfig

@ConfigRoot(name="mailer",
            phase=RUN_TIME)
public class MailConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Optional<String>	authMethods Set the allowed auth methods.
Optional<String>	bounceAddress Configures the default bounce email address.
boolean	disableEsmtp Disable ESMTP.
Optional<String>	from Configure the default `from` attribute.
String	host The SMTP host name.
boolean	keepAlive Set if connection pool is enabled, true by default.
Optional<String>	keyStore Set the key store.
Optional<String>	keyStorePassword Set the key store password.
Optional<String>	login Set the login mode for the connection.
OptionalInt	maxPoolSize Configures the maximum allowed number of open connections to the mail server If not set the default is 10.
Optional<Boolean>	mock Enables the mock mode, not sending emails.
Optional<String>	ownHostName The hostname to be used for HELO/EHLO and the Message-ID
Optional<String>	password The password.
OptionalInt	port The SMTP port.
boolean	ssl Enables or disables the SSL on connect.
Optional<String>	startTLS Set the TLS security mode for the connection.
boolean	trustAll Set whether to trust all certificates on ssl connect the option is also applied to STARTTLS operation.
Optional<String>	username The username.

Constructor Summary

Constructors

Constructor and Description
MailConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

from

@ConfigItem
public Optional<String> from

Configure the default `from` attribute. It's the sender email address.

mock

@ConfigItem
public Optional<Boolean> mock

Enables the mock mode, not sending emails. The content of the emails is printed on the console.

Disabled by default on PROD, enabled by default on DEV and TEST modes.

bounceAddress

@ConfigItem
public Optional<String> bounceAddress

Configures the default bounce email address.

host

@ConfigItem(defaultValue="localhost")
public String host

The SMTP host name.

port

@ConfigItem
public OptionalInt port

The SMTP port.

username

@ConfigItem
public Optional<String> username

The username.

password

@ConfigItem
public Optional<String> password

The password.

ssl

@ConfigItem
public boolean ssl

Enables or disables the SSL on connect. false by default.

trustAll

@ConfigItem
public boolean trustAll

Set whether to trust all certificates on ssl connect the option is also applied to STARTTLS operation. false by default.

maxPoolSize

@ConfigItem
public OptionalInt maxPoolSize

Configures the maximum allowed number of open connections to the mail server If not set the default is 10.

ownHostName

@ConfigItem
public Optional<String> ownHostName

The hostname to be used for HELO/EHLO and the Message-ID

keepAlive

@ConfigItem(defaultValue="true")
public boolean keepAlive

Set if connection pool is enabled, true by default.

If the connection pooling is disabled, the max number of sockets is enforced nevertheless.

disableEsmtp

@ConfigItem
public boolean disableEsmtp

Disable ESMTP. false by default. The RFC-1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use the regular SMTP command.

startTLS

@ConfigItem
public Optional<String> startTLS

Set the TLS security mode for the connection. Either DISABLED, OPTIONAL or REQUIRED.

login

@ConfigItem
public Optional<String> login

Set the login mode for the connection. Either DISABLED, OPTIONAL or REQUIRED

authMethods

@ConfigItem
public Optional<String> authMethods

Set the allowed auth methods. If defined, only these methods will be used, if the server supports them.

keyStore

@ConfigItem
public Optional<String> keyStore

Set the key store.

keyStorePassword

@ConfigItem
public Optional<String> keyStorePassword

Set the key store password.

Constructor Detail

MailConfig

public MailConfig()