Package io.quarkus.mailer.runtime

Interface MailerRuntimeConfig

public interface MailerRuntimeConfig

  • Method Details

    • from

      Optional<String> from()
      Sets the default `from` attribute when not specified in the Mail instance. It's the sender email address.

    • mock

      Optional<Boolean> mock()
      Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.

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

    • bounceAddress

      Optional<String> bounceAddress()
      Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.

    • host

      @WithDefault("localhost") String host()
      Sets the SMTP host name.

    • port

      OptionalInt port()
      The SMTP port. The default value depends on the configuration. The port 25 is used as default when ssl() is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when ssl() is enabled. It ensures that email is submitted securely.

      Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.

    • username

      Optional<String> username()
      Sets the username to connect to the SMTP server.

    • password

      Optional<String> password()
      Sets the password to connect to the SMTP server.

    • tlsConfigurationName

      Optional<String> tlsConfigurationName()
      The name of the TLS configuration to use.

      If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

      If no TLS configuration name is set then, the specific TLS configuration (from quarkus.mailer.*) will be used.

      The default TLS configuration is not used by default.

    • ssl

      @Deprecated @WithDefault("false") boolean ssl()
      Deprecated.
      Use {tls()}
      Enables or disables the TLS/SSL.

    • tls

      Optional<Boolean> tls()
      Whether the connection should be secured using TLS.

      SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to false and startTLS() to REQUIRED Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to false is required to not establish a connection with TLS.

    • trustAll

      @Deprecated Optional<Boolean> trustAll()
      Deprecated.
      Use the TLS registry instead.
      Set whether all server certificates should be trusted. This option is only used when ssl() is enabled.

    • maxPoolSize

      @WithDefault("10") int maxPoolSize()
      Sets the max number of open connections to the mail server.

    • ownHostName

      Optional<String> ownHostName()
      Sets the hostname to be used for HELO/EHLO and the Message-ID.

    • keepAlive

      @WithDefault("true") boolean keepAlive()
      Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.

    • disableEsmtp

      @WithDefault("false") boolean disableEsmtp()
      Disable ESMTP.

      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

      @WithDefault("OPTIONAL") String startTLS()
      Sets the TLS security mode for the connection. Either DISABLED, OPTIONAL or REQUIRED.

    • dkim

      DkimSignOptionsConfig dkim()
      Configures DKIM signature verification.

    • login

      @WithDefault("NONE") String login()
      Sets the login mode for the connection. Either NONE, DISABLED, REQUIRED or XOAUTH2.
      • NONE means a login will be attempted if the server supports it and login credentials are set
      • DISABLED means no login will be attempted
      • REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise
      • XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens

    • authMethods

      Optional<String> authMethods()
      Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used.

      The list is given as a space separated list, such as DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN.

    • keyStore

      @Deprecated Optional<String> keyStore()
      Deprecated.
      Use the TLS registry instead.
      Set the trust store.

    • keyStorePassword

      Optional<String> keyStorePassword()
      Deprecated.
      Use the TLS registry instead.
      Sets the trust store password if any.

    • truststore

      TrustStoreConfig truststore()
      Deprecated.
      Use the TLS registry instead.
      Configures the trust store.

    • multiPartOnly

      @WithDefault("false") boolean multiPartOnly()
      Whether the mail should always been sent as multipart even if they don't have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.

    • allowRcptErrors

      @WithDefault("false") boolean allowRcptErrors()
      Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.

    • pipelining

      @WithDefault("true") boolean pipelining()
      Enables or disables the pipelining capability if the SMTP server supports it.

    • poolCleanerPeriod

      @WithDefault("PT1S") Duration poolCleanerPeriod()
      Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.

    • keepAliveTimeout

      @WithDefault("PT300S") Duration keepAliveTimeout()
      Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.

    • ntlm

      NtlmConfig ntlm()
      Configures NTLM (Windows New Technology LAN Manager).

    • approvedRecipients

      Optional<List<@WithConverter(TrimmedPatternConverter.class) Pattern>> approvedRecipients()
      Allows sending emails to these recipients only.

      Approved recipients are compiled to a Pattern and must be a valid regular expression. The created Pattern is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.

    • logRejectedRecipients

      @WithDefault("false") boolean logRejectedRecipients()
      Log rejected recipients as warnings.

      If false, the rejected recipients will be logged at the DEBUG level.

    • logInvalidRecipients

      @WithDefault("false") boolean logInvalidRecipients()
      Log invalid recipients as warnings.

      If false, the invalid recipients will not be logged and the thrown exception will not contain the invalid email address.