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
TransactionalEmailSenderandAsyncTransactionalEmailSender. - AbstractTransactionalEmailSender(ExecutorService) - Constructor for class io.micronaut.email.AbstractTransactionalEmailSender
- ANY_RECIPIENT_MESSAGE - Static variable in class io.micronaut.email.validation.EmailMessages
-
AnyRecipientmessage. - 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.
- 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.
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
- 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
C
- cc(Contact) - Method in class io.micronaut.email.Email.Builder
- cc(String) - Method in class io.micronaut.email.Email.Builder
- compose(Email) - Method in interface io.micronaut.email.EmailComposer
- compose(Email, Consumer<I>) - Method in interface io.micronaut.email.EmailComposer
- 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
D
- decorate(Email.Builder) - Method in interface io.micronaut.email.EmailDecorator
-
Populates an email.
- decorate(Email.Builder) - Method in class io.micronaut.email.FromDecorator
- DefaultAsyncEmailSender<I,
O> - Class in io.micronaut.email -
Decorates with every
EmailDecoratorand 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
EmailDecoratorand send an email via aTransactionalEmailSender. - DefaultEmailSender(TransactionalEmailSender<I, O>, List<EmailDecorator>) - Constructor for class io.micronaut.email.DefaultEmailSender
- 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
EmailSenderor 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.
- 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
FromConfigurationdefines the default sender. - FromConfigurationProperties - Class in io.micronaut.email.configuration
-
ConfigurationPropertiesimplementation 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
- 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
- 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
- getNameAddress() - Method in class io.micronaut.email.Contact
-
returns name-addr for a Contact.
- 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
- 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.validation - package io.micronaut.email.validation
- isValid(Recipients) - Static method in class io.micronaut.email.validation.RecipientsUtils
- isValid(Email, ConstraintValidatorContext) - Method in class io.micronaut.email.validation.AnyRecipientValidator
M
- message() - Element in annotation interface io.micronaut.email.validation.AnyRecipient
- MESSAGE - Static variable in annotation interface io.micronaut.email.validation.AnyRecipient
-
AnyRecipient message.
- 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
P
- payload() - Element in annotation interface io.micronaut.email.validation.AnyRecipient
- PREFIX - Static variable in class io.micronaut.email.configuration.FromConfigurationProperties
-
From configuration 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
- replyTo(Contact) - Method in class io.micronaut.email.Email.Builder
- replyTo(String) - Method in class io.micronaut.email.Email.Builder
S
- send(Email) - Method in interface io.micronaut.email.TransactionalEmailSender
-
Sends an email.
- send(Email, Consumer<I>) - Method in interface io.micronaut.email.TransactionalEmailSender
-
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<I>) - Method in interface io.micronaut.email.AsyncTransactionalEmailSender
-
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
- setEmail(String) - Method in class io.micronaut.email.configuration.FromConfigurationProperties
-
Default from email address.
- setName(String) - Method in class io.micronaut.email.configuration.FromConfigurationProperties
- 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
- 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.
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
AnyRecipientValidatoris used instead. The {@link @Factory} annotation was intentionally removed. Thus, this class does nothing.