diff --git a/docs/src/main/asciidoc/mailer-reference.adoc b/docs/src/main/asciidoc/mailer-reference.adoc index ce3ed5b03802c..93c24854938dd 100644 --- a/docs/src/main/asciidoc/mailer-reference.adoc +++ b/docs/src/main/asciidoc/mailer-reference.adoc @@ -264,7 +264,7 @@ Note that does not mean that the message is delivered, just that it's been sent Because it is very inconvenient to send emails during development and testing, you can set the `quarkus.mailer.mock` boolean configuration to `true` to prevent the actual sending of emails but instead print them on stdout and collect them in a `MockMailbox` bean instead. -This is the default if you are running Quarkus in `DEV` or `TEST` mode. +This is the default if you are running Quarkus in dev or test mode. You can then write tests to verify that your emails were sent, for example, by a REST endpoint: @@ -305,6 +305,9 @@ class MailTest { } ---- +Another option is to use the https://github.com/quarkiverse/quarkus-mailpit[Quarkus Mailpit] extension +which provides Dev Services for https://github.com/axllent/mailpit[Mailpit], a nice UI for testing and debugging email sending. + == Using the underlying Vert.x Mail Client The Quarkus Mailer is implemented on top of the https://vertx.io/docs/vertx-mail-client/java/[Vert.x Mail Client], providing an asynchronous and non-blocking way to send emails. diff --git a/docs/src/main/asciidoc/mailer.adoc b/docs/src/main/asciidoc/mailer.adoc index 1ca7161aadb0a..26f4bc34a74ac 100644 --- a/docs/src/main/asciidoc/mailer.adoc +++ b/docs/src/main/asciidoc/mailer.adoc @@ -148,6 +148,12 @@ It prints it in the log, so you can check that what was about to be sent. NOTE: This section used the _imperative_ mailer API. It blocks the caller thread until the mail is sent. +[TIP] +==== +The https://github.com/quarkiverse/quarkus-mailpit[Quarkus Mailpit] extension is very handy for testing emails. +It provides Dev Services for https://github.com/axllent/mailpit[Mailpit], a nice UI for testing and debugging email sending. +==== + == Using the reactive mailer The last section use the _imperative_ mailer. @@ -223,7 +229,7 @@ The xref:mailer-reference.adoc[mailer reference guide] provides more details abo * xref:mailer-reference.adoc#html[how to format the email as HTML and use inline attachments] * xref:mailer-reference.adoc#templates[how to use Qute templates] * xref:mailer-reference.adoc#testing[how to test applications sending emails] -* xref:mailer-reference.adoc#gmail-specific-configuration[how to configure the mailer to send emails with GMAIL] +* xref:mailer-reference.adoc#popular[how to configure the mailer for popular email services (e.g. Gmail, AWS SES)]