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 內文的路徑別名。在這種情況下，文字內文將透過將 `strip_tags()` 應用於 HTML 內文來產生。具有 'html' 和/或 'text' 元素的陣列。 'html' 元素指的是用於渲染 HTML 內文的視圖名稱或路徑別名，而 'text' 元素用於渲染文字內文。例如，`['html' => 'contact-html', 'text' => 'contact-text']`。 null，表示訊息實例將在不包含內文內容的情況下返回。
$params	array	將在視圖檔案中提取並提供的參數（名稱-值對）。
return	yii\mail\MessageInterface	訊息實例。

原始碼

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

send() public abstract method

傳送給定的電子郵件訊息。

public abstract boolean send ( $message )
$message	yii\mail\MessageInterface	要傳送的電子郵件訊息實例
return	boolean	訊息是否已成功傳送

原始碼

                public function send($message);

sendMultiple() public abstract method

一次傳送多個訊息。

此方法可以由某些郵件程式實作，這些郵件程式支援更有效率的方式在同一個批次中傳送多個訊息。

public abstract integer sendMultiple ( array $messages )
$messages	array	應傳送的電子郵件訊息列表。
return	integer	成功傳送的訊息數量。

原始碼

                public function sendMultiple(array $messages);