Method | Description | |
---|---|---|
compose ( string | array | null $view = null, array $params = [] ) : yii\mail\MessageInterface | Creates a new message instance and optionally composes its body content via view rendering. | |
send ( yii\mail\MessageInterface $message ) : boolean | Sends the given email message. | |
sendMultiple ( array $messages ) : integer | Sends multiple messages at once. |
public compose ( string | array | null $view = null, array $params = [] ) : yii\mail\MessageInterface | ||
$view | string | array | null | the view to be used for rendering the message body. This can be: - a string, which represents the view name or path alias for rendering the HTML body of the email. In this case, the text body will be generated by applying `strip_tags()` to the HTML body. - an array with 'html' and/or 'text' elements. The 'html' element refers to the view name or path alias for rendering the HTML body, while 'text' element is for rendering the text body. For example, `['html' => 'contact-html', 'text' => 'contact-text']`. - null, meaning the message instance will be returned without body content. |
$params | array | the parameters (name-value pairs) that will be extracted and made available in the view file. |
return | yii\mail\MessageInterface | message instance. |
public sendMultiple ( array $messages ) : integer | ||
$messages | array | list of email messages, which should be sent. |
return | integer | number of messages that are successfully sent. |