Add documentation for email integration

Closes gh-1904
This commit is contained in:
Stephane Nicoll 2014-11-17 14:43:46 +01:00
parent 25428a32ad
commit 8112aca9e8
2 changed files with 21 additions and 0 deletions

View File

@ -313,6 +313,14 @@ content into your application; rather pick only the properties that you need.
spring.jms.jndi-name= # JNDI location of a JMS ConnectionFactory
spring.jms.pub-sub-domain= # false for queue (default), true for topic
# Email ({sc-spring-boot-autoconfigure}/mail/MailProperties.{sc-ext}[MailProperties])
spring.mail.host=smtp.acme.org # mail server host
spring.mail.port= # mail server port
spring.mail.username=
spring.mail.password=
spring.mail.default-encoding=UTF-8 # encoding to use for MimeMessages
spring.mail.properties.*= # properties to set on the JavaMail session
# SPRING BATCH ({sc-spring-boot-autoconfigure}/batch/BatchDatabaseInitializer.{sc-ext}[BatchDatabaseInitializer])
spring.batch.job.names=job1,job2
spring.batch.job.enabled=true

View File

@ -2025,6 +2025,19 @@ The following component creates a listener endpoint on the `someQueue` destinati
Check {spring-javadoc}/jms/annotation/EnableJms.{dc-ext}[the javadoc of `@EnableJms`]
for more details.
[[boot-features-mail]]
== Mail integration
The Spring Framework provides an easy abstraction for sending email using the `JavaMailSender`
interface and Spring Boot provides auto-configuration for it as well as a starter module.
TIP: Check the {spring-reference}/#mail[reference documentation] for a detailed explanation
of how you can use `JavaMailSender`.
If `spring.mail.host` and the relevant libraries (as defined by `spring-boot-starter-mail`)
are available, a default `JavaMailSender` is created if none exists. The sender can be
further customized by configuration items from the `spring.mail` namespace, see the
{sc-spring-boot-autoconfigure}/mail/MailProperties.{sc-ext}[`MailProperties`] for more details.
[[boot-features-jta]]
== Distributed Transactions with JTA
Spring Boot supports distributed JTA transactions across multiple XA resources using