Package io.jmix.notifications.channel.impl

Class EmailNotificationChannel

java.lang.Object

io.jmix.notifications.channel.impl.EmailNotificationChannel

All Implemented Interfaces:

NotificationChannel

public class EmailNotificationChannel
extends Object
implements NotificationChannel

Notification channel that sends notification by email.

Uses 'Email' addon to send notifications. This channel is available only if 'Email' dependency is included into project.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Emailer	emailer
protected final List<UserEmailResolver>	emailResolvers
static final String	NAME
protected final UserRepository	userRepository

Constructor Summary

Constructors

Constructor	Description
EmailNotificationChannel(UserRepository userRepository, Emailer emailer, List<UserEmailResolver> emailResolvers)

Method Summary

Modifier and Type	Method	Description
String	getName()	Provides unique name of channel.
protected Optional<String>	resolveEmail(org.springframework.security.core.userdetails.UserDetails user)
boolean	send(Notification notification)	Sends provided notification via this notification channel.
protected boolean	sendEmail(String email, Notification notification)

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

userRepository

protected final UserRepository userRepository

emailer

protected final Emailer emailer

emailResolvers

protected final List<UserEmailResolver> emailResolvers

Constructor Details

EmailNotificationChannel

public EmailNotificationChannel(UserRepository userRepository,
 Emailer emailer,
 List<UserEmailResolver> emailResolvers)

Method Details

getName

public String getName()

Description copied from interface: NotificationChannel

Provides unique name of channel.

Specified by:

getName in interface NotificationChannel

Returns:

channel name

send

public boolean send(Notification notification)

Description copied from interface: NotificationChannel

Sends provided notification via this notification channel.

Specified by:

send in interface NotificationChannel

Parameters:

notification - notification

Returns:

true if notification was successfully sent, false otherwise

resolveEmail

protected Optional<String> resolveEmail(org.springframework.security.core.userdetails.UserDetails user)

sendEmail

protected boolean sendEmail(String email,
 Notification notification)