org.keycloak.email.DefaultEmailSenderProvider クラス

org.keycloak.email.DefaultEmailSenderProvider の継承関係図

org.keycloak.email.DefaultEmailSenderProvider 連携図

公開メンバ関数
	DefaultEmailSenderProvider (KeycloakSession session)
void	send (Map< String, String > config, UserModel user, String subject, String textBody, String htmlBody) throws EmailException
void	close ()

限定公開メンバ関数
InternetAddress	toInternetAddress (String email, String displayName) throws UnsupportedEncodingException, AddressException, EmailException
String	retrieveEmailAddress (UserModel user)

非公開メンバ関数
void	setupTruststore (Properties props) throws NoSuchAlgorithmException, KeyManagementException

非公開変数類
final KeycloakSession	session

静的非公開変数類
static final Logger	logger = Logger.getLogger(DefaultEmailSenderProvider.class)

詳解

著者

Stian Thorgersen

構築子と解体子

DefaultEmailSenderProvider()

org.keycloak.email.DefaultEmailSenderProvider.DefaultEmailSenderProvider ( KeycloakSession  session )

inline

                                                               {
        this.session = session;
    }

関数詳解

close()

void org.keycloak.email.DefaultEmailSenderProvider.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                        {

    }

retrieveEmailAddress()

String org.keycloak.email.DefaultEmailSenderProvider.retrieveEmailAddress ( UserModel  user )

inlineprotected

                                                          {
        return user.getEmail();
    }

send()

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

inline

org.keycloak.email.EmailSenderProviderを実装しています。

                                                                                                                                         {
        Transport transport = null;
        try {
            String address = retrieveEmailAddress(user);

            Properties props = new Properties();

            if (config.containsKey("host")) {
                props.setProperty("mail.smtp.host", config.get("host"));
            }

            boolean auth = "true".equals(config.get("auth"));
            boolean ssl = "true".equals(config.get("ssl"));
            boolean starttls = "true".equals(config.get("starttls"));

            if (config.containsKey("port") && config.get("port") != null) {
                props.setProperty("mail.smtp.port", config.get("port"));
            }

            if (auth) {
                props.setProperty("mail.smtp.auth", "true");
            }

            if (ssl) {
                props.setProperty("mail.smtp.ssl.enable", "true");
            }

            if (starttls) {
                props.setProperty("mail.smtp.starttls.enable", "true");
            }

            if (ssl || starttls) {
                setupTruststore(props);
            }

            props.setProperty("mail.smtp.timeout", "10000");
            props.setProperty("mail.smtp.connectiontimeout", "10000");

            String from = config.get("from");
            String fromDisplayName = config.get("fromDisplayName");
            String replyTo = config.get("replyTo");
            String replyToDisplayName = config.get("replyToDisplayName");
            String envelopeFrom = config.get("envelopeFrom");

            Session session = Session.getInstance(props);

            Multipart multipart = new MimeMultipart("alternative");

            if (textBody != null) {
                MimeBodyPart textPart = new MimeBodyPart();
                textPart.setText(textBody, "UTF-8");
                multipart.addBodyPart(textPart);
            }

            if (htmlBody != null) {
                MimeBodyPart htmlPart = new MimeBodyPart();
                htmlPart.setContent(htmlBody, "text/html; charset=UTF-8");
                multipart.addBodyPart(htmlPart);
            }

            SMTPMessage msg = new SMTPMessage(session);
            msg.setFrom(toInternetAddress(from, fromDisplayName));

            msg.setReplyTo(new Address[]{toInternetAddress(from, fromDisplayName)});
            if (replyTo != null && !replyTo.isEmpty()) {
                msg.setReplyTo(new Address[]{toInternetAddress(replyTo, replyToDisplayName)});
            }
            if (envelopeFrom != null && !envelopeFrom.isEmpty()) {
                msg.setEnvelopeFrom(envelopeFrom);
            }

            msg.setHeader("To", address);
            msg.setSubject(subject, "utf-8");
            msg.setContent(multipart);
            msg.saveChanges();
            msg.setSentDate(new Date());

            transport = session.getTransport("smtp");
            if (auth) {
                transport.connect(config.get("user"), config.get("password"));
            } else {
                transport.connect();
            }
            transport.sendMessage(msg, new InternetAddress[]{new InternetAddress(address)});
        } catch (Exception e) {
            ServicesLogger.LOGGER.failedToSendEmail(e);
            throw new EmailException(e);
        } finally {
            if (transport != null) {
                try {
                    transport.close();
                } catch (MessagingException e) {
                    logger.warn("Failed to close transport", e);
                }
            }
        }
    }

setupTruststore()

void org.keycloak.email.DefaultEmailSenderProvider.setupTruststore ( Properties  props ) throws NoSuchAlgorithmException, KeyManagementException

inlineprivate

                                                                                                           {

        JSSETruststoreConfigurator configurator = new JSSETruststoreConfigurator(session);

        SSLSocketFactory factory = configurator.getSSLSocketFactory();
        if (factory != null) {
            props.put("mail.smtp.ssl.socketFactory", factory);
            if (configurator.getProvider().getPolicy() == HostnameVerificationPolicy.ANY) {
                props.setProperty("mail.smtp.ssl.trust", "*");
            }
        }
    }

toInternetAddress()

InternetAddress org.keycloak.email.DefaultEmailSenderProvider.toInternetAddress ( String  email, String  displayName  ) throws UnsupportedEncodingException, AddressException, EmailException

inlineprotected

                                                                                                                                                        {
        if (email == null || "".equals(email.trim())) {
            throw new EmailException("Please provide a valid address", null);
        }
        if (displayName == null || "".equals(displayName.trim())) {
            return new InternetAddress(email);
        }
        return new InternetAddress(email, displayName, "utf-8");
    }

メンバ詳解

logger

final Logger org.keycloak.email.DefaultEmailSenderProvider.logger = Logger.getLogger(DefaultEmailSenderProvider.class)

staticprivate

session

final KeycloakSession org.keycloak.email.DefaultEmailSenderProvider.session

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/email/DefaultEmailSenderProvider.java