Class dektrium\user\Mailer

Inheritancedektrium\user\Mailer » yii\base\Component

Mailer.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$sender string|array Default: Yii::$app->params['adminEmail'] OR `no-reply@example. dektrium\user\Mailer
$viewPath string dektrium\user\Mailer

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
sendMessage() dektrium\user\Mailer

Property Details

$confirmationSubject protected property
protected string $confirmationSubject null
$module protected property
protected dektrium\user\Module $module null
$reconfirmationSubject protected property
protected string $reconfirmationSubject null
$recoverySubject protected property
protected string $recoverySubject null
$sender public property

Default: Yii::$app->params['adminEmail'] OR no-reply@example.com

public string|array $sender null
$viewPath public property
public string $viewPath '@dektrium/user/views/mail'
$welcomeSubject protected property
protected string $welcomeSubject null

Method Details

getConfirmationSubject() public method

public string getConfirmationSubject ( )
getReconfirmationSubject() public method

public string getReconfirmationSubject ( )
getRecoverySubject() public method

public string getRecoverySubject ( )
getWelcomeSubject() public method

public string getWelcomeSubject ( )
init() public method

public void init ( )
sendConfirmationMessage() public method

Sends an email to a user with confirmation link.

public bool sendConfirmationMessage ( dektrium\user\models\User $user, dektrium\user\models\Token $token )
$user dektrium\user\models\User
$token dektrium\user\models\Token
sendMessage() protected method

protected bool sendMessage ( $to, $subject, $view, $params = [] )
$to string
$subject string
$view string
$params array
sendReconfirmationMessage() public method

Sends an email to a user with reconfirmation link.

public bool sendReconfirmationMessage ( dektrium\user\models\User $user, dektrium\user\models\Token $token )
$user dektrium\user\models\User
$token dektrium\user\models\Token
sendRecoveryMessage() public method

Sends an email to a user with recovery link.

public bool sendRecoveryMessage ( dektrium\user\models\User $user, dektrium\user\models\Token $token )
$user dektrium\user\models\User
$token dektrium\user\models\Token
sendWelcomeMessage() public method

Sends an email to a user after registration.

public bool sendWelcomeMessage ( dektrium\user\models\User $user, dektrium\user\models\Token $token null, $showPassword false )
$user dektrium\user\models\User
$token dektrium\user\models\Token
$showPassword bool
setConfirmationSubject() public method

public void setConfirmationSubject ( $confirmationSubject )
$confirmationSubject string
setReconfirmationSubject() public method

public void setReconfirmationSubject ( $reconfirmationSubject )
$reconfirmationSubject string
setRecoverySubject() public method

public void setRecoverySubject ( $recoverySubject )
$recoverySubject string
setWelcomeSubject() public method

public void setWelcomeSubject ( $welcomeSubject )
$welcomeSubject string