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);