0 フォロワー

抽象クラス yii\mail\BaseMessage

すべてのクラス | プロパティ | メソッド
継承yii\mail\BaseMessage » yii\base\BaseObject
実装yii\base\Configurable, yii\mail\MessageInterface
利用可能なバージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/mail/BaseMessage.php

BaseMessageは、yii\mail\MessageInterface で必要なsend()メソッドを実装する基底クラスとして機能します。

デフォルトでは、send() は現在のメッセージを送信するために "mailer" アプリケーションコンポーネントを使用します。 "mailer" アプリケーションコンポーネントは、yii\mail\MailerInterfaceを実装するメーラーインスタンスである必要があります。

こちらも参照してください：yii\mail\BaseMailer。

公開プロパティ

継承されたプロパティを隠す

プロパティ 型 説明 定義元
$bcc string|array このメッセージのBcc（隠しコピー受信者）アドレス。 yii\mail\MessageInterface
$cc string|array このメッセージのCc（追加コピー受信者）アドレス。 yii\mail\MessageInterface
$charset string このメッセージの文字セット。 yii\mail\MessageInterface
$from string|array 送信者 yii\mail\MessageInterface
$htmlBody string メッセージのHTMLコンテンツ。 yii\mail\MessageInterface
$mailer yii\mail\MailerInterface|null このメッセージを作成したメーラーインスタンス。 yii\mail\BaseMessage
$replyTo string|array このメッセージの返信先アドレス。 yii\mail\MessageInterface
$subject string メッセージの件名 yii\mail\MessageInterface
$textBody string メッセージのプレーンテキストコンテンツ。 yii\mail\MessageInterface
$to string|array メッセージの受信者 yii\mail\MessageInterface

公開メソッド

継承されたメソッドを隠す

メソッド 説明 定義元
__call() クラスメソッドではない名前付きメソッドを呼び出します。 yii\base\BaseObject
__construct() コンストラクタ。 yii\base\BaseObject
__get() オブジェクトプロパティの値を返します。 yii\base\BaseObject
__isset() プロパティが設定されているか、つまり定義されていてnullでないかを確認します。 yii\base\BaseObject
__set() オブジェクトプロパティの値を設定します。 yii\base\BaseObject
__toString() このオブジェクトの文字列表現を返すPHPマジックメソッド。 yii\mail\BaseMessage
__unset() オブジェクトプロパティをnullに設定します。 yii\base\BaseObject
attach() 既存のファイルをメールメッセージに添付します。 yii\mail\MessageInterface
attachContent() 指定されたコンテンツをメールメッセージのファイルとして添付します。 yii\mail\MessageInterface
canGetProperty() プロパティが読み取り可能かどうかを示す値を返します。 yii\base\BaseObject
canSetProperty() プロパティが設定可能かどうかを示す値を返します。 yii\base\BaseObject
className() このクラスの完全修飾名を返します。 yii\base\BaseObject
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
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject
send() このメールメッセージを送信します。 yii\mail\BaseMessage
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

プロパティの詳細

継承されたプロパティを隠す

$mailer public プロパティ

このメッセージを作成したメーラーのインスタンス。独立して作成されたメッセージの場合、これは null です。

public yii\mail\MailerInterface|null $mailer = null

メソッド詳細

継承されたメソッドを隠す

__call() public メソッド

定義元: yii\base\BaseObject::__call()

クラスメソッドではない名前付きメソッドを呼び出します。

このメソッドは、不明なメソッドが呼び出されたときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。

public mixed __call ( $name, $params )
$name string

メソッド名
$params array

メソッドのパラメータ
return mixed

メソッドの戻り値
throws yii\base\UnknownMethodException

不明なメソッドを呼び出した場合

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public メソッド

定義元: yii\base\BaseObject::__construct()

コンストラクタ。

デフォルトの実装では、以下の2つの処理を行います。

  • 指定された構成 $config でオブジェクトを初期化します。
  • init() を呼び出します。

このメソッドが子クラスでオーバーライドされている場合は、以下の推奨事項に従ってください。

  • コンストラクタの最後のパラメータは、ここでの $config のように、構成配列にすること。
  • コンストラクタの最後に親の実装を呼び出すこと。
public void __construct ( $config = [] )
$config array

オブジェクトのプロパティを初期化するために使用される名前と値のペア

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public メソッド

定義元: yii\base\BaseObject::__get()

オブジェクトプロパティの値を返します。

このメソッドは、$value = $object->property; を実行するときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。

__set() も参照してください。

public mixed __get ( $name )
$name string

プロパティ名
return mixed

プロパティの値
throws yii\base\UnknownPropertyException

プロパティが定義されていない場合
throws yii\base\InvalidCallException

プロパティが書き込み専用の場合

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() public メソッド

定義元: yii\base\BaseObject::__isset()

プロパティが設定されているか、つまり定義されていてnullでないかを確認します。

このメソッドは、isset($object->property) を実行するときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。

プロパティが定義されていない場合、false が返されることに注意してください。

https://www.php.net/manual/en/function.isset.php も参照してください。

public boolean __isset ( $name )
$name string

プロパティ名またはイベント名
return boolean

指定されたプロパティが設定されているかどうか (null でない場合)。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public メソッド

定義元: yii\base\BaseObject::__set()

オブジェクトプロパティの値を設定します。

このメソッドは、$object->property = $value; を実行するときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。

__get() も参照してください。

public void __set ( $name, $value )
$name string

プロパティ名またはイベント名
$value mixed

プロパティの値
throws yii\base\UnknownPropertyException

プロパティが定義されていない場合
throws yii\base\InvalidCallException

プロパティが読み取り専用の場合

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__toString() public メソッド

このオブジェクトの文字列表現を返すPHPマジックメソッド。

public string __toString ( )
return string

このオブジェクトの文字列表現。

 

                public function __toString()
{
    // __toString cannot throw exception
    // use trigger_error to bypass this limitation
    try {
        return $this->toString();
    } catch (\Exception $e) {
        ErrorHandler::convertExceptionToError($e);
        return '';
    }
}
__unset() public メソッド

定義元: yii\base\BaseObject::__unset()

オブジェクトプロパティをnullに設定します。

このメソッドは、unset($object->property) を実行するときに暗黙的に呼び出される PHP のマジックメソッドであるため、直接呼び出さないでください。

プロパティが定義されていない場合、このメソッドは何もしないことに注意してください。プロパティが読み取り専用の場合、例外がスローされます。

https://www.php.net/manual/en/function.unset.php も参照してください。

public void __unset ( $name )
$name string

プロパティ名
throws yii\base\InvalidCallException

プロパティが読み取り専用の場合。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
attach() public abstract メソッド

定義元: yii\mail\MessageInterface::attach()

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

public abstract $this attach ( $fileName, array $options = [] )
$fileName string

フルファイル名
$options array

ファイルを埋め込むためのオプション。有効なオプションは次のとおりです。

  • fileName: ファイルを添付するために使用する必要がある名前。
  • contentType: 添付ファイルの MIME タイプ。
return $this

自己参照。

 

                public function attach($fileName, array $options = []);
attachContent() public abstract メソッド

定義元: yii\mail\MessageInterface::attachContent()

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

public abstract $this attachContent ( $content, array $options = [] )
$content string

添付ファイルのコンテンツ。
$options array

ファイルを埋め込むためのオプション。有効なオプションは次のとおりです。

  • fileName: ファイルを添付するために使用する必要がある名前。
  • contentType: 添付ファイルの MIME タイプ。
return $this

自己参照。

 

                public function attachContent($content, array $options = []);
canGetProperty() public メソッド

定義元: yii\base\BaseObject::canGetProperty()

プロパティが読み取り可能かどうかを示す値を返します。

プロパティが読み取り可能である条件は次のとおりです。

  • クラスに、指定された名前に関連付けられた getter メソッドがある場合（この場合、プロパティ名は大文字と小文字を区別しません）。
  • クラスに、指定された名前のメンバ変数がある場合（$checkVars が true の場合）。

参照：canSetProperty()。

public boolean canGetProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
return boolean

プロパティが読み取り可能かどうか

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public メソッド

定義元: yii\base\BaseObject::canSetProperty()

プロパティが設定可能かどうかを示す値を返します。

プロパティが書き込み可能である条件は次のとおりです。

  • クラスに、指定された名前に関連付けられた setter メソッドがある場合（この場合、プロパティ名は大文字と小文字を区別しません）。
  • クラスに、指定された名前のメンバ変数がある場合（$checkVars が true の場合）。

参照：canGetProperty()。

public boolean canSetProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
return boolean

プロパティが書き込み可能かどうか

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static メソッド
2.0.14 から非推奨。PHP >= 5.5 では、代わりに ::class を使用してください。

定義元: yii\base\BaseObject::className()

このクラスの完全修飾名を返します。

public static string className ( )
return string

このクラスの完全修飾名。

 

                public static function className()
{
    return get_called_class();
}
embed() public abstract メソッド

定義元: yii\mail\MessageInterface::embed()

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

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

public abstract string embed ( $fileName, array $options = [] )
$fileName string

ファイル名。
$options array

ファイルを埋め込むためのオプション。有効なオプションは次のとおりです。

  • fileName: ファイルを添付するために使用する必要がある名前。
  • contentType: 添付ファイルの MIME タイプ。
return string

添付ファイルの CID。

 

                public function embed($fileName, array $options = []);
embedContent() public abstract メソッド

定義元: yii\mail\MessageInterface::embedContent()

コンテンツをファイルとして添付し、そのCIDソースを返します。

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

public abstract string embedContent ( $content, array $options = [] )
$content string

添付ファイルのコンテンツ。
$options array

ファイルを埋め込むためのオプション。有効なオプションは次のとおりです。

  • fileName: ファイルを添付するために使用する必要がある名前。
  • contentType: 添付ファイルの MIME タイプ。
return string

添付ファイルの CID。

 

                public function embedContent($content, array $options = []);
getBcc() public abstract メソッド

定義元: yii\mail\MessageInterface::getBcc()

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

public abstract string|array getBcc ( )
return string|array

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

 

                public function getBcc();
getCc() public abstract メソッド

定義元: yii\mail\MessageInterface::getCc()

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

public abstract string|array getCc ( )
return string|array

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

 

                public function getCc();
getCharset() public abstract メソッド

定義元: yii\mail\MessageInterface::getCharset()

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

public abstract string getCharset ( )
return string

このメッセージの文字セット。

 

                public function getCharset();
getFrom() public abstract メソッド

定義元: yii\mail\MessageInterface::getFrom()

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

public abstract string|array getFrom ( )
return string|array

送信者

 

                public function getFrom();
getReplyTo() public abstract メソッド

定義元: yii\mail\MessageInterface::getReplyTo()

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

public abstract string|array getReplyTo ( )
return string|array

このメッセージの返信先アドレス。

 

                public function getReplyTo();
getSubject() public abstract メソッド

定義元: yii\mail\MessageInterface::getSubject()

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

public abstract string getSubject ( )
return string

メッセージの件名

 

                public function getSubject();
getTo() public abstract メソッド

定義元: yii\mail\MessageInterface::getTo()

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

public abstract string|array getTo ( )
return string|array

メッセージの受信者

 

                public function getTo();
hasMethod() public メソッド

定義元: yii\base\BaseObject::hasMethod()

メソッドが定義されているかどうかを示す値を返します。

デフォルトの実装は、PHP関数のmethod_exists()の呼び出しです。PHPのマジックメソッド__call()を実装した場合は、このメソッドをオーバーライドできます。

public boolean hasMethod ( $name )
$name string

メソッド名
return boolean

メソッドが定義されているかどうか

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public メソッド

定義元: yii\base\BaseObject::hasProperty()

プロパティが定義されているかどうかを示す値を返します。

プロパティは、以下の場合に定義されているとみなされます。

  • クラスが指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合（この場合、プロパティ名は大文字小文字を区別しません）。
  • クラスに、指定された名前のメンバ変数がある場合（$checkVars が true の場合）。

参考

public boolean hasProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
return boolean

プロパティが定義されているかどうか

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public メソッド

定義元: yii\base\BaseObject::init()

オブジェクトを初期化します。

このメソッドは、オブジェクトが与えられた設定で初期化された後、コンストラクタの最後に呼び出されます。

public void init ( )

                public function init()
{
}
send() public メソッド

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

public boolean send ( yii\mail\MailerInterface $mailer = null )
$mailer yii\mail\MailerInterface|null

このメッセージの送信に使用されるメーラー。メーラーが指定されていない場合は、最初に$mailerが設定されているかどうかを確認し、設定されていない場合は、代わりに「mailer」アプリケーションコンポーネントが使用されます。
return boolean

このメッセージが正常に送信されたかどうか。

 

                public function send(MailerInterface $mailer = null)
{
    if ($mailer === null && $this->mailer === null) {
        $mailer = Yii::$app->getMailer();
    } elseif ($mailer === null) {
        $mailer = $this->mailer;
    }
    return $mailer->send($this);
}
setBcc() public abstract メソッド

定義元: yii\mail\MessageInterface::setBcc()

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

public abstract $this setBcc ( $bcc )
$bcc string|array

隠しコピーの受信者メールアドレス。複数の受信者がこのメッセージを受信する必要がある場合は、アドレスの配列を渡すことができます。また、[email => name]の形式を使用して、メールアドレスに加えて受信者名を指定することもできます。
return $this

自己参照。

 

                public function setBcc($bcc);
setCc() public abstract メソッド

定義元: yii\mail\MessageInterface::setCc()

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

public abstract $this setCc ( $cc )
$cc string|array

コピー受信者のメールアドレス。複数の受信者がこのメッセージを受信する必要がある場合は、アドレスの配列を渡すことができます。また、[email => name]の形式を使用して、メールアドレスに加えて受信者名を指定することもできます。
return $this

自己参照。

 

                public function setCc($cc);
setCharset() public abstract メソッド

定義元: yii\mail\MessageInterface::setCharset()

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

public abstract $this setCharset ( $charset )
$charset string

文字セット名。
return $this

自己参照。

 

                public function setCharset($charset);
setFrom() public abstract メソッド

定義元: yii\mail\MessageInterface::setFrom()

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

public abstract $this setFrom ( $from )
$from string|array

送信者のメールアドレス。このメッセージが複数の人からのものである場合は、アドレスの配列を渡すことができます。また、[email => name]の形式を使用して、メールアドレスに加えて送信者名を指定することもできます。
return $this

自己参照。

 

                public function setFrom($from);
setHtmlBody() public abstract メソッド

定義元: yii\mail\MessageInterface::setHtmlBody()

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

public abstract $this setHtmlBody ( $html )
$html string

メッセージのHTMLコンテンツ。
return $this

自己参照。

 

                public function setHtmlBody($html);
setReplyTo() public abstract メソッド

定義元: yii\mail\MessageInterface::setReplyTo()

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

public abstract $this setReplyTo ( $replyTo )
$replyTo string|array

返信先アドレス。このメッセージが複数の人に返信される必要がある場合は、アドレスの配列を渡すことができます。また、[email => name]の形式を使用して、メールアドレスに加えて返信先名を指定することもできます。
return $this

自己参照。

 

                public function setReplyTo($replyTo);
setSubject() public abstract メソッド

定義元: yii\mail\MessageInterface::setSubject()

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

public abstract $this setSubject ( $subject )
$subject string

メッセージの件名
return $this

自己参照。

 

                public function setSubject($subject);
setTextBody() public abstract メソッド

定義元: yii\mail\MessageInterface::setTextBody()

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

public abstract $this setTextBody ( $text )
$text string

メッセージのプレーンテキストコンテンツ。
return $this

自己参照。

 

                public function setTextBody($text);
setTo() public abstract メソッド

定義元: yii\mail\MessageInterface::setTo()

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

public abstract $this setTo ( $to )
$to string|array

受信者のメールアドレス。複数の受信者がこのメッセージを受信する必要がある場合は、アドレスの配列を渡すことができます。また、[email => name]の形式を使用して、メールアドレスに加えて受信者名を指定することもできます。
return $this

自己参照。

 

                public function setTo($to);
toString() public abstract メソッド

定義場所: yii\mail\MessageInterface::toString()

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

public abstract string toString ( )
return string

このメッセージの文字列表現。

 

                public function toString();