Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Small fixes and improvements to the reference documentation #29694

Closed
wants to merge 10 commits into from
Closed

Small fixes and improvements to the reference documentation #29694

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8400150
Remove mention that users could be on Java < 5
simonbasle Dec 15, 2022
4bcc1f3
Fix typo 'can can'
simonbasle Dec 15, 2022
355bade
Rework linking to Sprinv MVC Async support vs WebFlux section
simonbasle Dec 15, 2022
c878044
Fix subsection style in WebFlux Concurrency Model
simonbasle Dec 15, 2022
6cfcd21
Fix typo: Inn -> In
simonbasle Dec 15, 2022
627a7ab
Turn plain 'WebFlux' links to 'See equivalent in the Reactive stack'
simonbasle Dec 15, 2022
068f188
Turn plain 'WebMVC' links to 'See equivalent in the Servlet stack'
simonbasle Dec 15, 2022
f6344f1
Fix links to Jakarta Mail 1.6
simonbasle Dec 15, 2022
d474f06
Remove ref to JOTM, inactive since 2009
simonbasle Dec 15, 2022
84bab71
Revert mention of Jakarta Mail v1.x branch, just keep the fixed link
simonbasle Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion framework-docs/src/docs/asciidoc/integration/email.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ This section describes how to send email with the Spring Framework.
The following JAR needs to be on the classpath of your application in order to use
the Spring Framework's email library:

* The https://eclipse-ee4j.github.io/mail/[JavaMail / Jakarta Mail 1.6] library
* The https://jakartaee.github.io/mail-api/[JavaMail / Jakarta Mail 1.6] library

This library is freely available on the web -- for example, in Maven Central as
`com.sun.mail:jakarta.mail`. Please make sure to use the latest 1.6.x version
rather than Jakarta Mail 2.0 (which comes with a different package namespace).
See the `v1.x` code in the https://github.com/jakartaee/mail-api/tree/v1.x[Jakarta Mail-Api repository].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless I'm missing something, this whole section is wrong regarding the versions.

We currently compile against jakarta.mail:jakarta.mail-api:2.0.1 for our e-mail support (pulling in dependencies on things like jakarta.mail.Message). So users of Spring Framework 6.0 must use Jakarta Mail 2.0+.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eh, I made this change on the basis that the 1.6.x mention was correct, primarily because the link was 404. perhaps this needs to be evaluated / reworked separately then ? (with a specific backport to 5.3.x that looks like the edits I made)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed a commit that removes that github link. So the content referring 1.6 is still probably wrong, but at least the Jakarta Mail link is fixed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made this change on the basis that the 1.6.x mention was correct,

Yes, I assumed that was the case. This is all coming from the 5.3.x version of the docs and was just an oversight (that it hasn't yet been updated in the 6.0.x docs).

I didn't mean to imply that you made an error with the versions. Rather, I just happened to notice it, because you modified that section. 😉

perhaps this needs to be evaluated / reworked separately then ? (with a specific backport to 5.3.x that looks like the edits I made)

Yes. 👍

Would you like to handle that? If not, I can take care of it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I'll just go ahead and address that.

****

The Spring Framework provides a helpful utility library for sending email that shields
Expand Down