0 位追蹤者

介面 yii\mail\MessageInterface

所有類別 | 方法
實作於yii\mail\BaseMessage
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/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) 地址。 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 類型。
return $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 類型。
return $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 類型。
return 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 類型。
return string

附件 CID。

 

                public function embedContent($content, array $options = []);
getBcc() public abstract method

傳回此訊息的密件副本 (Bcc) 地址。

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

此訊息的密件副本 (hidden copy receiver) 地址。

 

                public function getBcc();
getCc() public abstract method

傳回此訊息的副本 (Cc) 地址。

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

此訊息的副本 (additional copy receiver) 地址。

 

                public function getCc();
getCharset() public abstract method

傳回此訊息的字元集。

public abstract string getCharset ( )
return string

此訊息的字元集。

 

                public function getCharset();
getFrom() public abstract method

傳回訊息寄件者。

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

寄件者

 

                public function getFrom();
getReplyTo() public abstract method

傳回此訊息的回覆地址。

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

此訊息的回覆地址。

 

                public function getReplyTo();
getSubject() public abstract method

傳回訊息主旨。

public abstract string getSubject ( )
return string

訊息主旨

 

                public function getSubject();
getTo() public abstract method

傳回訊息收件者。

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

訊息收件者

 

                public function getTo();
send() public abstract method

傳送此電子郵件訊息。

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

應該用於發送此訊息的郵件器。如果為 null，則將改為使用 "mailer" 應用程式組件。
return boolean

此訊息是否成功發送。

 

                public function send(MailerInterface $mailer = null);
setBcc() public abstract method

設定此訊息的密件副本 (Bcc) 地址。

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

密件副本收件者電子郵件地址。如果有多位收件者應接收此訊息，您可以傳遞地址陣列。您也可以使用以下格式指定電子郵件地址以外的收件者名稱：[email => name]。
return $this

自身參考。

 

                public function setBcc($bcc);
setCc() public abstract method

設定此訊息的副本 (Cc) 地址。

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

副本收件者電子郵件地址。如果有多位收件者應接收此訊息，您可以傳遞地址陣列。您也可以使用以下格式指定電子郵件地址以外的收件者名稱：[email => name]。
return $this

自身參考。

 

                public function setCc($cc);
setCharset() public abstract method

設定此訊息的字元集。

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

字元集名稱。
return $this

自身參考。

 

                public function setCharset($charset);
setFrom() public abstract method

設定訊息寄件者。

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

寄件者電子郵件地址。如果此訊息來自多人，您可以傳遞地址陣列。您也可以使用以下格式指定電子郵件地址以外的寄件者名稱：[email => name]。
return $this

自身參考。

 

                public function setFrom($from);
setHtmlBody() public abstract method

設定訊息 HTML 內容。

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

訊息 HTML 內容。
return $this

自身參考。

 

                public function setHtmlBody($html);
setReplyTo() public abstract method

設定此訊息的回覆地址。

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

回覆地址。如果此訊息應回覆給多人，您可以傳遞地址陣列。您也可以使用以下格式指定電子郵件地址以外的回覆名稱：[email => name]。
return $this

自身參考。

 

                public function setReplyTo($replyTo);
setSubject() public abstract method

設定訊息主旨。

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

訊息主旨
return $this

自身參考。

 

                public function setSubject($subject);
setTextBody() public abstract method

設定訊息純文字內容。

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

訊息純文字內容。
return $this

自身參考。

 

                public function setTextBody($text);
setTo() public abstract method

設定訊息收件者。

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

收件者電子郵件地址。如果有多位收件者應接收此訊息，您可以傳遞地址陣列。您也可以使用以下格式指定電子郵件地址以外的收件者名稱：[email => name]。
return $this

自身參考。

 

                public function setTo($to);
toString() public abstract method

傳回此訊息的字串表示形式。

public abstract string toString ( )
return string

此訊息的字串表示形式。

 

                public function toString();