Abstract Class yii\mail\BaseMessage

所有类 | 属性 | 方法

继承	yii\mail\BaseMessage » yii\base\BaseObject
实现	yii\base\Configurable, yii\mail\MessageInterface
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/mail/BaseMessage.php

BaseMessage 用于实现 yii\mail\MessageInterface 所需的 send() 方法的基类。

默认情况下，send() 将使用 "mail" 应用程序组件发送消息。 "mail" 应用程序组件应该是实现 yii\mail\MailerInterface 的邮件程序实例。

参见 yii\mail\BaseMailer.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$bcc	string\|array	邮件的 Bcc（hidden copy receiver）地址。	yii\mail\MessageInterface
$cc	string\|array	邮件的 Cc（additional copy receiver）地址。	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()	Calls the named method which is not a class method.	yii\base\BaseObject
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__toString()	PHP 魔法方法，返回这个对象的字符串表现形式。	yii\mail\BaseMessage
__unset()	Sets an object property to null.	yii\base\BaseObject
attach()	将现有文件附加到邮件中。	yii\mail\MessageInterface
attachContent()	将指定的内容附加为邮件的文件。	yii\mail\MessageInterface
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
embed()	附加文件并返回它的 CID 源。在邮件中嵌入图像或其他数据时，应使用此方法。	yii\mail\MessageInterface
embedContent()	将内容作为文件附加并返回其 CID 源。在邮件中嵌入图像或其他数据时，应使用此方法。	yii\mail\MessageInterface
getBcc()	返回邮件的 Bcc（hidden copy receiver）的地址。	yii\mail\MessageInterface
getCc()	返回邮件的 Cc（additional copy receiver）的地址。	yii\mail\MessageInterface
getCharset()	返回邮件的字符集。	yii\mail\MessageInterface
getFrom()	返回邮件发件人。	yii\mail\MessageInterface
getReplyTo()	返回此邮件的回复地址。	yii\mail\MessageInterface
getSubject()	返回邮件主题。	yii\mail\MessageInterface
getTo()	返回邮件收件人。	yii\mail\MessageInterface
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the object.	yii\base\BaseObject
send()	发送电子邮件。	yii\mail\BaseMessage
setBcc()	设置邮件的 Bcc（hidden copy receiver）地址。	yii\mail\MessageInterface
setCc()	设置邮件的 Cc（additional copy receiver。	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()	Returns string 邮件的表现。	yii\mail\MessageInterface

属性详情

$mailer 公共属性

创建此消息的邮件程序实例。对于独立创建的消息，应该为 null。

public yii\mail\MailerInterface $mailer = null

方法详情

__toString() 公共方法

PHP 魔法方法，返回这个对象的字符串表现形式。

public string __toString()
return	string	对象的字符串表现形式。

send() 公共方法

发送电子邮件。

public boolean send(yii\mail\MailerInterface $mailer = null)
$mailer	yii\mail\MailerInterface	应该用于发送消息的邮件程序。如果没有给出邮件程序，首先应该检查是否设置了 $mailer，如果没有，应该使用 "mail" 应用程序组件。
return	boolean	Whether this message is sent successfully.