0 关注者

接口 yii\mail\MailerInterface

由以下类实现	yii\mail\BaseMailer
可用版本	2.0
源代码	https://github.com/yiisoft/yii2/blob/master/framework/mail/MailerInterface.php

MailerInterface 是邮件类应该实现的接口。

邮件类主要支持创建和发送邮件消息。它还应支持通过视图渲染机制组合邮件正文。例如，

Yii::$app->mailer->compose('contact/html', ['contactForm' => $form])
    ->setFrom('from@domain.com')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->send();

另请参阅 yii\mail\MessageInterface。

公共方法

隐藏继承的方法

方法	描述	定义于
compose()	创建一个新的邮件实例，并通过视图渲染可选地组合其正文内容。	yii\mail\MailerInterface
send()	发送给定的邮件。	yii\mail\MailerInterface
sendMultiple()	一次发送多封邮件。	yii\mail\MailerInterface

方法详情

隐藏继承的方法

compose() public abstract method

创建一个新的邮件实例，并通过视图渲染可选地组合其正文内容。

public abstract yii\mail\MessageInterface compose ( $view = null, array $params = [] )
$view	string\|array\|null	用于渲染邮件正文的视图。这可以是一个字符串，表示视图名称或路径别名，用于渲染邮件的 HTML 正文。在这种情况下，纯文本正文将通过对 HTML 正文应用 `strip_tags()` 生成。一个包含 'html' 和/或 'text' 元素的数组。'html' 元素指的是用于渲染 HTML 正文的视图名称或路径别名，而 'text' 元素用于渲染纯文本正文。例如，`['html' => 'contact-html', 'text' => 'contact-text']`。 null，表示邮件实例将在没有正文内容的情况下返回。
$params	array	将在视图文件中提取并可用的参数（名称-值对）。
返回值	yii\mail\MessageInterface	邮件实例。

源代码

                public function compose($view = null, array $params = []);

send() public abstract method

发送给定的邮件。

public abstract boolean send ( $message )
$message	yii\mail\MessageInterface	要发送的邮件实例
返回值	boolean	邮件是否已成功发送

源代码

                public function send($message);

sendMultiple() public abstract method

一次发送多封邮件。

此方法可以由某些支持更有效地批量发送多封邮件的邮件类实现。

public abstract integer sendMultiple ( array $messages )
$messages	array	要发送的邮件列表。
返回值	integer	成功发送的邮件数量。

源代码

                public function sendMultiple(array $messages);