1. interface
  2. Xpressengine
  3. User
  4. EmailBrokerInterface

EmailBrokerInterface

interface EmailBrokerInterface

이 인터페이스는 이메일 인증 처리 클래스가 구현해야 하는 인터페이스이다.

이 인터페이스는 인증 요청 메일 전송, 인증메일의 인증처리, 인증메일의 인증여부를 체크하는 메소드로 구성된다.

Methods

void
sendEmailForRegister(EmailInterface $mail, string $token, string $view, null|Closure $callback = null)

회원가입시 이메일 인증을 위한 이메일을 전송한다.

void
sendEmailForAddingEmail(EmailInterface $mail, string $view, null|Closure $callback = null)

기존 회원이 이메일 추가시 이메일 인증을 위한 이메일을 전송한다.

bool
validateConfirmCode(EmailInterface $mail, string $code)

주어진 이메일의 인증코드를 검사한다.

bool
confirmEmail(EmailInterface $email, string $code)

이메일을 인증처리 한다.

Details

at line 43
void sendEmailForRegister(EmailInterface $mail, string $token, string $view, null|Closure $callback = null)

회원가입시 이메일 인증을 위한 이메일을 전송한다.

Parameters

EmailInterface $mail 전송할 이메일 정보
string $token 회원가입 토큰 id
string $view 이메일 전송시 사용할 템플릿
null|Closure $callback 이메일 전송할 때 처리할 로직

Return Value

void

at line 54
void sendEmailForAddingEmail(EmailInterface $mail, string $view, null|Closure $callback = null)

기존 회원이 이메일 추가시 이메일 인증을 위한 이메일을 전송한다.

Parameters

EmailInterface $mail 전송할 이메일 정보
string $view 이메일 전송시 사용할 템플릿
null|Closure $callback 이메일 전송할 때 처리할 로직

Return Value

void

at line 64
bool validateConfirmCode(EmailInterface $mail, string $code)

주어진 이메일의 인증코드를 검사한다.

Parameters

EmailInterface $mail 인증할 이메일 정보
string $code 인증코드

Return Value

bool 주어진 이메일에 등록된 인증코드가 일치할 경우 true, 일치하지 않으면 false를 반환한다.

at line 74
bool confirmEmail(EmailInterface $email, string $code)

이메일을 인증처리 한다.

Parameters

EmailInterface $email 인증할 이메일
string $code 인증코드

Return Value

bool 주어진 이메일의 인증처리가 성공하면 true를 반환한다.