com.github.hetianyi.boot.ready.config.authenticator.email

类 EmailCaptchaUtil

java.lang.Object

com.github.hetianyi.boot.ready.config.authenticator.email.EmailCaptchaUtil

所有已实现的接口:

CaptchaLimiter

@Component
 @ConditionalOnClass(value={cn.hutool.extra.mail.MailAccount.class,javax.mail.Address.class})
public class EmailCaptchaUtil
extends Object
implements CaptchaLimiter

作者:

Jason He

构造器概要

构造器

构造器和说明
EmailCaptchaUtil()

方法概要

限定符和类型	方法和说明
boolean	limitCheck(String limiter, String account, String clientIP) 发送限制检查
SendStatus	sendEmail(String sceneId, String toEmailAccount, Map<String,String> args) 发送邮件验证码。

从类继承的方法 java.lang.Object

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

构造器详细资料

EmailCaptchaUtil

public EmailCaptchaUtil()

方法详细资料

sendEmail

public SendStatus sendEmail(String sceneId,
                            String toEmailAccount,
                            Map<String,String> args)

发送邮件验证码。

如果启用了发送频率限制功能，那么需要在args里加入参数：
__CLIENT_IP__(客户端IP)
频率限制脚本会以帐号和客户端IP两个维度计算是否可以发送。

参数:

sceneId - 邮件场景ID

args - 邮件模版template的参数，模版内的参数以{varName}格式混入

limitCheck

public boolean limitCheck(String limiter,
                          String account,
                          String clientIP)
                   throws LimitationException

从接口复制的说明: CaptchaLimiter

发送限制检查

指定者:

limitCheck 在接口中 CaptchaLimiter

返回:

是否触发限制

抛出:

LimitationException