Package io.quarkus.mailer

Interface MailTemplate.MailTemplateInstance

All Known Implementing Classes:

MailTemplateInstanceImpl

Enclosing interface:

MailTemplate

public static interface MailTemplate.MailTemplateInstance

Represents an instance of MailTemplate.

This construct is not thread-safe.

Method Summary

Modifier and Type	Method	Description
default MailTemplate.MailTemplateInstance	addAttachment(String name, byte[] data, String contentType)
default MailTemplate.MailTemplateInstance	addAttachment(String name, File file, String contentType)
default MailTemplate.MailTemplateInstance	addInlineAttachment(String name, byte[] data, String contentType, String contentId)
default MailTemplate.MailTemplateInstance	addInlineAttachment(String name, File file, String contentType, String contentId)
default MailTemplate.MailTemplateInstance	bcc(String... bcc)
default MailTemplate.MailTemplateInstance	bounceAddress(String bounceAddress)
default MailTemplate.MailTemplateInstance	cc(String... cc)
default MailTemplate.MailTemplateInstance	data(String key, Object value)
default MailTemplate.MailTemplateInstance	from(String from)
default MailTemplate.MailTemplateInstance	mail(Mail mail)
default MailTemplate.MailTemplateInstance	replyTo(String replyTo)
default MailTemplate.MailTemplateInstance	replyTo(String... replyTo)
default io.smallrye.mutiny.Uni<Void>	send()	Sends all e-mail definitions based on available template variants, i.e.
default void	sendAndAwait()	Sends all e-mail definitions and blocks the current thread while waiting for the result.
default MailTemplate.MailTemplateInstance	setAttribute(String key, Object value)
default MailTemplate.MailTemplateInstance	subject(String subject)
default io.quarkus.qute.TemplateInstance	templateInstance()	The returned instance does not represent a specific template but a delegating template.
default MailTemplate.MailTemplateInstance	to(String... to)

Method Details

mail

default MailTemplate.MailTemplateInstance mail(Mail mail)

to

default MailTemplate.MailTemplateInstance to(String... to)

cc

default MailTemplate.MailTemplateInstance cc(String... cc)

bcc

default MailTemplate.MailTemplateInstance bcc(String... bcc)

subject

default MailTemplate.MailTemplateInstance subject(String subject)

from

default MailTemplate.MailTemplateInstance from(String from)

replyTo

default MailTemplate.MailTemplateInstance replyTo(String replyTo)

replyTo

default MailTemplate.MailTemplateInstance replyTo(String... replyTo)

bounceAddress

default MailTemplate.MailTemplateInstance bounceAddress(String bounceAddress)

addInlineAttachment

default MailTemplate.MailTemplateInstance addInlineAttachment(String name,
 File file,
 String contentType,
 String contentId)

addInlineAttachment

default MailTemplate.MailTemplateInstance addInlineAttachment(String name,
 byte[] data,
 String contentType,
 String contentId)

addAttachment

default MailTemplate.MailTemplateInstance addAttachment(String name,
 File file,
 String contentType)

addAttachment

default MailTemplate.MailTemplateInstance addAttachment(String name,
 byte[] data,
 String contentType)

data

default MailTemplate.MailTemplateInstance data(String key,
 Object value)

Parameters:

key -

value -

Returns:

self

See Also:

• TemplateInstance.data(String, Object)

setAttribute

default MailTemplate.MailTemplateInstance setAttribute(String key,
 Object value)

Parameters:

key -

value -

Returns:

self

See Also:

• TemplateInstance.setAttribute(String, Object)

send

@CheckReturnValue
default io.smallrye.mutiny.Uni<Void> send()

Sends all e-mail definitions based on available template variants, i.e. text/html and text/plain template variants.

Returns:

a Uni indicating when the mails have been sent

See Also:

• ReactiveMailer.send(Mail...)

sendAndAwait

default void sendAndAwait()

Sends all e-mail definitions and blocks the current thread while waiting for the result.

See Also:

• send()

templateInstance

default io.quarkus.qute.TemplateInstance templateInstance()

The returned instance does not represent a specific template but a delegating template.

You can select the corresponding variant via TemplateInstance.setAttribute(String, Object) where the attribute key is TemplateInstance.SELECTED_VARIANT. If no variant is selected, the default instance is used.

Returns:

the underlying template instance