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 是一个基类，它实现了 send() 方法，该方法是 yii\mail\MessageInterface 所需的方法。

默认情况下，send() 方法将使用 "mailer" 应用程序组件发送当前消息。 "mailer" 应用程序组件应该是一个实现了 yii\mail\MailerInterface 接口的邮件发送器实例。

另请参见 yii\mail\BaseMailer。

公共属性

隐藏继承的属性

属性	类型	描述	定义于
$bcc	string\|array	此消息的密件抄送 (隐藏副本接收方) 地址。	yii\mail\MessageInterface
$cc	string\|array	此消息的抄送 (附加副本接收方) 地址。	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()	返回此消息的密件抄送 (隐藏副本接收方) 地址。	yii\mail\MessageInterface
getCc()	返回此消息的抄送 (附加副本接收方) 地址。	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()	设置此消息的密件抄送 (隐藏副本接收方) 地址。	yii\mail\MessageInterface
setCc()	设置此消息的抄送 (附加副本接收方) 地址。	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 公共属性

创建此消息的邮件发送器实例。对于独立创建的消息，此属性为 null。

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

方法详细信息

隐藏继承的方法

__call() 公共方法

定义于： 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() 公共方法

定义于： yii\base\BaseObject::__construct()

构造函数。

默认实现执行以下两项操作

使用给定的配置 $config 初始化对象。
调用 init() 方法。

如果在子类中重写此方法，建议

构造函数的最后一个参数是一个配置数组，这里类似于$config。
在构造函数的末尾调用父类的实现。

public void __construct ( $config = [] )
$config	array	用于初始化对象属性的名称-值对

源代码

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

__get() public method

Defined in: yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法，因为它是 PHP 的魔法方法，会在执行 $value = $object->property; 时隐式调用。

另见 __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 method

Defined in: yii\base\BaseObject::__isset()

检查属性是否已设置，即定义且不为 null。

不要直接调用此方法，因为它是 PHP 的魔法方法，会在执行 isset($object->property) 时隐式调用。

注意，如果属性未定义，则将返回 false。

另见 https://php.ac.cn/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 method

Defined in: yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是 PHP 的魔法方法，会在执行 $object->property = $value; 时隐式调用。

另见 __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 method

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 method

Defined in: yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是 PHP 的魔法方法，会在执行 unset($object->property) 时隐式调用。

注意，如果属性未定义，此方法将不做任何操作。如果属性是只读，它将抛出异常。

另见 https://php.ac.cn/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 method

Defined in: 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 method

Defined in: 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 method

Defined in: 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 method

Defined in: 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 method

自 2.0.14 版本起已弃用。在 PHP >=5.5 上，使用 ::class 代替。

Defined in: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
return	string	此类的完全限定名称。

源代码

                public static function className()
{
    return get_called_class();
}

embed() public abstract method

定义于： 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 method

定义于： 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 method

定义于： yii\mail\MessageInterface::getBcc()

返回此消息的密件抄送 (隐藏副本接收方) 地址。

public abstract string\|array getBcc ( )
return	string\|array	此消息的密件抄送 (隐藏副本接收方) 地址。

源代码

                public function getBcc();

getCc() public abstract method

定义于： yii\mail\MessageInterface::getCc()

返回此消息的抄送 (附加副本接收方) 地址。

public abstract string\|array getCc ( )
return	string\|array	此消息的抄送 (附加副本接收方) 地址。

源代码

                public function getCc();

getCharset() public abstract method

定义于： yii\mail\MessageInterface::getCharset()

返回此消息的字符集。

public abstract string getCharset ( )
return	string	此消息的字符集。

源代码

                public function getCharset();

getFrom() public abstract method

定义于： yii\mail\MessageInterface::getFrom()

返回消息发件人。

public abstract string\|array getFrom ( )
return	string\|array	发件人

源代码

                public function getFrom();

getReplyTo() public abstract method

定义于： yii\mail\MessageInterface::getReplyTo()

返回此消息的回复地址。

public abstract string\|array getReplyTo ( )
return	string\|array	此消息的回复地址。

源代码

                public function getReplyTo();

getSubject() public abstract method

定义于： yii\mail\MessageInterface::getSubject()

返回消息主题。

public abstract string getSubject ( )
return	string	消息主题

源代码

                public function getSubject();

getTo() public abstract method

定义于： yii\mail\MessageInterface::getTo()

返回消息接收方。

public abstract string\|array getTo ( )
return	string\|array	消息接收方

源代码

                public function getTo();

hasMethod() public method

定义于： 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 method

定义于： yii\base\BaseObject::hasProperty()

返回一个值，指示属性是否已定义。

如果属性已定义，则

该类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
该类具有与指定名称相同的成员变量（当 $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 method

定义于： yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化后调用。

public void init ( )

源代码

                public function init()
{
}

send() public method

发送此电子邮件消息。

public boolean send ( yii\mail\MailerInterface $mailer = null )
$mailer	yii\mail\MailerInterface\|null	应该用于发送此邮件的邮件程序。如果未给出邮件程序，它将首先检查 $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 method

定义于： yii\mail\MessageInterface::setBcc()

设置此消息的密件抄送 (隐藏副本接收方) 地址。

public abstract $this setBcc ( $bcc )
$bcc	string\|array	隐藏副本收件人电子邮件地址。如果多个收件人应收到此消息，则可以传递地址数组。您还可以使用以下格式在电子邮件地址之外指定收件人姓名：`[email => name]`。
return	$this	自身引用。

源代码

                public function setBcc($bcc);

setCc() 公共抽象方法

定义于： yii\mail\MessageInterface::setCc()

设置此消息的抄送 (附加副本接收方) 地址。

public abstract $this setCc ( $cc )
$cc	string\|array	抄送收件人电子邮件地址。如果多个收件人应收到此消息，则可以传递地址数组。您还可以使用以下格式在电子邮件地址之外指定收件人姓名：`[email => name]`。
return	$this	自身引用。

源代码

                public function setCc($cc);

setCharset() 公共抽象方法

定义于： yii\mail\MessageInterface::setCharset()

设置此消息的字符集。

public abstract $this setCharset ( $charset )
$charset	string	字符集名称。
return	$this	自身引用。

源代码

                public function setCharset($charset);

setFrom() 公共抽象方法

定义于： yii\mail\MessageInterface::setFrom()

设置消息发件人。

public abstract $this setFrom ( $from )
$from	string\|array	发件人电子邮件地址。如果您想从多人发送此消息，则可以传递地址数组。您还可以使用以下格式在电子邮件地址之外指定发件人姓名：`[email => name]`。
return	$this	自身引用。

源代码

                public function setFrom($from);

setHtmlBody() 公共抽象方法

定义于： yii\mail\MessageInterface::setHtmlBody()

设置消息的 HTML 内容。

public abstract $this setHtmlBody ( $html )
$html	string	消息的 HTML 内容。
return	$this	自身引用。

源代码

                public function setHtmlBody($html);

setReplyTo() 公共抽象方法

定义于： yii\mail\MessageInterface::setReplyTo()

设置此消息的回复地址。

public abstract $this setReplyTo ( $replyTo )
$replyTo	string\|array	回复地址。如果您想将此消息回复给多人，则可以传递地址数组。您还可以使用以下格式在电子邮件地址之外指定回复地址：`[email => name]`。
return	$this	自身引用。

源代码

                public function setReplyTo($replyTo);

setSubject() 公共抽象方法

定义于： yii\mail\MessageInterface::setSubject()

设置消息主题。

public abstract $this setSubject ( $subject )
$subject	string	消息主题
return	$this	自身引用。

源代码

                public function setSubject($subject);

setTextBody() 公共抽象方法

定义于： yii\mail\MessageInterface::setTextBody()

设置消息的纯文本内容。

public abstract $this setTextBody ( $text )
$text	string	消息的纯文本内容。
return	$this	自身引用。

源代码

                public function setTextBody($text);

setTo() 公共抽象方法

定义于： yii\mail\MessageInterface::setTo()

设置消息接收方。

public abstract $this setTo ( $to )
$to	string\|array	收件人电子邮件地址。如果多个收件人应收到此消息，则可以传递地址数组。您还可以使用以下格式在电子邮件地址之外指定收件人姓名：`[email => name]`。
return	$this	自身引用。

源代码

                public function setTo($to);

toString() 公共抽象方法

定义于： yii\mail\MessageInterface::toString()

返回此消息的字符串表示形式。

public abstract string toString ( )
return	string	此消息的字符串表示形式。

源代码

                public function toString();