Class dektrium\user\Mailer
Inheritance | dektrium\user\Mailer » yii\base\Component |
---|
Mailer.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$sender | string|array | Default: Yii::$app->params['adminEmail'] OR `no-reply@example. |
dektrium\user\Mailer |
$viewPath | string | dektrium\user\Mailer |
Protected Properties
Public Methods
Method | Description | Defined By |
---|---|---|
getConfirmationSubject() | dektrium\user\Mailer | |
getReconfirmationSubject() | dektrium\user\Mailer | |
getRecoverySubject() | dektrium\user\Mailer | |
getWelcomeSubject() | dektrium\user\Mailer | |
init() | dektrium\user\Mailer | |
sendConfirmationMessage() | Sends an email to a user with confirmation link. | dektrium\user\Mailer |
sendReconfirmationMessage() | Sends an email to a user with reconfirmation link. | dektrium\user\Mailer |
sendRecoveryMessage() | Sends an email to a user with recovery link. | dektrium\user\Mailer |
sendWelcomeMessage() | Sends an email to a user after registration. | dektrium\user\Mailer |
setConfirmationSubject() | dektrium\user\Mailer | |
setReconfirmationSubject() | dektrium\user\Mailer | |
setRecoverySubject() | dektrium\user\Mailer | |
setWelcomeSubject() | dektrium\user\Mailer |
Protected Methods
Method | Description | Defined By |
---|---|---|
sendMessage() | dektrium\user\Mailer |
Property Details
Default: Yii::$app->params['adminEmail']
OR no-reply@example.com
Method Details
public string getConfirmationSubject ( ) |
public string getReconfirmationSubject ( ) |
public string getRecoverySubject ( ) |
public string getWelcomeSubject ( ) |
public void init ( ) |
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 |
protected bool sendMessage ( $to, $subject, $view, $params = [] ) | ||
$to | string | |
$subject | string | |
$view | string | |
$params | array |
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 |
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 |
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 |
public void setConfirmationSubject ( $confirmationSubject ) | ||
$confirmationSubject | string |
public void setReconfirmationSubject ( $reconfirmationSubject ) | ||
$reconfirmationSubject | string |
public void setRecoverySubject ( $recoverySubject ) | ||
$recoverySubject | string |
public void setWelcomeSubject ( $welcomeSubject ) | ||
$welcomeSubject | string |