没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Interface yii\mail\MessageInterface

实现yii\mail\BaseMessage
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/framework/mail/MessageInterface.php

MessageInterface 是应由邮件消息类实现的接口。

消息表示电子邮件的设置和内容,例如发件人,收件人,主题, 正文,等等。

邮件由 mailer 来发送,如下,

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(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
send() 发送此电子邮件。 yii\mail\MessageInterface
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

方法详情

attach() 公共 抽象 方法

将现有文件附加到邮件中。

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

文件名全称

$options array

嵌入文件的选项。有效选项包括:

  • fileName:应该用于附加文件的名称。
  • contentType:附加文件的 MIME 类型。
return $this

Self reference.

attachContent() 公共 抽象 方法

将指定的内容附加为邮件的文件。

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

附加文件内容。

$options array

嵌入文件的选项。有效选项包括:

  • fileName:用于附件文件的名称。
  • contentType:附加文件的 MIME 类型。
return $this

Self reference.

embed() 公共 抽象 方法

附加文件并返回它的 CID 源。 在邮件中嵌入图像或其他数据时,应使用此方法。

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

文件名。

$options array

嵌入文件的选项。有效选项包括:

  • fileName:用于附件文件的名称。
  • contentType:附加文件的 MIME 类型。
return string

附件的 CID。

embedContent() 公共 抽象 方法

将内容作为文件附加并返回其 CID 源。 在邮件中嵌入图像或其他数据时,应使用此方法。

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

附件文件内容。

$options array

嵌入文件的选项。有效选项包括:

  • fileName:用于附件文件的名称。
  • contentType:附加文件的 MIME 类型。
return string

Attachment CID.

getBcc() 公共 抽象 方法

返回邮件的 Bcc(hidden copy receiver)的地址。

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

邮件的 Bcc(hidden copy receiver)地址。

getCc() 公共 抽象 方法

返回邮件的 Cc(additional copy receiver)的地址。

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

邮件的 Cc(additional copy receiver)地址。

getCharset() 公共 抽象 方法

返回邮件的字符集。

public abstract string getCharset()
return string

此邮件的字符集。

getFrom() 公共 抽象 方法

返回邮件发件人。

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

发件人

getReplyTo() 公共 抽象 方法

返回此邮件的回复地址。

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

此邮件的回复地址。

getSubject() 公共 抽象 方法

返回邮件主题。

public abstract string getSubject()
return string

邮件主题

getTo() 公共 抽象 方法

返回邮件收件人。

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

邮件收件人

send() 公共 抽象 方法

发送此电子邮件。

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

应该用于发送此消息的邮件程序。 如果为 null,将使用 "mail" 应用程序组件。

return boolean

此邮件是否已成功发送。

setBcc() 公共 抽象 方法

设置邮件的 Bcc(hidden copy receiver)地址。

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

隐藏的副本收件人邮箱地址。 如果多个收件人应该收到此邮件,你可以传递地址的数组。 你还可以使用以下格式指定除电子邮件地址之外的收件人姓名: [email => name].

return $this

Self reference.

setCc() 公共 抽象 方法

设置邮件的 Cc(additional copy receiver。

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

复制接收者电子邮件地址。 如果多个收件人应该接收到此邮件,则可以传递地址数组。 还可以使用格式指定电子邮件地址的接收者名称: [email => name].

return $this

Self reference.

setCharset() 公共 抽象 方法

设置此邮件的字符集。

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

字符集名称。

return $this

Self reference.

setFrom() 公共 抽象 方法

设置邮件发送人。

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

发件人邮箱地址。 如果邮件来自多个人,你可以传递地址的数组。 你还可以使用以下格式指定电子邮件地址以外的发件人姓名: [email => name].

return $this

Self reference.

setHtmlBody() 公共 抽象 方法

设置邮件的 HTML 内容。

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

邮件 HTML 内容。

return $this

Self reference.

setReplyTo() 公共 抽象 方法

设置邮件的回复地址。

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

回复地址。 如果此邮件应该回复给多个人,你可以传递地址的数组。 你还可以使用以下格式指定电子邮件地址以外的回复姓名: [email => name].

return $this

Self reference.

setSubject() 公共 抽象 方法

设置邮件主题。

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

邮件主题

return $this

Self reference.

setTextBody() 公共 抽象 方法

设置邮件纯文本内容。

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

邮件纯文本内容。

return $this

Self reference.

setTo() 公共 抽象 方法

设置邮件接收人。

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

收件人邮箱地址。 如果多个收件人应该收到此邮件,你可以传递地址的数组。 你还可以使用以下格式指定除电子邮件地址之外的收件人姓名: [email => name].

return $this

Self reference.

toString() 公共 抽象 方法

Returns string 邮件的表现。

public abstract string toString()
return string

此邮件的字符串表现形式。