Class MailHealthIndicator

java.lang.Object

org.springframework.boot.health.contributor.AbstractHealthIndicator

org.springframework.boot.mail.health.MailHealthIndicator

All Implemented Interfaces:

HealthContributor, HealthIndicator

public class MailHealthIndicator
extends AbstractHealthIndicator

HealthIndicator for configured smtp server(s).

Since:

4.0.0

Author:

Johannes Edmeier, Scott Frederick

Constructor Summary

Constructors

Constructor	Description
MailHealthIndicator(JavaMailSenderImpl mailSender)

Method Summary

Modifier and Type	Method	Description
protected void	doHealthCheck(Health.Builder builder)	Actual health check logic.

Methods inherited from class org.springframework.boot.health.contributor.AbstractHealthIndicator

health

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.boot.health.contributor.HealthIndicator

health

Constructor Details

MailHealthIndicator

public MailHealthIndicator(JavaMailSenderImpl mailSender)

Method Details

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

Exception - any Exception that should create a Status.DOWN system status.