Package org.summerboot.jexpress.integration.smtp

Class SMTPClientConfig

java.lang.Object

org.summerboot.jexpress.boot.config.BootConfig

org.summerboot.jexpress.integration.smtp.SMTPClientConfig

All Implemented Interfaces:

JExpressConfig

public class SMTPClientConfig
extends BootConfig

Volatile Bean　Pattern

Author:

Changski Tie Zheng Zhang 张铁铮, 魏泽北, 杜旺财, 杜富贵

Nested Class Summary

Nested classes/interfaces inherited from class org.summerboot.jexpress.boot.config.BootConfig

BootConfig.ThreadingMode

Field Summary

Fields

Modifier and Type	Field	Description
static final SMTPClientConfig	cfg
protected int	emailAlertDebouncingIntervalMinutes
protected Set<String>	emailToAppSupport
protected Set<String>	emailToDevelopment
protected Set<String>	emailToReportViewer
static final String	KEY_DEBOUCING_INTERVAL
static final String	KEY_MAILTO_APPSUPPORT
static final String	KEY_MAILTO_DEV
static final String	KEY_MAILTO_REPORT
static final String	KEY_USER_ACCOUNT
static final String	KEY_USER_DISPLAYNAME
static final String	KEY_USER_PWD
protected jakarta.mail.Session	mailSession
protected Properties	mailSessionProp
protected Boolean	smtpAuth
protected String	smtpHost
protected String	smtpPassword
protected int	smtpPort
protected Boolean	smtpStarttls
protected String	smtpUser
protected String	smtpUserDisplayName

Fields inherited from class org.summerboot.jexpress.boot.config.BootConfig

BR, cache, cfgFile, configName, CPU_CORE, DESC_KMF, DESC_PLAINPWD, DESC_TMF, FILENAME_KEYSTORE, FILENAME_SRC_TRUSTSTORE, generateTemplate, logger, props

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SMTPClientConfig()

Method Summary

Modifier and Type	Method	Description
int	getEmailAlertDebouncingIntervalMinutes()
Set<String>	getEmailToAppSupport()
Set<String>	getEmailToDevelopment()
Set<String>	getEmailToReportViewer()
jakarta.mail.Session	getMailSession()
protected void	loadCustomizedConfigs(File cfgFile, boolean isReal, ConfigUtil helper, Properties props)
static void	main(String[] args)
void	shutdown()

Methods inherited from class org.summerboot.jexpress.boot.config.BootConfig

buildThreadPoolExecutor, createIfNotExist, generateTemplate, getCfgFile, getLength, getProperties, info, instance, lineBreak, load, loadField, name, parse, preLoad, registerSingleton, temp, updateConfigFile, updateFilePath

Methods inherited from class java.lang.Object

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

Field Details

cfg

public static final SMTPClientConfig cfg

mailSession

protected volatile jakarta.mail.Session mailSession

smtpHost

@ConfigHeader(title="1. SMTP Settings")
@Config(key="mail.smtp.host",
        required=false,
        desc="The SMTP server to connect to. i.e. Gmail server: smtp.gmail.com")
protected volatile String smtpHost

smtpPort

@Config(key="mail.smtp.port",
        defaultValue="25",
        desc="25: The original standard SMTP port\n587: The standard secure SMTP port")
protected volatile int smtpPort

smtpAuth

@Config(key="mail.smtp.auth",
        desc="Whether to attempt to authenticate the user using the AUTH command")
protected volatile Boolean smtpAuth

smtpStarttls

@Config(key="mail.smtp.starttls.enable",
        desc="To inform the email server that the email client wants to upgrade from an insecure connection to a secure one using TLS or SSL")
protected volatile Boolean smtpStarttls

KEY_USER_ACCOUNT

public static final String KEY_USER_ACCOUNT

See Also:

• Constant Field Values

smtpUser

@Config(key="mail.smtp.user",
        required=false,
        desc="Sender email account, also as default username for SMTP when display name is not provided")
protected volatile String smtpUser

KEY_USER_DISPLAYNAME

public static final String KEY_USER_DISPLAYNAME

See Also:

• Constant Field Values

smtpUserDisplayName

@Config(key="mail.smtp.user.displayname",
        desc="Sender display name")
protected volatile String smtpUserDisplayName

KEY_USER_PWD

public static final String KEY_USER_PWD

See Also:

• Constant Field Values

smtpPassword

@Config(key="mail.smtp.user.passwrod",
        validate=Encrypted)
protected volatile String smtpPassword

KEY_MAILTO_APPSUPPORT

@ConfigHeader(title="2. Alert Recipients",
              format="CSV format",
              example="johndoe@test.com, janedoe@test.com")
public static final String KEY_MAILTO_APPSUPPORT

See Also:

• Constant Field Values

emailToAppSupport

@Config(key="email.to.AppSupport",
        validate=EmailRecipients,
        desc="The default alert email recipients")
protected volatile Set<String> emailToAppSupport

KEY_MAILTO_DEV

public static final String KEY_MAILTO_DEV

See Also:

• Constant Field Values

emailToDevelopment

@Config(key="email.to.Development",
        validate=EmailRecipients,
        desc="use AppSupport if not provided")
protected volatile Set<String> emailToDevelopment

KEY_MAILTO_REPORT

public static final String KEY_MAILTO_REPORT

See Also:

• Constant Field Values

emailToReportViewer

@Config(key="email.to.ReportViewer",
        validate=EmailRecipients,
        desc="use AppSupport if not provided")
protected volatile Set<String> emailToReportViewer

KEY_DEBOUCING_INTERVAL

public static final String KEY_DEBOUCING_INTERVAL

See Also:

• Constant Field Values

emailAlertDebouncingIntervalMinutes

@Config(key="debouncing.emailalert_minute",
        desc="Alert message with the same title will not be sent out within this minutes")
protected volatile int emailAlertDebouncingIntervalMinutes

mailSessionProp

protected Properties mailSessionProp

Constructor Details

SMTPClientConfig

protected SMTPClientConfig()

Method Details

main

public static void main(String[] args)

shutdown

public void shutdown()

loadCustomizedConfigs

protected void loadCustomizedConfigs(File cfgFile,
 boolean isReal,
 ConfigUtil helper,
 Properties props)

Specified by:

loadCustomizedConfigs in class BootConfig

getMailSession

public jakarta.mail.Session getMailSession()

getEmailToAppSupport

public Set<String> getEmailToAppSupport()

getEmailToDevelopment

public Set<String> getEmailToDevelopment()

getEmailToReportViewer

public Set<String> getEmailToReportViewer()

getEmailAlertDebouncingIntervalMinutes

public int getEmailAlertDebouncingIntervalMinutes()