Micronaut Email Configuration Reference

Every documented configuration property of Micronaut Email, with types, descriptions, and defaults.

Micronaut Email documentation

25 properties across 7 sections

Micronaut Email Amazon Ses Config Properties

Configuration properties for SesConfigurationProperties

PropertyTypeDescription
ses.enabledbooleanIf Amazon Simple Email Service integration is enabled. Default value: true

Micronaut Email Config Properties

Configuration properties for FromConfigurationProperties

PropertyTypeDescription
micronaut.email.from.emailjava.lang.StringDefault from email address.
micronaut.email.from.namejava.lang.Stringname of the contact sending the email.

Micronaut Email Javamail Config Properties

Configuration properties for JavaMailConfigurationProperties

PropertyTypeDescription
javamail.enabledbooleanIf Jakarta Mail integration is enabled. Default value: true
javamail.propertiesjava.util.Mapproperties as listed in Appendix A of the JavaMail spec (particularly mail.store.protocol, mail.transport.protocol, mail.host, mail.user, and mail.from).

Configuration properties for JavaMailAuthenticationConfigurationProperties

PropertyTypeDescription
javamail.authentication.enabledbooleanIf authentication is enabled. Default value: true
javamail.authentication.usernamejava.lang.StringAuthentication username.
javamail.authentication.passwordjava.lang.StringAuthentication password.

Micronaut Email Mailjet Config Properties

Configuration properties for MailjetConfigurationProperties

PropertyTypeDescription
mailjet.enabledbooleanIf Mailjet integration is enabled. Default value: true
mailjet.versionjava.lang.StringMailjet API Version. Default value: "v3.1"
mailjet.api-keyjava.lang.StringMailjet API Key.
mailjet.api-secretjava.lang.StringMailjet API Secret.

Micronaut Email Mailtrap Config Properties

Configuration properties for MailtrapConfigurationProperties

PropertyTypeDescription
mailtrap.enabledbooleanIf Mailtrap integration is enabled. Default value true

Configuration properties for MailtrapConfig$Builder

PropertyTypeDescription
mailtrap.connection-timeoutjava.time.Duration
mailtrap.tokenjava.lang.String
mailtrap.http-clientio.mailtrap.http.CustomHttpClient
mailtrap.sandboxboolean
mailtrap.bulkboolean
mailtrap.inbox-idjava.lang.Long

Micronaut Email Postmark Config Properties

Configuration properties for PostmarkConfigurationProperties

PropertyTypeDescription
postmark.enabledbooleanIf Postmark integration is enabled. Default value: true
postmark.api-tokenjava.lang.StringPostmark API token.
postmark.track-opensbooleanWhether to track if the email is opened. Default value: false
postmark.track-linksTrackLinksWhether to track the email’s links. Default value DO_NOT_TRACK.

Micronaut Email Sendgrid Config Properties

Configuration properties for SendGridConfigurationProperties

PropertyTypeDescription
sendgrid.enabledbooleanIf SendGrid integration is enabled. Default value true
sendgrid.api-keyjava.lang.StringThe API key to authenticate access to the SendGrid service.