Package org.keycloak.email

Class DefaultEmailSenderProvider

java.lang.Object

org.keycloak.email.DefaultEmailSenderProvider

All Implemented Interfaces:

EmailSenderProvider, Provider

public class DefaultEmailSenderProvider
extends Object
implements EmailSenderProvider

Author:

Stian Thorgersen

Field Summary

Fields inherited from interface org.keycloak.email.EmailSenderProvider

CONFIG_ALLOW_UTF8

Constructor Summary

Constructors

Constructor	Description
DefaultEmailSenderProvider(KeycloakSession session, Map<EmailAuthenticator.AuthenticatorType,EmailAuthenticator> authenticators)

Method Summary

Modifier and Type	Method	Description
void	close()
protected String	retrieveEmailAddress(UserModel user)
void	send(Map<String,String> config, String address, String subject, String textBody, String htmlBody)
void	send(Map<String,String> config, UserModel user, String subject, String textBody, String htmlBody)
protected jakarta.mail.internet.InternetAddress	toInternetAddress(String email, String displayName)
void	validate(Map<String,String> config)	Validates configuration for the SMTP sender.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEmailSenderProvider

public DefaultEmailSenderProvider(KeycloakSession session,
 Map<EmailAuthenticator.AuthenticatorType,EmailAuthenticator> authenticators)

Method Details

send

public void send(Map<String,String> config,
 UserModel user,
 String subject,
 String textBody,
 String htmlBody)
          throws EmailException

Specified by:

send in interface EmailSenderProvider

Throws:

EmailException

send

public void send(Map<String,String> config,
 String address,
 String subject,
 String textBody,
 String htmlBody)
          throws EmailException

Specified by:

send in interface EmailSenderProvider

Throws:

EmailException

validate

public void validate(Map<String,String> config)
              throws EmailException

Description copied from interface: EmailSenderProvider

Validates configuration for the SMTP sender.

Specified by:

validate in interface EmailSenderProvider

Parameters:

config - The configuration to test

Throws:

EmailException - If some error is found

toInternetAddress

protected jakarta.mail.internet.InternetAddress toInternetAddress(String email,
 String displayName)
                                                           throws UnsupportedEncodingException,
jakarta.mail.internet.AddressException,
EmailException

Throws:

UnsupportedEncodingException

jakarta.mail.internet.AddressException

EmailException

retrieveEmailAddress

protected String retrieveEmailAddress(UserModel user)

close

public void close()

Specified by:

close in interface Provider