没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Interface yii\mail\MailerInterface

实现yii\mail\BaseMailer
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/framework/mail/MailerInterface.php

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

邮件程序应主要支持创建和发送 mail messages。 它还应该通过视图渲染机制支持消息体的组合。例如,

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 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']
  • 空,表示是消息实例将在没有正文内容的情况下返回。
$params array

将提取并且在视图文件中用的参数(键值对)。

return yii\mail\MessageInterface

消息实例。

send() 公共 抽象 方法

发送给定的邮件。

public abstract boolean send($message)
$message yii\mail\MessageInterface

要发送的电子邮件实例

return boolean

消息是否已成功发送

sendMultiple() 公共 抽象 方法

一次发送多条消息

此方法可以支持更高效的在同一批中发送多个消息。

public abstract integer sendMultiple(array $messages)
$messages array

应发送的电子邮件列表。

return integer

成功发送的消息数。