0 フォロワー

インターフェース yii\mail\MessageInterface

実装者	yii\mail\BaseMessage
利用可能バージョン	2.0
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/mail/MessageInterface.php

MessageInterfaceは、メールメッセージクラスによって実装されるべきインターフェースです。

メッセージは、送信者、受信者、件名、本文など、メールの設定と内容を表します。

メッセージは、次のようなメーラーによって送信されます。

Yii::$app->mailer->compose()
    ->setFrom('from@domain.com')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->setTextBody('Plain text content')
    ->setHtmlBody('<b>HTML content</b>')
    ->send();

参照: yii\mail\MailerInterface。

公開メソッド

継承されたメソッドを非表示

メソッド	説明	定義元
attach()	既存のファイルをメールメッセージに添付します。	yii\mail\MessageInterface
attachContent()	指定された内容をメールメッセージのファイルとして添付します。	yii\mail\MessageInterface
embed()	ファイルを添付し、そのCIDソースを返します。	yii\mail\MessageInterface
embedContent()	内容をファイルとして添付し、そのCIDソースを返します。	yii\mail\MessageInterface
getBcc()	このメッセージのBcc（隠しコピー受信者）アドレスを返します。	yii\mail\MessageInterface
getCc()	このメッセージのCc（追加コピー受信者）アドレスを返します。	yii\mail\MessageInterface
getCharset()	このメッセージの文字セットを返します。	yii\mail\MessageInterface
getFrom()	メッセージの送信者を返します。	yii\mail\MessageInterface
getReplyTo()	このメッセージの返信先アドレスを返します。	yii\mail\MessageInterface
getSubject()	メッセージの件名を返します。	yii\mail\MessageInterface
getTo()	メッセージの受信者を返します。	yii\mail\MessageInterface
send()	このメールメッセージを送信します。	yii\mail\MessageInterface
setBcc()	このメッセージのBcc（隠しコピー受信者）アドレスを設定します。	yii\mail\MessageInterface
setCc()	このメッセージのCc（追加コピー受信者）アドレスを設定します。	yii\mail\MessageInterface
setCharset()	このメッセージの文字セットを設定します。	yii\mail\MessageInterface
setFrom()	メッセージの送信者を設定します。	yii\mail\MessageInterface
setHtmlBody()	メッセージのHTMLコンテンツを設定します。	yii\mail\MessageInterface
setReplyTo()	このメッセージの返信先アドレスを設定します。	yii\mail\MessageInterface
setSubject()	メッセージの件名を設定します。	yii\mail\MessageInterface
setTextBody()	メッセージのプレーンテキストコンテンツを設定します。	yii\mail\MessageInterface
setTo()	メッセージの受信者を設定します。	yii\mail\MessageInterface
toString()	このメッセージの文字列表現を返します。	yii\mail\MessageInterface

メソッドの詳細

継承されたメソッドを非表示

attach() public abstract method

既存のファイルをメールメッセージに添付します。

public abstract $this attach ( $fileName, array $options = [] )
$fileName	string	フルファイル名
$options	array	埋め込みファイルのオプション。有効なオプションは次のとおりです。 fileName: ファイルを添付するために使用される名前。 contentType: 添付ファイルのMIMEタイプ。
戻り値	$this	自己参照。

ソースコード

                public function attach($fileName, array $options = []);

attachContent() public abstract method

指定された内容をメールメッセージのファイルとして添付します。

public abstract $this attachContent ( $content, array $options = [] )
$content	string	添付ファイルの内容。
$options	array	埋め込みファイルのオプション。有効なオプションは次のとおりです。 fileName: ファイルを添付するために使用される名前。 contentType: 添付ファイルのMIMEタイプ。
戻り値	$this	自己参照。

ソースコード

                public function attachContent($content, array $options = []);

embed() public abstract method

ファイルを添付し、そのCIDソースを返します。

このメソッドは、画像やその他のデータをメッセージに埋め込む場合に使用する必要があります。

public abstract string embed ( $fileName, array $options = [] )
$fileName	string	ファイル名。
$options	array	埋め込みファイルのオプション。有効なオプションは次のとおりです。 fileName: ファイルを添付するために使用される名前。 contentType: 添付ファイルのMIMEタイプ。
戻り値	string	添付ファイルのCID。

ソースコード

                public function embed($fileName, array $options = []);

embedContent() public abstract method

内容をファイルとして添付し、そのCIDソースを返します。

このメソッドは、画像やその他のデータをメッセージに埋め込む場合に使用する必要があります。

public abstract string embedContent ( $content, array $options = [] )
$content	string	添付ファイルの内容。
$options	array	埋め込みファイルのオプション。有効なオプションは次のとおりです。 fileName: ファイルを添付するために使用される名前。 contentType: 添付ファイルのMIMEタイプ。
戻り値	string	添付ファイルのCID。

ソースコード

                public function embedContent($content, array $options = []);

getBcc() public abstract method

このメッセージのBcc（隠しコピー受信者）アドレスを返します。

public abstract string\|array getBcc ( )
戻り値	string\|array	このメッセージのBcc（隠しコピー受信者）アドレス。

ソースコード

                public function getBcc();

getCc() public abstract メソッド

このメッセージのCc（追加コピー受信者）アドレスを返します。

public abstract string\|array getCc ( )
戻り値	string\|array	このメッセージのCc（追加のコピー受信者）のアドレス。

ソースコード

                public function getCc();

getCharset() public abstract メソッド

このメッセージの文字セットを返します。

public abstract string getCharset ( )
戻り値	string	このメッセージの文字セット。

ソースコード

                public function getCharset();

getFrom() public abstract メソッド

メッセージの送信者を返します。

public abstract string\|array getFrom ( )
戻り値	string\|array	送信者

ソースコード

                public function getFrom();

getReplyTo() public abstract メソッド

このメッセージの返信先アドレスを返します。

public abstract string\|array getReplyTo ( )
戻り値	string\|array	このメッセージの返信先アドレス。

ソースコード

                public function getReplyTo();

getSubject() public abstract メソッド

メッセージの件名を返します。

public abstract string getSubject ( )
戻り値	string	メッセージの件名

ソースコード

                public function getSubject();

getTo() public abstract メソッド

メッセージの受信者を返します。

public abstract string\|array getTo ( )
戻り値	string\|array	メッセージの受信者

ソースコード

                public function getTo();

send() public abstract メソッド

このメールメッセージを送信します。

public abstract boolean send ( yii\mail\MailerInterface $mailer = null )
$mailer	yii\mail\MailerInterface\|null	このメッセージを送信するために使用するメーラー。nullの場合、代わりに「mailer」アプリケーションコンポーネントが使用されます。
戻り値	boolean	このメッセージが正常に送信されたかどうか。

ソースコード

                public function send(MailerInterface $mailer = null);

setBcc() public abstract メソッド

このメッセージのBcc（隠しコピー受信者）アドレスを設定します。

public abstract $this setBcc ( $bcc )
$bcc	string\|array	隠れたコピー受信者のメールアドレス。複数の受信者がこのメッセージを受信する必要がある場合は、アドレスの配列を渡すことができます。また、`[email => name]`の形式を使用して、メールアドレスに加えて受信者の名前を指定することもできます。
戻り値	$this	自己参照。

ソースコード

                public function setBcc($bcc);

setCc() public abstract メソッド

このメッセージのCc（追加コピー受信者）アドレスを設定します。

public abstract $this setCc ( $cc )
$cc	string\|array	コピー受信者のメールアドレス。複数の受信者がこのメッセージを受信する必要がある場合は、アドレスの配列を渡すことができます。また、`[email => name]`の形式を使用して、メールアドレスに加えて受信者の名前を指定することもできます。
戻り値	$this	自己参照。

ソースコード

                public function setCc($cc);

setCharset() public abstract メソッド

このメッセージの文字セットを設定します。

public abstract $this setCharset ( $charset )
$charset	string	文字セット名。
戻り値	$this	自己参照。

ソースコード

                public function setCharset($charset);

setFrom() public abstract メソッド

メッセージの送信者を設定します。

public abstract $this setFrom ( $from )
$from	string\|array	送信者のメールアドレス。このメッセージが複数の人からのものである場合は、アドレスの配列を渡すことができます。また、`[email => name]`の形式を使用して、メールアドレスに加えて送信者の名前を指定することもできます。
戻り値	$this	自己参照。

ソースコード

                public function setFrom($from);

setHtmlBody() public abstract メソッド

メッセージのHTMLコンテンツを設定します。

public abstract $this setHtmlBody ( $html )
$html	string	メッセージのHTMLコンテンツ。
戻り値	$this	自己参照。

ソースコード

                public function setHtmlBody($html);

setReplyTo() public abstract メソッド

このメッセージの返信先アドレスを設定します。

public abstract $this setReplyTo ( $replyTo )
$replyTo	string\|array	返信先アドレス。このメッセージが複数の人に返信される必要がある場合は、アドレスの配列を渡すことができます。また、`[email => name]`の形式を使用して、メールアドレスに加えて返信先を指定することもできます。
戻り値	$this	自己参照。

ソースコード

                public function setReplyTo($replyTo);

setSubject() public abstract メソッド

メッセージの件名を設定します。

public abstract $this setSubject ( $subject )
$subject	string	メッセージの件名
戻り値	$this	自己参照。

ソースコード

                public function setSubject($subject);

setTextBody() public abstract メソッド

メッセージのプレーンテキストコンテンツを設定します。

public abstract $this setTextBody ( $text )
$text	string	メッセージのプレーンテキストコンテンツ。
戻り値	$this	自己参照。

ソースコード

                public function setTextBody($text);

setTo() public abstract メソッド

メッセージの受信者を設定します。

public abstract $this setTo ( $to )
$to	string\|array	受信者のメールアドレス。複数の受信者にこのメッセージを送信する場合は、アドレスの配列を渡すことができます。また、`[email => name]`形式を使用して、メールアドレスに加えて受信者の名前を指定することもできます。
戻り値	$this	自己参照。

ソースコード

                public function setTo($to);

toString() public abstract メソッド

このメッセージの文字列表現を返します。

public abstract string toString ( )
戻り値	string	このメッセージの文字列表現。

ソースコード

                public function toString();