Allows the MailTemplate to produce / return the sent Mail.

Relates to quarkusio#45135
cescoffier · Dec 16, 2024 · a7177aa · a7177aa
1 parent 5e6fb77
commit a7177aa
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 8 deletions.
diff --git a/extensions/mailer/deployment/src/test/java/io/quarkus/mailer/MailTemplateLocationTest.java b/extensions/mailer/deployment/src/test/java/io/quarkus/mailer/MailTemplateLocationTest.java
@@ -5,6 +5,7 @@
 import jakarta.inject.Inject;
 import jakarta.inject.Singleton;
 
+import org.assertj.core.api.Assertions;
 import org.jboss.shrinkwrap.api.asset.StringAsset;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -29,6 +30,8 @@ public class MailTemplateLocationTest {
     @Test
     public void testLocation() {
         mailTemplates.send().await().atMost(Duration.ofSeconds(5));
+        Assertions.assertThat(mailTemplates.sendAndGetMail().await().atMost(Duration.ofSeconds(5))).isNotNull();
+        Assertions.assertThat(mailTemplates.sendAndAwait()).isNotNull();
     }
 
     @Singleton
@@ -41,5 +44,15 @@ static class MailTemplates {
         Uni<Void> send() {
             return confirmationMailTemplate.to("quarkus@quarkus.io").subject("Test").data("name", "Foo").send();
         }
+
+        Uni<Mail> sendAndGetMail() {
+            return confirmationMailTemplate.to("quarkus@quarkus.io").subject("Test").data("name", "Foo")
+                    .sendAndGetMail();
+        }
+
+        Mail sendAndAwait() {
+            return confirmationMailTemplate.to("quarkus@quarkus.io").subject("Test").data("name", "Foo")
+                    .sendAndAwait();
+        }
     }
 }
diff --git a/extensions/mailer/runtime/src/main/java/io/quarkus/mailer/MailTemplate.java b/extensions/mailer/runtime/src/main/java/io/quarkus/mailer/MailTemplate.java
@@ -115,11 +115,24 @@ default MailTemplateInstance setAttribute(String key, Object value) {
          * Sends all e-mail definitions based on available template variants, i.e. {@code text/html} and {@code text/plain}
          * template variants.
          *
-         * @return a {@link Uni} indicating when the mails have been sent
+         * @return a {@link Uni} indicating when the mail has been sent
          * @see ReactiveMailer#send(Mail...)
          */
         @CheckReturnValue
         default Uni<Void> send() {
+            return sendAndGetMail().replaceWithVoid();
+        }
+
+        /**
+         * Sends all e-mail definitions based on available template variants, i.e. {@code text/html} and {@code text/plain}
+         * template variants.
+         *
+         * @return a {@link Uni} indicating when the mail has been sent. Unlike {{@link #send()}}, this method returns the sent
+         *         {@link Mail} object.
+         * @see ReactiveMailer#send(Mail...)
+         */
+        @CheckReturnValue
+        default Uni<Mail> sendAndGetMail() {
             throw new UnsupportedOperationException();
         }
 
@@ -128,8 +141,8 @@ default Uni<Void> send() {
          *
          * @see #send()
          */
-        default void sendAndAwait() {
-            send().await().indefinitely();
+        default Mail sendAndAwait() {
+            return sendAndGetMail().await().indefinitely();
         }
 
         /**

diff --git a/...ions/mailer/runtime/src/main/java/io/quarkus/mailer/runtime/MailTemplateInstanceImpl.java b/...ions/mailer/runtime/src/main/java/io/quarkus/mailer/runtime/MailTemplateInstanceImpl.java
@@ -124,7 +124,7 @@ public TemplateInstance templateInstance() {
     }
 
     @Override
-    public Uni<Void> send() {
+    public Uni<Mail> sendAndGetMail() {
         Object variantsAttr = templateInstance.getAttribute(TemplateInstance.VARIANTS);
         if (variantsAttr != null) {
             List<Result> results = new ArrayList<>();
@@ -148,11 +148,11 @@ public CompletionStage<? extends String> get() {
             }
             List<Uni<String>> unis = results.stream().map(Result::resolve).collect(Collectors.toList());
             return Uni.combine().all().unis(unis)
-                    .combinedWith(combine(results))
-                    .chain(new Function<Mail, Uni<? extends Void>>() {
+                    .with(combine(results))
+                    .chain(new Function<Mail, Uni<? extends Mail>>() {
                         @Override
-                        public Uni<? extends Void> apply(Mail m) {
-                            return mailer.send(m);
+                        public Uni<? extends Mail> apply(Mail m) {
+                            return mailer.send(m).replaceWith(m);
                         }
                     });
         } else {