jodd.mail

Class MailServer.Builder

java.lang.Object

jodd.mail.MailServer.Builder

Enclosing class:

MailServer<MailSessionImpl extends jodd.mail.MailSession>

public static class MailServer.Builder
extends java.lang.Object

Used to create implementing instances of MailServer.

See Also:

ImapServer, ImapSslServer, Pop3Server, Pop3SslServer, SmtpServer, SmtpSslServer

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MailServer.Builder	auth(jakarta.mail.Authenticator authenticator) Sets the authenticator.
MailServer.Builder	auth(java.lang.String username, java.lang.String password) Sets authenticator as SimpleAuthenticator using username and password.
ImapServer	buildImapMailServer() Create a ImapServer from current data.
Pop3Server	buildPop3MailServer() Create a Pop3Server from current data.
SmtpServer	buildSmtpMailServer() Create a SmtpServer from current data.
MailServer.Builder	debugConsumer(java.util.function.Consumer<java.lang.String> consumer) Set debug consumer
MailServer.Builder	debugMode(boolean debug) Enable or disable debug mode.
MailServer.Builder	host(java.lang.String host) Sets the host.
MailServer.Builder	port(int port) Sets the port.
MailServer.Builder	property(java.lang.String name, java.lang.Object value) Specifies a non-string custom property; such as `mail.event.executor`.
MailServer.Builder	property(java.lang.String name, java.lang.String value) Specifies a custom property.
MailServer.Builder	ssl(boolean ssl) Sets the SSL implementation of the Mail server.
MailServer.Builder	storeAttachmentsIn(java.io.File attachmentStorage) Defines attachment storage, a folder where attachments will be saved.
MailServer.Builder	strictAddress(boolean strictAddress) Disables the strict address.
MailServer.Builder	timeout(int timeout) Defines timeout value in milliseconds for all mail-related operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

host

public MailServer.Builder host(java.lang.String host)

Sets the host.

Parameters:

host - The host to set.

Returns:

this

port

public MailServer.Builder port(int port)

Sets the port.

Parameters:

port - The port to set.

Returns:

this

ssl

public MailServer.Builder ssl(boolean ssl)

Sets the SSL implementation of the Mail server.

Parameters:

ssl - SSL flag

Returns:

this

storeAttachmentsIn

public MailServer.Builder storeAttachmentsIn(java.io.File attachmentStorage)

Defines attachment storage, a folder where attachments will be saved.

auth

public MailServer.Builder auth(java.lang.String username,
                               java.lang.String password)

Sets authenticator as SimpleAuthenticator using username and password.

Parameters:

username - The username to use.

password - The password to use.

Returns:

this

auth

public MailServer.Builder auth(jakarta.mail.Authenticator authenticator)

Sets the authenticator.

Parameters:

authenticator - Authenticator to set.

Returns:

this

debugMode

public MailServer.Builder debugMode(boolean debug)

Enable or disable debug mode.

Parameters:

debug - true to turn on debugging. By default, this is false.

Returns:

this

debugConsumer

public MailServer.Builder debugConsumer(java.util.function.Consumer<java.lang.String> consumer)

Set debug consumer

Parameters:

consumer - a String consumer to be called for debug logging. By default, this is null.

Returns:

this

timeout

public MailServer.Builder timeout(int timeout)

Defines timeout value in milliseconds for all mail-related operations.

Parameters:

timeout - timeout value in milliseconds.

Returns:

this

strictAddress

public MailServer.Builder strictAddress(boolean strictAddress)

Disables the strict address.

Parameters:

strictAddress - true if strict address checking should be turned on. By default, this is true.

Returns:

this

property

public MailServer.Builder property(java.lang.String name,
                                   java.lang.String value)

Specifies a custom property.

property

public MailServer.Builder property(java.lang.String name,
                                   java.lang.Object value)

Specifies a non-string custom property; such as `mail.event.executor`.

buildImapMailServer

public ImapServer buildImapMailServer()

Create a ImapServer from current data.

Returns:

ImapServer from current data.

buildPop3MailServer

public Pop3Server buildPop3MailServer()

Create a Pop3Server from current data.

Returns:

Pop3Server from current data.

buildSmtpMailServer

public SmtpServer buildSmtpMailServer()

Create a SmtpServer from current data.

Returns:

SmtpServer from current data.