A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://www.yiiframework.com/doc/api/2.0/yii-mail-messageinterface below:

MessageInterface, yii\mail\MessageInterface | API Documentation for Yii 2.0

Interface yii\mail\MessageInterface

MessageInterface is the interface that should be implemented by mail message classes.

A message represents the settings and content of an email, such as the sender, recipient, subject, body, etc.

Messages are sent by a mailer, like the following,

Yii::$app->mailer->compose()
    ->setFrom('from@domain.com')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->setTextBody('Plain text content')
    ->setHtmlBody('<b>HTML content</b>')
    ->send();

See also yii\mail\MailerInterface.

Method Details

Hide inherited methods

Attaches existing file to the email message.

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

Full file name

$options array

Options for embed file. Valid options are:

return $this

Self reference.

Source code 

                public function attach($fileName, array $options = []);

Attach specified content as file for the email message.

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

Attachment file content.

$options array

Options for embed file. Valid options are:

return $this

Self reference.

Source code 

                public function attachContent($content, array $options = []);

Attach a file and return it's CID source.

This method should be used when embedding images or other data in a message.

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

File name.

$options array

Options for embed file. Valid options are:

return string

Attachment CID.

Source code 

                public function embed($fileName, array $options = []);

Attach a content as file and return it's CID source.

This method should be used when embedding images or other data in a message.

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

Attachment file content.

$options array

Options for embed file. Valid options are:

return string

Attachment CID.

Source code 

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

Returns the Bcc (hidden copy receiver) addresses of this message.

Source code 

                public function getBcc();

Returns the Cc (additional copy receiver) addresses of this message.

Source code

Returns the character set of this message.

Source code 

                public function getCharset();

Returns the message sender.

Source code 

                public function getFrom();

Returns the reply-to address of this message.

Source code 

                public function getReplyTo();

Returns the message subject.

Source code 

                public function getSubject();

Sends this email message.

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

The mailer that should be used to send this message. If null, the "mailer" application component will be used instead.

return boolean

Whether this message is sent successfully.

Source code 

                public function send(?MailerInterface $mailer = null);

Sets the Bcc (hidden copy receiver) addresses of this message.

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

Hidden copy receiver email address. You may pass an array of addresses if multiple recipients should receive this message. You may also specify receiver name in addition to email address using format: [email => name].

return $this

Self reference.

Source code 

                public function setBcc($bcc);

Sets the Cc (additional copy receiver) addresses of this message.

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

Copy receiver email address. You may pass an array of addresses if multiple recipients should receive this message. You may also specify receiver name in addition to email address using format: [email => name].

return $this

Self reference.

Source code 

                public function setCc($cc);

Sets the character set of this message.

Source code 

                public function setCharset($charset);

Sets the message sender.

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

Sender email address. You may pass an array of addresses if this message is from multiple people. You may also specify sender name in addition to email address using format: [email => name].

return $this

Self reference.

Source code 

                public function setFrom($from);

Sets message HTML content.

Source code 

                public function setHtmlBody($html);

Sets the reply-to address of this message.

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

The reply-to address. You may pass an array of addresses if this message should be replied to multiple people. You may also specify reply-to name in addition to email address using format: [email => name].

return $this

Self reference.

Source code 

                public function setReplyTo($replyTo);

Sets the message subject.

Source code 

                public function setSubject($subject);

Sets message plain text content.

Source code 

                public function setTextBody($text);

Sets the message recipient(s).

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

Receiver email address. You may pass an array of addresses if multiple recipients should receive this message. You may also specify receiver name in addition to email address using format: [email => name].

return $this

Self reference.

Source code 

                public function setTo($to);

Returns string representation of this message.

Source code 

                public function toString();

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4