Package org.keycloak.email

Interface EmailSenderProvider

All Superinterfaces:

org.keycloak.provider.Provider

public interface EmailSenderProvider
extends org.keycloak.provider.Provider

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ALLOW_UTF8

Method Summary

Modifier and Type	Method	Description
void	send(Map<String,String> config, String address, String subject, String textBody, String htmlBody)
default void	send(Map<String,String> config, org.keycloak.models.UserModel user, String subject, String textBody, String htmlBody)
void	validate(Map<String,String> config)	Validates configuration for the SMTP sender.

Methods inherited from interface org.keycloak.provider.Provider

close

Field Details

CONFIG_ALLOW_UTF8

static final String CONFIG_ALLOW_UTF8

See Also:

• Constant Field Values

Method Details

send

default void send(Map<String,String> config,
 org.keycloak.models.UserModel user,
 String subject,
 String textBody,
 String htmlBody)
           throws EmailException

Throws:

EmailException

send

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

Throws:

EmailException

validate

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

Validates configuration for the SMTP sender.

Parameters:

config - The configuration to test

Throws:

EmailException - If some error is found