Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractTransactionalEmailSender<I,
O> - Class in io.micronaut.email -
Abstract class which implements both
TransactionalEmailSender
andAsyncTransactionalEmailSender
. - AbstractTransactionalEmailSender(ExecutorService) - Constructor for class io.micronaut.email.AbstractTransactionalEmailSender
- ANY_RECIPIENT_MESSAGE - Static variable in class io.micronaut.email.validation.EmailMessages
-
AnyRecipient
message. - AnyRecipient - Annotation Interface in io.micronaut.email.validation
-
The annotated type must have a recipient.
- AnyRecipientConstraintValidationFactory - Class in io.micronaut.email.validation
-
Deprecated, for removal: This API element is subject to removal in a future version.
- AnyRecipientConstraintValidationFactory() - Constructor for class io.micronaut.email.validation.AnyRecipientConstraintValidationFactory
-
Deprecated.
- anyRecipientEmailConstraintValidator() - Method in class io.micronaut.email.validation.AnyRecipientConstraintValidationFactory
-
Deprecated.
- AnyRecipientValidator - Class in io.micronaut.email.validation
- AnyRecipientValidator() - Constructor for class io.micronaut.email.validation.AnyRecipientValidator
- AsyncEmailSender<I,
O> - Interface in io.micronaut.email -
Defines a functional interface to send transactional emails asynchronously.
- AsyncSesEmailSender - Class in io.micronaut.email.ses
-
Amazon Simple Email Service implementation of @link io.micronaut.email.AsyncTransactionalEmailSender}.
- AsyncSesEmailSender(SesAsyncClient, SesEmailComposer) - Constructor for class io.micronaut.email.ses.AsyncSesEmailSender
- AsyncTransactionalEmailSender<I,
O> - Interface in io.micronaut.email -
Contract to send emails Asynchronously.
- attachment(Attachment) - Method in class io.micronaut.email.Email.Builder
- attachment(Consumer<Attachment.Builder>) - Method in class io.micronaut.email.Email.Builder
- Attachment - Class in io.micronaut.email
-
Email's Attachment.
- Attachment(String, String, byte[], String) - Constructor for class io.micronaut.email.Attachment
-
Deprecated, for removal: This API element is subject to removal in a future version.
- Attachment(String, String, byte[], String, String) - Constructor for class io.micronaut.email.Attachment
- Attachment.Builder - Class in io.micronaut.email
-
Attachment's builder.
- AuthenticatorFactory - Class in io.micronaut.email.javamail.sender.authentication
-
Builds a
Authenticator
from configuration set atJavaMailAuthenticationConfiguration
. - AuthenticatorFactory() - Constructor for class io.micronaut.email.javamail.sender.authentication.AuthenticatorFactory
B
- bcc(Contact) - Method in class io.micronaut.email.Email.Builder
- bcc(String) - Method in class io.micronaut.email.Email.Builder
- body(Body) - Method in class io.micronaut.email.Email.Builder
- body(String) - Method in class io.micronaut.email.Email.Builder
- body(String, String) - Method in class io.micronaut.email.Email.Builder
- body(String, BodyType) - Method in class io.micronaut.email.Email.Builder
- Body - Interface in io.micronaut.email
-
Represents the body of an email.
- BodyType - Enum Class in io.micronaut.email
-
Type of Email's body.
- build() - Method in class io.micronaut.email.Attachment.Builder
- build() - Method in class io.micronaut.email.Email.Builder
- buildAuthenticator(JavaMailAuthenticationConfiguration) - Method in class io.micronaut.email.javamail.sender.authentication.AuthenticatorFactory
- builder() - Static method in class io.micronaut.email.Attachment
- builder() - Static method in class io.micronaut.email.Email
- Builder() - Constructor for class io.micronaut.email.Attachment.Builder
- Builder() - Constructor for class io.micronaut.email.Email.Builder
- buildMailPropertiesProvider(JavaMailConfiguration) - Method in class io.micronaut.email.javamail.sender.MailPropertiesProviderFactory
C
- cc(Contact) - Method in class io.micronaut.email.Email.Builder
- cc(String) - Method in class io.micronaut.email.Email.Builder
- CiUtils - Class in io.micronaut.email.test
- CiUtils() - Constructor for class io.micronaut.email.test.CiUtils
- compose(Email) - Method in interface io.micronaut.email.EmailComposer
- compose(Email) - Method in class io.micronaut.email.javamail.sender.JavaxEmailComposer
- compose(Email) - Method in class io.micronaut.email.mailjet.MailjetEmailComposer
- compose(Email) - Method in class io.micronaut.email.postmark.PostmarkEmailComposer
- compose(Email) - Method in class io.micronaut.email.sendgrid.SendgridEmailComposer
- compose(Email) - Method in class io.micronaut.email.ses.SesEmailComposer
- compose(Email, Consumer<I>) - Method in interface io.micronaut.email.EmailComposer
- compose(Email, Session) - Method in class io.micronaut.email.javamail.composer.DefaultMessageComposer
- compose(Email, Session) - Method in interface io.micronaut.email.javamail.composer.MessageComposer
- Contact - Class in io.micronaut.email
-
Class representing the person who receives an email.
- Contact(String) - Constructor for class io.micronaut.email.Contact
- Contact(String, String) - Constructor for class io.micronaut.email.Contact
- content(byte[]) - Method in class io.micronaut.email.Attachment.Builder
- content(File) - Method in class io.micronaut.email.Attachment.Builder
- content(InputStream) - Method in class io.micronaut.email.Attachment.Builder
- contentType(String) - Method in class io.micronaut.email.Attachment.Builder
- countAndDeleteInboxEmailsBySubject(String) - Static method in class io.micronaut.email.test.MailTestUtils
- countAndDeleteInboxEmailsBySubject(String, String, String) - Static method in class io.micronaut.email.test.MailTestUtils
D
- decorate(Email.Builder) - Method in interface io.micronaut.email.EmailDecorator
-
Populates an email.
- decorate(Email.Builder) - Method in class io.micronaut.email.FromDecorator
- decorate(Email.Builder) - Method in interface io.micronaut.email.template.TemplateBodyDecorator
- DEFAULT_ENABLED - Static variable in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.email.javamail.sender.JavaMailConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.email.mailjet.MailjetConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.email.postmark.PostmarkConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.email.sendgrid.SendGridConfigurationProperties
-
The default enable value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.email.ses.SesConfigurationProperties
-
The default enable value.
- DEFAULT_TRACK_OPENS - Static variable in class io.micronaut.email.postmark.PostmarkConfigurationProperties
-
The default track opens value.
- DEFAULT_VERSION - Static variable in class io.micronaut.email.mailjet.MailjetConfigurationProperties
-
The default version.
- DefaultAsyncEmailSender<I,
O> - Class in io.micronaut.email -
Decorates with every
EmailDecorator
and send an email via aAsyncTransactionalEmailSender
. - DefaultAsyncEmailSender(AsyncTransactionalEmailSender<I, O>, List<EmailDecorator>) - Constructor for class io.micronaut.email.DefaultAsyncEmailSender
- DefaultEmailSender<I,
O> - Class in io.micronaut.email -
Decorates with every
EmailDecorator
and send an email via aTransactionalEmailSender
. - DefaultEmailSender(TransactionalEmailSender<I, O>, List<EmailDecorator>) - Constructor for class io.micronaut.email.DefaultEmailSender
- DefaultMessageComposer - Class in io.micronaut.email.javamail.composer
-
DefaultImplementation
ofMessageComposer
. - DefaultMessageComposer() - Constructor for class io.micronaut.email.javamail.composer.DefaultMessageComposer
- DefaultSessionProvider - Class in io.micronaut.email.javamail.sender
- DefaultSessionProvider(MailPropertiesProvider, Authenticator) - Constructor for class io.micronaut.email.javamail.sender.DefaultSessionProvider
- DefaultTemplateBodyDecorator - Class in io.micronaut.email.template
-
DefaultImplementation
ofTemplateBodyDecorator
. - DefaultTemplateBodyDecorator(ViewsRendererLocator) - Constructor for class io.micronaut.email.template.DefaultTemplateBodyDecorator
- disposition(String) - Method in class io.micronaut.email.Attachment.Builder
- DO_NOT_TRACK - Enum constant in enum class io.micronaut.email.TrackLinks
-
Whether email links should not be tracked neither in HTML nor in plain text emails.
E
- Email - Class in io.micronaut.email
-
Representation of a transactional email.
- Email.Builder - Class in io.micronaut.email
-
Email builder.
- EmailComposer<I> - Interface in io.micronaut.email
-
Composes an Email Request for the Transactional Email provider given a
Email
. - EmailDecorator - Interface in io.micronaut.email
-
Decorates every Email send by an
EmailSender
or anAsyncEmailSender
. - EmailException - Exception in io.micronaut.email
-
Wraps exceptions being thrown while sending emails in a
RuntimeException
. - EmailException(String) - Constructor for exception io.micronaut.email.EmailException
- EmailException(Throwable) - Constructor for exception io.micronaut.email.EmailException
- EmailMessages - Class in io.micronaut.email.validation
-
Validation messages for Email.
- EmailMessages() - Constructor for class io.micronaut.email.validation.EmailMessages
-
Default constructor to initialize messages.
- EmailSender<I,
O> - Interface in io.micronaut.email -
API to send transactional emails synchronously.
- ENV_CI - Static variable in class io.micronaut.email.test.CiUtils
- equals(Object) - Method in class io.micronaut.email.Contact
F
- filename(String) - Method in class io.micronaut.email.Attachment.Builder
- from(Contact) - Method in class io.micronaut.email.Email.Builder
- from(String) - Method in class io.micronaut.email.Email.Builder
- FromConfiguration - Interface in io.micronaut.email.configuration
-
A bean of type
FromConfiguration
defines the default sender. - FromConfigurationProperties - Class in io.micronaut.email.configuration
-
ConfigurationProperties
implementation ofFromConfiguration
. - FromConfigurationProperties() - Constructor for class io.micronaut.email.configuration.FromConfigurationProperties
- FromDecorator - Class in io.micronaut.email
-
Decorates an email by setting the from field if not specified with the value provided by
FromConfiguration
. - FromDecorator(FromConfiguration) - Constructor for class io.micronaut.email.FromDecorator
G
- get(BodyType) - Method in interface io.micronaut.email.Body
- get(BodyType) - Method in class io.micronaut.email.MultipartBody
- get(BodyType) - Method in class io.micronaut.email.StringBody
- get(BodyType) - Method in class io.micronaut.email.template.TemplateBody
- getApiKey() - Method in interface io.micronaut.email.mailjet.MailjetConfiguration
- getApiKey() - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
- getApiKey() - Method in interface io.micronaut.email.sendgrid.SendGridConfiguration
- getApiKey() - Method in class io.micronaut.email.sendgrid.SendGridConfigurationProperties
- getApiSecret() - Method in interface io.micronaut.email.mailjet.MailjetConfiguration
- getApiSecret() - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
- getApiToken() - Method in interface io.micronaut.email.postmark.PostmarkConfiguration
- getApiToken() - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
- getAttachments() - Method in class io.micronaut.email.Email.Builder
- getAttachments() - Method in class io.micronaut.email.Email
-
Returns this email's attachments.
- getBcc() - Method in class io.micronaut.email.Email.Builder
- getBcc() - Method in class io.micronaut.email.Email
-
Returns this email's "BCC" addresses.
- getBcc() - Method in interface io.micronaut.email.validation.Recipients
- getBody() - Method in class io.micronaut.email.Email.Builder
- getBody() - Method in class io.micronaut.email.Email
-
Returns this email's body.
- getCc() - Method in class io.micronaut.email.Email.Builder
- getCc() - Method in class io.micronaut.email.Email
-
Returns this email's "CC" addresses.
- getCc() - Method in interface io.micronaut.email.validation.Recipients
- getContent() - Method in class io.micronaut.email.Attachment
- getContentType() - Method in class io.micronaut.email.Attachment
- getDisposition() - Method in class io.micronaut.email.Attachment
- getEmail() - Method in class io.micronaut.email.configuration.FromConfigurationProperties
- getEmail() - Method in class io.micronaut.email.Contact
- getFilename() - Method in class io.micronaut.email.Attachment
- getFrom() - Method in interface io.micronaut.email.configuration.FromConfiguration
- getFrom() - Method in class io.micronaut.email.configuration.FromConfigurationProperties
- getFrom() - Method in class io.micronaut.email.Email.Builder
- getFrom() - Method in class io.micronaut.email.Email
-
Returns this email "From" address.
- getHtml() - Method in class io.micronaut.email.MultipartBody
- getId() - Method in class io.micronaut.email.Attachment
- getLogger() - Method in class io.micronaut.email.template.DefaultTemplateBodyDecorator
- getLogger() - Method in interface io.micronaut.email.template.TemplateBodyDecorator
- getModelAndView() - Method in class io.micronaut.email.template.TemplateBody
- getName() - Method in class io.micronaut.email.configuration.FromConfigurationProperties
-
The name of the contact sending the email.
- getName() - Method in class io.micronaut.email.Contact
- getName() - Method in class io.micronaut.email.DefaultAsyncEmailSender
- getName() - Method in class io.micronaut.email.DefaultEmailSender
- getName() - Method in class io.micronaut.email.javamail.sender.JavaxEmailSender
- getName() - Method in class io.micronaut.email.mailjet.MailjetEmailSender
- getName() - Method in class io.micronaut.email.postmark.PostmarkEmailSender
- getName() - Method in class io.micronaut.email.sendgrid.SendgridEmailSender
- getName() - Method in class io.micronaut.email.ses.AsyncSesEmailSender
- getName() - Method in class io.micronaut.email.ses.SesEmailSender
- getNameAddress() - Method in class io.micronaut.email.Contact
-
returns name-addr for a Contact.
- getPassword() - Method in interface io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfiguration
- getPassword() - Method in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
- getProperties() - Method in interface io.micronaut.email.javamail.sender.JavaMailConfiguration
- getProperties() - Method in class io.micronaut.email.javamail.sender.JavaMailConfigurationProperties
- getReplyTo() - Method in class io.micronaut.email.Email.Builder
- getReplyTo() - Method in class io.micronaut.email.Email
-
Returns this email's "Reply-To" address.
- getReplyToCollection() - Method in class io.micronaut.email.Email
-
Returns this email's "Reply-To" addresses.
- getReplyToList() - Method in class io.micronaut.email.Email.Builder
- getSubject() - Method in class io.micronaut.email.Email.Builder
- getSubject() - Method in class io.micronaut.email.Email
-
Returns this email's subject.
- getText() - Method in class io.micronaut.email.MultipartBody
- getTo() - Method in class io.micronaut.email.Email.Builder
- getTo() - Method in class io.micronaut.email.Email
-
Returns this email's "To" addresses.
- getTo() - Method in interface io.micronaut.email.validation.Recipients
- getTrackLinks() - Method in interface io.micronaut.email.postmark.PostmarkConfiguration
- getTrackLinks() - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
- getTrackOpens() - Method in interface io.micronaut.email.postmark.PostmarkConfiguration
- getTrackOpens() - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
- getUsername() - Method in interface io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfiguration
- getUsername() - Method in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
- getVersion() - Method in interface io.micronaut.email.mailjet.MailjetConfiguration
- getVersion() - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
- groups() - Element in annotation interface io.micronaut.email.validation.AnyRecipient
H
- hashCode() - Method in class io.micronaut.email.Contact
- HTML - Enum constant in enum class io.micronaut.email.BodyType
- HTML - Enum constant in enum class io.micronaut.email.TrackLinks
-
Whether to track links only in HTML emails.
- HTML_AND_TEXT - Enum constant in enum class io.micronaut.email.TrackLinks
-
Whether to track links in HTML and Plain text emails.
I
- id(String) - Method in class io.micronaut.email.Attachment.Builder
- io.micronaut.email - package io.micronaut.email
- io.micronaut.email.configuration - package io.micronaut.email.configuration
- io.micronaut.email.javamail.composer - package io.micronaut.email.javamail.composer
-
Classes related with the composing of
Message
. - io.micronaut.email.javamail.sender - package io.micronaut.email.javamail.sender
-
Classes related with the composing of
Message
. - io.micronaut.email.javamail.sender.authentication - package io.micronaut.email.javamail.sender.authentication
-
Configuration based authentication.
- io.micronaut.email.mailjet - package io.micronaut.email.mailjet
-
Mailjet integration related classes.
- io.micronaut.email.postmark - package io.micronaut.email.postmark
-
Postmark integration related classes.
- io.micronaut.email.sendgrid - package io.micronaut.email.sendgrid
-
SendGrid integration related classes.
- io.micronaut.email.ses - package io.micronaut.email.ses
-
Classes related with the integration with Amazon Simple Email Service.
- io.micronaut.email.template - package io.micronaut.email.template
- io.micronaut.email.test - package io.micronaut.email.test
- io.micronaut.email.validation - package io.micronaut.email.validation
- isEnabled() - Method in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
- isEnabled() - Method in class io.micronaut.email.javamail.sender.JavaMailConfigurationProperties
- isEnabled() - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
- isEnabled() - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
- isEnabled() - Method in class io.micronaut.email.sendgrid.SendGridConfigurationProperties
- isEnabled() - Method in class io.micronaut.email.ses.SesConfigurationProperties
- isValid(Recipients) - Static method in class io.micronaut.email.validation.RecipientsUtils
- isValid(Email, ConstraintValidatorContext) - Method in class io.micronaut.email.validation.AnyRecipientValidator
J
- JavaMailAuthenticationConfiguration - Interface in io.micronaut.email.javamail.sender.authentication
-
Java Mail authentication configuration.
- JavaMailAuthenticationConfigurationProperties - Class in io.micronaut.email.javamail.sender.authentication
-
ConfigurationProperties
implementation ofJavaMailAuthenticationConfiguration
. - JavaMailAuthenticationConfigurationProperties() - Constructor for class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
- JavaMailConfiguration - Interface in io.micronaut.email.javamail.sender
-
Java Mail configuration.
- JavaMailConfigurationProperties - Class in io.micronaut.email.javamail.sender
-
ConfigurationProperties
implementation ofJavaMailConfiguration
. - JavaMailConfigurationProperties() - Constructor for class io.micronaut.email.javamail.sender.JavaMailConfigurationProperties
- JavaxEmailComposer - Class in io.micronaut.email.javamail.sender
-
Composes a
Message
given anEmail
. - JavaxEmailComposer(SessionProvider, MessageComposer) - Constructor for class io.micronaut.email.javamail.sender.JavaxEmailComposer
- JavaxEmailSender - Class in io.micronaut.email.javamail.sender
-
Java Mail implementation of
TransactionalEmailSender
andAsyncTransactionalEmailSender
. - JavaxEmailSender(ExecutorService, JavaxEmailComposer) - Constructor for class io.micronaut.email.javamail.sender.JavaxEmailSender
M
- MailjetConfiguration - Interface in io.micronaut.email.mailjet
-
Integration with Mailjet.
- MailjetConfigurationProperties - Class in io.micronaut.email.mailjet
-
ConfigurationProperties
implementation ofMailjetConfiguration
. - MailjetConfigurationProperties() - Constructor for class io.micronaut.email.mailjet.MailjetConfigurationProperties
- MailjetEmailComposer - Class in io.micronaut.email.mailjet
-
Composes a
MailjetRequest
given anEmail
. - MailjetEmailComposer() - Constructor for class io.micronaut.email.mailjet.MailjetEmailComposer
- MailjetEmailSender - Class in io.micronaut.email.mailjet
- MailjetEmailSender(MailjetConfiguration, MailjetEmailComposer) - Constructor for class io.micronaut.email.mailjet.MailjetEmailSender
- mailProperties() - Method in interface io.micronaut.email.javamail.sender.MailPropertiesProvider
- MailPropertiesProvider - Interface in io.micronaut.email.javamail.sender
-
Providers
Properties
for Mail session. - MailPropertiesProviderFactory - Class in io.micronaut.email.javamail.sender
-
Builds a
MailPropertiesProvider
if the properties are set atJavaMailConfiguration
. - MailPropertiesProviderFactory() - Constructor for class io.micronaut.email.javamail.sender.MailPropertiesProviderFactory
- MailTestUtils - Class in io.micronaut.email.test
-
Utility to read and delete emails from a Gmail inbox.
- MailTestUtils() - Constructor for class io.micronaut.email.test.MailTestUtils
- message() - Element in annotation interface io.micronaut.email.validation.AnyRecipient
- MESSAGE - Static variable in annotation interface io.micronaut.email.validation.AnyRecipient
-
AnyRecipient message.
- MessageComposer - Interface in io.micronaut.email.javamail.composer
-
Creates a
Message
for the givenEmail
. - MultipartBody - Class in io.micronaut.email
-
Multipart bodies represent an HTML and text version of the same body content.
- MultipartBody(Body, Body) - Constructor for class io.micronaut.email.MultipartBody
- MultipartBody(Body, String) - Constructor for class io.micronaut.email.MultipartBody
- MultipartBody(String, Body) - Constructor for class io.micronaut.email.MultipartBody
- MultipartBody(String, String) - Constructor for class io.micronaut.email.MultipartBody
N
- NAME - Static variable in class io.micronaut.email.javamail.sender.JavaxEmailSender
-
JavaxEmailSender
name. - NAME - Static variable in class io.micronaut.email.mailjet.MailjetEmailSender
-
MailjetEmailSender
name. - NAME - Static variable in class io.micronaut.email.postmark.PostmarkEmailSender
-
PostmarkEmailSender
name. - NAME - Static variable in class io.micronaut.email.sendgrid.SendgridEmailSender
-
SendgridEmailSender
name. - NAME - Static variable in class io.micronaut.email.ses.AsyncSesEmailSender
-
AsyncSesEmailSender
name. - NAME - Static variable in class io.micronaut.email.ses.SesEmailSender
-
SesEmailSender
name.
P
- payload() - Element in annotation interface io.micronaut.email.validation.AnyRecipient
- PostmarkConfiguration - Interface in io.micronaut.email.postmark
-
Defines Configuration for Postmark integration.
- PostmarkConfigurationProperties - Class in io.micronaut.email.postmark
-
ConfigurationProperties
implementation ofPostmarkConfiguration
. - PostmarkConfigurationProperties() - Constructor for class io.micronaut.email.postmark.PostmarkConfigurationProperties
- PostmarkEmailComposer - Class in io.micronaut.email.postmark
-
Composes a
Message
given anEmail
. - PostmarkEmailComposer(PostmarkConfiguration) - Constructor for class io.micronaut.email.postmark.PostmarkEmailComposer
- PostmarkEmailSender - Class in io.micronaut.email.postmark
- PostmarkEmailSender(ExecutorService, PostmarkConfiguration, PostmarkEmailComposer) - Constructor for class io.micronaut.email.postmark.PostmarkEmailSender
- PREFIX - Static variable in class io.micronaut.email.configuration.FromConfigurationProperties
-
From configuration prefix.
- PREFIX - Static variable in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
-
Authentication configuration prefix.
- PREFIX - Static variable in class io.micronaut.email.javamail.sender.JavaMailConfigurationProperties
-
javamail prefix.
- PREFIX - Static variable in class io.micronaut.email.mailjet.MailjetConfigurationProperties
-
mailjet prefix.
- PREFIX - Static variable in class io.micronaut.email.postmark.PostmarkConfigurationProperties
-
postmark prefix.
- PREFIX - Static variable in class io.micronaut.email.sendgrid.SendGridConfigurationProperties
-
sendgrid prefix.
- PREFIX - Static variable in class io.micronaut.email.ses.SesConfigurationProperties
-
SES prefix.
R
- Recipients - Interface in io.micronaut.email.validation
-
Email Recipients.
- RecipientsUtils - Class in io.micronaut.email.validation
-
Utility class for
Recipients
. - RecipientsUtils() - Constructor for class io.micronaut.email.validation.RecipientsUtils
- renderBody(TemplateBody<?>, BodyType) - Method in interface io.micronaut.email.template.TemplateBodyDecorator
- replyTo(Contact) - Method in class io.micronaut.email.Email.Builder
- replyTo(String) - Method in class io.micronaut.email.Email.Builder
- resolveViewsRenderer(BodyType, String, Object) - Method in class io.micronaut.email.template.DefaultTemplateBodyDecorator
- resolveViewsRenderer(BodyType, String, Object) - Method in interface io.micronaut.email.template.TemplateBodyDecorator
- runningOnCI() - Static method in class io.micronaut.email.test.CiUtils
S
- send(Email) - Method in interface io.micronaut.email.TransactionalEmailSender
-
Sends an email.
- send(Email, Consumer<MailjetRequest>) - Method in class io.micronaut.email.mailjet.MailjetEmailSender
- send(Email, Consumer<Message>) - Method in class io.micronaut.email.postmark.PostmarkEmailSender
- send(Email, Consumer<Request>) - Method in class io.micronaut.email.sendgrid.SendgridEmailSender
- send(Email, Consumer<I>) - Method in interface io.micronaut.email.TransactionalEmailSender
-
Sends an email.
- send(Email, Consumer<Message>) - Method in class io.micronaut.email.javamail.sender.JavaxEmailSender
- send(Email, Consumer<SesRequest>) - Method in class io.micronaut.email.ses.SesEmailSender
-
Sends an email.
- send(Email.Builder) - Method in interface io.micronaut.email.EmailSender
-
Sends an email.
- send(Email.Builder, Consumer<I>) - Method in class io.micronaut.email.DefaultEmailSender
- send(Email.Builder, Consumer<I>) - Method in interface io.micronaut.email.EmailSender
-
Sends an email.
- sendAsync(Email) - Method in interface io.micronaut.email.AsyncTransactionalEmailSender
-
Sends an email.
- sendAsync(Email, Consumer<MailjetRequest>) - Method in class io.micronaut.email.mailjet.MailjetEmailSender
- sendAsync(Email, Consumer<Request>) - Method in class io.micronaut.email.sendgrid.SendgridEmailSender
- sendAsync(Email, Consumer<I>) - Method in interface io.micronaut.email.AsyncTransactionalEmailSender
-
Sends an email.
- sendAsync(Email, Consumer<SesRequest>) - Method in class io.micronaut.email.ses.AsyncSesEmailSender
-
Sends an email.
- sendAsync(Email, Consumer<I>) - Method in class io.micronaut.email.AbstractTransactionalEmailSender
- sendAsync(Email.Builder) - Method in interface io.micronaut.email.AsyncEmailSender
-
Sends an email.
- sendAsync(Email.Builder, Consumer<I>) - Method in interface io.micronaut.email.AsyncEmailSender
-
Sends an email.
- sendAsync(Email.Builder, Consumer<I>) - Method in class io.micronaut.email.DefaultAsyncEmailSender
- SendGridConfiguration - Interface in io.micronaut.email.sendgrid
-
Defines Configuration for SendGrid integration.
- SendGridConfigurationProperties - Class in io.micronaut.email.sendgrid
-
ConfigurationProperties
implementation ofSendGridConfiguration
. - SendGridConfigurationProperties() - Constructor for class io.micronaut.email.sendgrid.SendGridConfigurationProperties
- SendgridEmailComposer - Class in io.micronaut.email.sendgrid
-
Composes
Request
forEmail
. - SendgridEmailComposer() - Constructor for class io.micronaut.email.sendgrid.SendgridEmailComposer
- SendgridEmailSender - Class in io.micronaut.email.sendgrid
- SendgridEmailSender(SendGridConfiguration, SendgridEmailComposer) - Constructor for class io.micronaut.email.sendgrid.SendgridEmailSender
- SesConfiguration - Interface in io.micronaut.email.ses
-
Integration with Amazon Simple Email Service.
- SesConfigurationProperties - Class in io.micronaut.email.ses
-
ConfigurationProperties
implementation ofSesConfiguration
. - SesConfigurationProperties() - Constructor for class io.micronaut.email.ses.SesConfigurationProperties
- SesEmailComposer - Class in io.micronaut.email.ses
- SesEmailComposer(MessageComposer) - Constructor for class io.micronaut.email.ses.SesEmailComposer
- SesEmailSender - Class in io.micronaut.email.ses
-
Amazon Simple Email Service implementation of
TransactionalEmailSender
. - SesEmailSender(SesClient, SesEmailComposer) - Constructor for class io.micronaut.email.ses.SesEmailSender
- session() - Method in class io.micronaut.email.javamail.sender.DefaultSessionProvider
- session() - Method in interface io.micronaut.email.javamail.sender.SessionProvider
- SessionProvider - Interface in io.micronaut.email.javamail.sender
-
Provides a Session.
- setApiKey(String) - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
-
Mailjet API Key.
- setApiKey(String) - Method in class io.micronaut.email.sendgrid.SendGridConfigurationProperties
- setApiSecret(String) - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
-
Mailjet API Secret.
- setApiToken(String) - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
-
Postmark API token.
- setBody(String) - Method in class io.micronaut.email.template.TemplateBody
- setEmail(String) - Method in class io.micronaut.email.configuration.FromConfigurationProperties
-
Default from email address.
- setEnabled(boolean) - Method in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
-
If authentication is enabled.
- setEnabled(boolean) - Method in class io.micronaut.email.javamail.sender.JavaMailConfigurationProperties
-
If Mailjet integration is enabled.
- setEnabled(boolean) - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
-
If Mailjet integration is enabled.
- setEnabled(boolean) - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
-
If Postmark integration is enabled.
- setEnabled(boolean) - Method in class io.micronaut.email.sendgrid.SendGridConfigurationProperties
-
If SendGrid integration is enabled.
- setEnabled(boolean) - Method in class io.micronaut.email.ses.SesConfigurationProperties
-
If Amazon Simple Email Service integration is enabled.
- setName(String) - Method in class io.micronaut.email.configuration.FromConfigurationProperties
- setPassword(String) - Method in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
-
Authentication password.
- setProperties(Map<String, Object>) - Method in class io.micronaut.email.javamail.sender.JavaMailConfigurationProperties
-
properties as listed in Appendix A of the JavaMail spec (particularly mail.store.protocol, mail.transport.protocol, mail.host, mail.user, and mail.from).
- setTrackLinks(TrackLinks) - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
-
Whether to track the email's links.
- setTrackOpens(boolean) - Method in class io.micronaut.email.postmark.PostmarkConfigurationProperties
-
Whether to track if the email is opened.
- setUsername(String) - Method in class io.micronaut.email.javamail.sender.authentication.JavaMailAuthenticationConfigurationProperties
-
Authentication username.
- setVersion(String) - Method in class io.micronaut.email.mailjet.MailjetConfigurationProperties
-
Mailjet API Version.
- spreadsheet() - Static method in class io.micronaut.email.test.SpreadsheetUtils
- SpreadsheetUtils - Class in io.micronaut.email.test
- SpreadsheetUtils() - Constructor for class io.micronaut.email.test.SpreadsheetUtils
- StringBody - Class in io.micronaut.email
-
Email body backed by a String.
- StringBody(String) - Constructor for class io.micronaut.email.StringBody
- StringBody(String, BodyType) - Constructor for class io.micronaut.email.StringBody
- subject(String) - Method in class io.micronaut.email.Email.Builder
T
- TemplateBody<T> - Class in io.micronaut.email.template
-
Email HTML Body backed by a template.
- TemplateBody(BodyType, ModelAndView<T>) - Constructor for class io.micronaut.email.template.TemplateBody
- TemplateBody(BodyType, String, T) - Constructor for class io.micronaut.email.template.TemplateBody
- TemplateBody(ModelAndView<T>) - Constructor for class io.micronaut.email.template.TemplateBody
- TemplateBody(String, T) - Constructor for class io.micronaut.email.template.TemplateBody
-
Body HTML with view name and model.
- TemplateBodyDecorator - Interface in io.micronaut.email.template
-
Decorates emails whose text or html is of type
TemplateBody
by rendering those templates. - TEXT - Enum constant in enum class io.micronaut.email.BodyType
- TEXT - Enum constant in enum class io.micronaut.email.TrackLinks
-
Whether to track links only in Plain text emails.
- to(Contact) - Method in class io.micronaut.email.Email.Builder
- to(String) - Method in class io.micronaut.email.Email.Builder
- TrackLinks - Enum Class in io.micronaut.email
-
Whether to track if the links are clicked in an email.
- TransactionalEmailSender<I,
O> - Interface in io.micronaut.email -
API to be implemented by third party transactional email providers.
- TYPE_TEXT_HTML_CHARSET_UTF_8 - Static variable in class io.micronaut.email.javamail.composer.DefaultMessageComposer
- TYPE_TEXT_PLAIN_CHARSET_UTF_8 - Static variable in class io.micronaut.email.javamail.composer.DefaultMessageComposer
V
- valueOf(String) - Static method in enum class io.micronaut.email.BodyType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.email.TrackLinks
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.micronaut.email.BodyType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.email.TrackLinks
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
AnyRecipientValidator
is used instead. The {@link @Factory} annotation was intentionally removed. Thus, this class does nothing.