Yii 2.0 API 文档

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('[email protected]')
    ->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 method

返回此消息的 Cc（其他副本接收者）地址。

public abstract string\|array getCc ( )
返回值	string\|array	此消息的 Cc（其他副本接收者）地址。

源代码

                public function getCc();

getCharset() 公共抽象方法

返回此消息的字符集。

public abstract string getCharset ( )
返回值	string	此邮件的字符集。

源代码

                public function getCharset();

getFrom() 公共抽象方法

返回邮件发件人。

public abstract string\|array getFrom ( )
返回值	string\|array	发件人

源代码

                public function getFrom();

getReplyTo() 公共抽象方法

返回此消息的回复地址。

public abstract string\|array getReplyTo ( )
返回值	string\|array	此邮件的回复地址。

源代码

                public function getReplyTo();

getSubject() 公共抽象方法

返回邮件主题。

public abstract string getSubject ( )
返回值	string	邮件主题

源代码

                public function getSubject();

getTo() 公共抽象方法

返回邮件收件人。

public abstract string\|array getTo ( )
返回值	string\|array	邮件收件人

源代码

                public function getTo();

send() 公共抽象方法

发送此电子邮件消息。

public abstract boolean send ( yii\mail\MailerInterface $mailer = null )
$mailer	yii\mail\MailerInterface\|null	用于发送此邮件的邮件发送器。如果为 null，则使用“mailer”应用程序组件。
返回值	boolean	此邮件是否成功发送。

源代码

                public function send(MailerInterface $mailer = null);

setBcc() 公共抽象方法

设置此消息的 Bcc（隐藏副本接收者）地址。

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

源代码

                public function setBcc($bcc);

setCc() 公共抽象方法

设置此消息的 Cc（其他副本接收者）地址。

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

源代码

                public function setCc($cc);

setCharset() 公共抽象方法

设置此消息的字符集。

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

源代码

                public function setCharset($charset);

setFrom() 公共抽象方法

设置邮件发件人。

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

源代码

                public function setFrom($from);

setHtmlBody() 公共抽象方法

设置邮件 HTML 内容。

public abstract $this setHtmlBody ( $html )
$html	string	邮件 HTML 内容。
返回值	$this	自身引用。

源代码

                public function setHtmlBody($html);

setReplyTo() 公共抽象方法

设置此消息的回复地址。

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

源代码

                public function setReplyTo($replyTo);

setSubject() 公共抽象方法

设置邮件主题。

public abstract $this setSubject ( $subject )
$subject	string	邮件主题
返回值	$this	自身引用。

源代码

                public function setSubject($subject);

setTextBody() 公共抽象方法

设置邮件纯文本内容。

public abstract $this setTextBody ( $text )
$text	string	邮件纯文本内容。
返回值	$this	自身引用。

源代码

                public function setTextBody($text);

setTo() 公共抽象方法

设置邮件收件人。

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

源代码

                public function setTo($to);

toString() 公共抽象方法

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

public abstract string toString ( )
返回值	string	此邮件的字符串表示形式。

源代码

                public function toString();

用户贡献笔记

发表评论

为了发表评论，请注册或登录。